Skip to content

Commit

Permalink
Add harness api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vblagoje committed Jul 2, 2024
1 parent 215e479 commit c07e6aa
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 2 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/api_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ on:
- main
# release branches have the form v1.9.x
- "v[0-9]+.[0-9]+.x"
# Exclude 1.x release branches, there's another workflow handling those
- "!v1.[0-9]+.x"

env:
HATCH_VERSION: "1.9.3"
Expand Down
32 changes: 32 additions & 0 deletions docs/pydoc/config/harness.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
loaders:
- type: haystack_pydoc_tools.loaders.CustomPythonLoader
search_path: [../../../haystack_experimental/evaluation]
modules: ["harness/evaluation_harness",
"harness/rag/harness",
"harness/rag/evaluation_pipeline",
"harness/rag/parameters",
"util/pipeline_pair",
"util/helpers"]
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: Evaluation harness for Haystack.
category_slug: experiments-api
title: Evaluation Harness
slug: evaluation-harness
order: 50
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_harness.md

0 comments on commit c07e6aa

Please sign in to comment.