Skip to content

Conversation

@jerrygeorge360
Copy link
Contributor

Summary

This pull request improves code documentation and clarity for the base classes used in benchmarking and evaluation metrics. The main changes are the addition of detailed docstrings to abstract base classes and their methods, which will help future developers understand the purpose and usage of these interfaces.

Documentation improvements:

  • Added comprehensive docstrings to the BaseBenchmark class and its methods in benchmark.py, explaining their roles, expected arguments, return values, and error handling.
  • Added detailed docstrings to the BaseEvaluationMetric class and its methods in metric.py, clarifying how evaluation metrics should be implemented and used.
  • Bug fix
  • New feature
  • Documentation update
  • Code quality / linting
  • Other (please describe):

Testing

Describe how you tested your changes. Include the steps to reproduce, commands run, and any relevant outputs.

  • Unit tests added or updated
  • All tests pass locally (make test)
  • Code coverage maintained or improved

Checklist

Before submitting your PR, please check off the following:

  • My code follows the existing style and conventions
  • I’ve run linting (make lint)
  • I’ve added/updated relevant documentation
  • I’ve added/updated tests as needed
  • I’ve verified integration with existing tools (HuggingFace, LlamaIndex, LangChain, etc. if applicable)
  • I’ve added an entry to the CHANGELOG.md (if applicable)

Related Issues or PRs

If this PR addresses or relates to existing issues or pull requests, link them here:

@codecov
Copy link

codecov bot commented Sep 5, 2025

Codecov Report

❌ Patch coverage is 20.00000% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 98.42%. Comparing base (cd574fa) to head (f899356).
⚠️ Report is 12 commits behind head on main.

Files with missing lines Patch % Lines
src/fed_rag/base/evals/benchmark.py 25.00% 3 Missing ⚠️
src/fed_rag/base/evals/metric.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #504      +/-   ##
==========================================
- Coverage   98.52%   98.42%   -0.10%     
==========================================
  Files         156      156              
  Lines        4132     4136       +4     
==========================================
  Hits         4071     4071              
- Misses         61       65       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

[chore] Google docstrings fed_rag.base.evals

1 participant