Skip to content

Commit

Permalink
docs: add evaluators component reference (#7532)
Browse files Browse the repository at this point in the history
  • Loading branch information
dfokina authored Apr 12, 2024
1 parent 5fce2e9 commit a5f6571
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/pydoc/config/evaluators_api.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
loaders:
- type: haystack_pydoc_tools.loaders.CustomPythonLoader
search_path: [../../../haystack/components/evaluators]
modules:
[
"answer_exact_match",
"document_map",
"document_mrr",
"document_recall",
"evaluation_result",
"document_recall",
"faithfulness",
"llm_evaluator",
"sas_evaluator",
]
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: Evaluate your pipelines or individual components.
category_slug: haystack-api
title: Evaluators
slug: evaluators-api
order: 5
markdown:
descriptive_class_title: false
classdef_code_block: false
descriptive_module_title: true
add_method_class_prefix: true
add_member_class_prefix: false
filename: evaluators_api.md

0 comments on commit a5f6571

Please sign in to comment.