From cb42ac19aef18bbbdcbe62e00c2f470cd880e4eb Mon Sep 17 00:00:00 2001 From: Silvano Cerza <3314350+silvanocerza@users.noreply.github.com> Date: Wed, 14 Feb 2024 16:57:01 +0100 Subject: [PATCH] docs: Add eval Components docs config (#6984) * Add eval components docs config * Update order Co-authored-by: Daria Fokina --------- Co-authored-by: Daria Fokina --- docs/pydoc/config/eval_api.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/pydoc/config/eval_api.yml diff --git a/docs/pydoc/config/eval_api.yml b/docs/pydoc/config/eval_api.yml new file mode 100644 index 000000000..d8ca45b11 --- /dev/null +++ b/docs/pydoc/config/eval_api.yml @@ -0,0 +1,26 @@ +loaders: + - type: haystack_pydoc_tools.loaders.CustomPythonLoader + search_path: [../../../haystack/components/eval] + modules: ["sas_evaluator", "statistical_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.ReadmePreviewRenderer + excerpt: Enables evaluation of LLMs generated answers. + category_slug: haystack-api + title: Evaluation + slug: eval-api + order: 63 + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: eval_api.md