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

Bug in documentation rag_testset_generation.md: API changes required arguments #1714

Merged
merged 1 commit into from
Nov 29, 2024

Conversation

bmerkle
Copy link
Contributor

@bmerkle bmerkle commented Nov 27, 2024

The code in rag_testset_generation.md code not compile and contains 2 syntax errors (API has changed)
I now added missing possitional arguments for embedding_model and documents

added missing possitional arguments for embedding_model and documents
@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Nov 27, 2024
@bmerkle
Copy link
Contributor Author

bmerkle commented Nov 27, 2024

BTW. how about adding a samples directory with ready to run jupyter notebooks ?
I could contribute the two samples from your documentation as notebooks

Copy link
Member

@shahules786 shahules786 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 the PR :)

@shahules786
Copy link
Member

Hey @bmerkle that's a great idea. We used to have our docs in jupyter notebook but moved it to md for proper rendering. We could have a notebook version of the same that can be opened in colab or something. What do you think @jjmachan ?

@shahules786 shahules786 merged commit eb5f745 into explodinggradients:main Nov 29, 2024
5 checks passed
@bmerkle
Copy link
Contributor Author

bmerkle commented Nov 29, 2024

Hey @bmerkle that's a great idea. We used to have our docs in jupyter notebook but moved it to md for proper rendering. We could have a notebook version of the same that can be opened in colab or something. What do you think @jjmachan ?

hey @shahules786 @jjmachan, we could have an example directory with ready to run jupyter notebooks.

In GitHub Workspaces and Google colab they can be directly used and you can play around with it.
The build process could generate md files for the website automatically from the jupyter notebooks, e.g.
jupyter nbconvert --to markdown your_notebook.ipynb
Or we could use something like binder or viola to have it even live in the ragas documentation :-)

I could prepare a PR for this if you like. I think we should create a separate issue for it out of this issue.

@jjmachan
Copy link
Member

jjmachan commented Nov 29, 2024

hey @bmerkle it a good idea, which notebook topics do you have in mind

but if you do check out the current documentation we use something similar https://github.com/explodinggradients/ragas/tree/main/docs/howtos/customizations/testgenerator

this is the script https://github.com/explodinggradients/ragas/blob/main/docs/ipynb_to_md.py

we definitly want to make it easier for people to use notebooks like you suggest and would love your ideas 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants