RAG guide for docs #2525
RAG guide for docs #2525
Conversation
|
Important Auto Review SkippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the To trigger a single review, invoke the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 33.2%, saving 250.69 KB.
241 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 5.1%, saving 59.46 KB.
242 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
There was a problem hiding this comment.
This image is pixelated here: https://zenml-io.gitbook.io/alextestingground/Z1RNwxFe5UgX8V1GrZoR/user-guide/llmops-guide/rag-with-zenml/storing-embeddings-in-a-vector-database
apart from that I love it!
My only criticism is that the front is too 'text-heavy', a lot of words to read before the action shows up. Might make sense to have a small example to run at the very start to make developers excited?
Generally, I would merge and backport this first and then do the improvements
|
@htahir1 Pixellation is on purpose, to remove reference to my supabase org / db name etc. I will merge this in now, backport and then see what I can do about making it less text-heavy. Note there's lots of reference to the project itself, which would probably want to be merged in before I do the full backport merge. There's an open PR here zenml-io/zenml-projects#97 |
|
Oh I guess you maybe mean that the image could be higher quality... I can bump that a bit for sure... |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 23.6%, saving 68.39 KB.
248 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
* inital update for toc * add intro / overview page * update toc and add placeholder pages * rag page draft * undo changes * more undo * even more * revert gitignore * add scarf and fix typo * update docs with nested llmops guide sections * split RAG guide into sections * add titles * update docs further * write first few sections * data ingestion docs * add data ingestion section * remove extra requirements file * add embeddings generation docs * fix image URL * fix image * tweak for embeddings generation docs * update toc * no need for double header * fix image url * actually fix image url * add zenml artifact load to the doc * update embeddings section * update embeddings storage section * complete embeddings storage section * finish RAG pipeline walkthrough draft * Optimised images with calibre/image-actions * make link html * add link and fix missing text * add initial set of draft images * Optimised images with calibre/image-actions * fix link * make it less wordy * remove unused parts of the guide * update TOC * add step operator docs link * fix inference image link * add specific code references * Update code examples with links to specific files * remove infelicity * update images * remove one illustration * Optimised images with calibre/image-actions * use higher quality image * Optimised images with calibre/image-actions --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> (cherry picked from commit 39ef6dc)
* inital update for toc * add intro / overview page * update toc and add placeholder pages * rag page draft * undo changes * more undo * even more * revert gitignore * add scarf and fix typo * update docs with nested llmops guide sections * split RAG guide into sections * add titles * update docs further * write first few sections * data ingestion docs * add data ingestion section * remove extra requirements file * add embeddings generation docs * fix image URL * fix image * tweak for embeddings generation docs * update toc * no need for double header * fix image url * actually fix image url * add zenml artifact load to the doc * update embeddings section * update embeddings storage section * complete embeddings storage section * finish RAG pipeline walkthrough draft * Optimised images with calibre/image-actions * make link html * add link and fix missing text * add initial set of draft images * Optimised images with calibre/image-actions * fix link * make it less wordy * remove unused parts of the guide * update TOC * add step operator docs link * fix inference image link * add specific code references * Update code examples with links to specific files * remove infelicity * update images * remove one illustration * Optimised images with calibre/image-actions * use higher quality image * Optimised images with calibre/image-actions --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> (cherry picked from commit 39ef6dc)
Describe changes
I implemented/fixed _ to achieve _.
Pre-requisites
Please ensure you have done the following:
developand the open PR is targetingdevelop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.Types of changes