Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add notebook demonstrating RAG with LlamaIndex #52

Merged
merged 6 commits into from
Mar 5, 2024

Conversation

jinnovation
Copy link
Contributor

What does this PR do?

This notebook is a "spin-off" of sorts from
@MKhalusova's notebook on RAG with LangChain and
Zephyr. Here, we demonstrate the use of LlamaIndex as a counterpart to LangChain, demonstrating its
flexibility for RAG-specific use cases.

Who can review?

@MKhalusova

This notebook is a "spin-off" of sorts from
@MKhalusova's notebook on RAG with LangChain and
Zephyr. Here, we demonstrate the use of LlamaIndex
as a counterpart to LangChain, demonstrating its
flexibility for RAG-specific use cases.
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@MKhalusova MKhalusova self-requested a review March 4, 2024 17:43
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@jinnovation
Copy link
Contributor Author

Thanks in advance for the review @MKhalusova 😇

Copy link
Contributor

@MKhalusova MKhalusova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really nice notebook! Since you mention that the documents have not been chunked during loading, perhaps, it's worth mentioning when the chunking happens.

As I understand, the documents are chunked when ingested into the VectorStoreIndex (feel free to correct if that's wrong).
Maybe also worth mentioning the defaults for the chunk size and overlap.

@jinnovation
Copy link
Contributor Author

Really nice notebook! Since you mention that the documents have not been chunked during loading, perhaps, it's worth mentioning when the chunking happens.

Good catch. Added a note to that effect.

As I understand, the documents are chunked when ingested into the VectorStoreIndex (feel free to correct if that's wrong). Maybe also worth mentioning the defaults for the chunk size and overlap.

Done.

Copy link
Contributor

@MKhalusova MKhalusova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The notebook looks good, but I see that you added the *.epub files. There's no need to keep them in the repo as you give the readers instructions on how to get them. Let's remove these files.

@jinnovation
Copy link
Contributor Author

jinnovation commented Mar 4, 2024 via email

Copy link
Contributor

@MKhalusova MKhalusova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the notebook and iterating over the feedback! It's ready to merge now.

@MKhalusova MKhalusova merged commit da746c4 into huggingface:main Mar 5, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants