-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
docs: add docstrings for EvaluationRunResult #7885
Conversation
Pull Request Test Coverage Report for Build 9563422604Details
💛 - Coveralls |
@@ -3,7 +3,8 @@ loaders: | |||
search_path: [../../../haystack/evaluation] | |||
modules: | |||
[ | |||
"eval_run_result" | |||
"base", |
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.
nice 👍🏽
in my opinion, this is the approach to organizing abstractions - we could think about using it on every bit of code that has abstractions
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.
Slightly unrelated, but we should refrain from introducing abstractions, like in this case. I would have just gone with EvaluationRunResult
and added an abstraction later if and when needed, possibly with a protocol, not an abstract class. In that case, we wouldn't have had this PR :)
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.
I agree that the abstractions here was too much and we can always add them later if needed.
@masci : thanks for removing the |
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.
LGTM - thanks @masci
Related Issues
EvaluationRunResult.score_result()
is not documented in API reference #7829Proposed Changes:
EvaluationRunResult
How did you test it?
Notes for the reviewer
Checklist
fix:
,feat:
,build:
,chore:
,ci:
,docs:
,style:
,refactor:
,perf:
,test:
.