Fix end-of-file issues #504
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
BaseBenchmarkclass and its methods inbenchmark.py, explaining their roles, expected arguments, return values, and error handling.BaseEvaluationMetricclass and its methods inmetric.py, clarifying how evaluation metrics should be implemented and used.Testing
Describe how you tested your changes. Include the steps to reproduce, commands run, and any relevant outputs.
make test)Checklist
Before submitting your PR, please check off the following:
make lint)Related Issues or PRs
If this PR addresses or relates to existing issues or pull requests, link them here:
fed_rag.base.evals#458