mirror of
https://github.com/deepset-ai/haystack.git
synced 2025-11-01 18:29:32 +00:00
docs: add evaluators component reference (#7532)
This commit is contained in:
parent
5fce2e90cd
commit
a5f6571cfb
38
docs/pydoc/config/evaluators_api.yml
Normal file
38
docs/pydoc/config/evaluators_api.yml
Normal file
@ -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
|
||||
Loading…
x
Reference in New Issue
Block a user