chore: Exculde evaluator private classes in API docs (#392)

deepset-ai · Feb 13, 2024 · 6f70b24 · 6f70b24
1 parent 70ed7e6
commit 6f70b24
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/integrations/deepeval/pydoc/config.yml b/integrations/deepeval/pydoc/config.yml
@@ -13,6 +13,8 @@ processors:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true
+  - type: filter
+    expression: "name not in ['MetricResult', 'MetricDescriptor', 'OutputConverters', 'InputConverters', 'METRIC_DESCRIPTORS']"
   - type: smart
   - type: crossref
 renderer:

diff --git a/integrations/uptrain/pydoc/config.yml b/integrations/uptrain/pydoc/config.yml
@@ -13,6 +13,8 @@ processors:
     documented_only: true
     do_not_filter_modules: false
     skip_empty_modules: true
+  - type: filter
+    expression: "name not in ['MetricResult', 'MetricDescriptor', 'OutputConverters', 'InputConverters', 'METRIC_DESCRIPTORS']"
   - type: smart
   - type: crossref
 renderer: