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

EvaluationRunResult.score_result() is not documented in API reference #7829

Closed
bilgeyucel opened this issue Jun 7, 2024 · 1 comment · Fixed by #7885
Closed

EvaluationRunResult.score_result() is not documented in API reference #7829

bilgeyucel opened this issue Jun 7, 2024 · 1 comment · Fixed by #7885
Assignees
Labels
P1 High priority, add to the next sprint topic:eval type:documentation Improvements on the docs

Comments

@bilgeyucel
Copy link
Contributor

Is your feature request related to a problem? Please describe.
EvaluationRunResult.score_result() is not documented in the API docs https://docs.haystack.deepset.ai/reference/evaluation-api#evaluationrunresult, it's documented under BaseEvaluationRunResult.score_report

Describe the solution you'd like
score_report method should be documented under EvaluationRunResult

Describe alternatives you've considered
N/A

Additional context
It'd be even better to have a documentation page for this feature

@bilgeyucel bilgeyucel added the type:documentation Improvements on the docs label Jun 7, 2024
@shadeMe shadeMe self-assigned this Jun 14, 2024
@shadeMe shadeMe added the P1 High priority, add to the next sprint label Jun 14, 2024
@masci
Copy link
Contributor

masci commented Jun 18, 2024

This is expected behaviour, the derived class doesn't have a docstring and pydoc-markdown doesn't have a mechanism (like for example sphynx does) to infer the docstring from the base class. I'll fix it by adding the appropriate docstrings to the derived class.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 High priority, add to the next sprint topic:eval type:documentation Improvements on the docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants