Skip to content

Commit

Permalink
add pydoc config for evaluation (#7602)
Browse files Browse the repository at this point in the history
  • Loading branch information
anakin87 committed Apr 26, 2024
1 parent 36b9a05 commit 704293d
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 2 deletions.
30 changes: 30 additions & 0 deletions docs/pydoc/config/evaluation_api.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
loaders:
- type: haystack_pydoc_tools.loaders.CustomPythonLoader
search_path: [../../../haystack/evaluation]
modules:
[
"eval_run_result"
]
ignore_when_discovered: ["__init__"]
processors:
- type: filter
expression:
documented_only: true
do_not_filter_modules: false
skip_empty_modules: true
- type: smart
- type: crossref
renderer:
type: haystack_pydoc_tools.renderers.ReadmeCoreRenderer
excerpt: Represents the results of evaluation.
category_slug: haystack-api
title: Evaluation
slug: evaluation-api
order: 61
markdown:
descriptive_class_title: false
classdef_code_block: false
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
filename: evaluation_api.md
3 changes: 1 addition & 2 deletions docs/pydoc/config/evaluators_api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ loaders:
"document_map",
"document_mrr",
"document_recall",
"evaluation_result",
"document_recall",
"faithfulness",
"llm_evaluator",
Expand All @@ -29,7 +28,7 @@ renderer:
category_slug: haystack-api
title: Evaluators
slug: evaluators-api
order: 5
order: 63
markdown:
descriptive_class_title: false
classdef_code_block: false
Expand Down

0 comments on commit 704293d

Please sign in to comment.