-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Feature/examples-as-installable-package #2210
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
Feature/examples-as-installable-package #2210
Conversation
Try rebase and recheck ci once. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good but please fix the CI (unit tests failing)
…g installation and usage instructions for the new ragas_examples package.
…tructions, clarified example structure, and added environment variable setup for API keys.
…odule instead of hardcoding
2c0af61
to
3d163c8
Compare
…on with main ragas
… package, covering installation, publishing, versioning, and usage instructions.
…oning and publishing instructions.
59637ea
to
2a94549
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets do these final updates and we can merge this.
Co-authored-by: Ani <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @sanjeed5 🙌🏼
# Pull Request ## Changes Made <!-- Describe what you changed and why --> - **Restructured examples into installable package**: Converted examples directory to proper Python package `ragas-examples` with `pyproject.toml`, `LICENSE`, and comprehensive `README.md` ## Type of Change <!-- Check the relevant box --> - [ ] 🐛 Bug fix (non-breaking change that fixes an issue) - [ ] ✨ New feature (non-breaking change that adds functionality) - [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] 📚 Documentation update - [x] 🔧 Maintenance (refactoring, dependency updates, etc.) - [ ] 🧪 Test improvements - [ ] 🚀 Performance improvement ## Testing <!-- Describe how this should be tested --> ### How to Test - [x] Manual testing steps: 1. Install packages in editable mode: `uv pip install -e . -e ./examples` 2. Run example modules: `python -m ragas_examples.benchmark_llm.prompt` Note: Docs and examples are not updated yet. If the structure looks fine, I'll update the rest of the docs and examples to match this. --------- Co-authored-by: Kumar Anirudha <[email protected]>
Pull Request
Changes Made
ragas-examples
withpyproject.toml
,LICENSE
, and comprehensiveREADME.md
Type of Change
Testing
How to Test
Install packages in editable mode:
uv pip install -e . -e ./examples
Run example modules:
python -m ragas_examples.benchmark_llm.prompt
Note: Docs and examples are not updated yet.
If the structure looks fine, I'll update the rest of the docs and examples to match this.