summaryrefslogtreecommitdiff
path: root/genderbench/docs/source/api
diff options
context:
space:
mode:
Diffstat (limited to 'genderbench/docs/source/api')
-rw-r--r--genderbench/docs/source/api/genderbench.generators.generator.Generator.rst23
-rw-r--r--genderbench/docs/source/api/genderbench.probing.attempt.Attempt.rst7
-rw-r--r--genderbench/docs/source/api/genderbench.probing.evaluator.Evaluator.rst19
-rw-r--r--genderbench/docs/source/api/genderbench.probing.harness.Harness.rst7
-rw-r--r--genderbench/docs/source/api/genderbench.probing.mark_definition.MarkDefinition.rst9
-rw-r--r--genderbench/docs/source/api/genderbench.probing.metric_calculator.MetricCalculator.rst9
-rw-r--r--genderbench/docs/source/api/genderbench.probing.probe.Probe.rst9
-rw-r--r--genderbench/docs/source/api/genderbench.probing.probe_item.ProbeItem.rst7
-rw-r--r--genderbench/docs/source/api/genderbench.probing.prompt.Prompt.rst7
9 files changed, 97 insertions, 0 deletions
diff --git a/genderbench/docs/source/api/genderbench.generators.generator.Generator.rst b/genderbench/docs/source/api/genderbench.generators.generator.Generator.rst
new file mode 100644
index 0000000..cf9aeba
--- /dev/null
+++ b/genderbench/docs/source/api/genderbench.generators.generator.Generator.rst
@@ -0,0 +1,23 @@
+Generators
+========================================
+
+.. currentmodule:: genderbench.generators.generator
+
+.. autoclass:: Generator
+ :members:
+
+.. currentmodule:: genderbench.generators.async_api
+
+.. autoclass:: AsyncApiGenerator
+
+.. currentmodule:: genderbench.generators.open_ai_async_api
+
+.. autoclass:: OpenAiAsyncApiGenerator
+
+.. currentmodule:: genderbench.generators.anthropic_async_api
+
+.. autoclass:: AnthropicAsyncApiGenerator
+
+.. currentmodule:: genderbench.generators.random
+
+.. autoclass:: RandomGenerator \ No newline at end of file
diff --git a/genderbench/docs/source/api/genderbench.probing.attempt.Attempt.rst b/genderbench/docs/source/api/genderbench.probing.attempt.Attempt.rst
new file mode 100644
index 0000000..55eb0f4
--- /dev/null
+++ b/genderbench/docs/source/api/genderbench.probing.attempt.Attempt.rst
@@ -0,0 +1,7 @@
+Attempt
+====================================
+
+.. currentmodule:: genderbench.probing.attempt
+
+.. autoclass:: Attempt
+ :members: \ No newline at end of file
diff --git a/genderbench/docs/source/api/genderbench.probing.evaluator.Evaluator.rst b/genderbench/docs/source/api/genderbench.probing.evaluator.Evaluator.rst
new file mode 100644
index 0000000..74d526f
--- /dev/null
+++ b/genderbench/docs/source/api/genderbench.probing.evaluator.Evaluator.rst
@@ -0,0 +1,19 @@
+.. _api_evaluator:
+
+Evaluators
+========================================
+
+.. currentmodule:: genderbench.probing.evaluator
+
+.. autoclass:: Evaluator
+ :members:
+
+.. autoclass:: ClosedSetEvaluator
+
+.. currentmodule:: genderbench.probes.generics.yes_no_evaluator
+
+.. autoclass:: YesNoEvaluator
+
+.. currentmodule:: genderbench.probes.generics.character_gender_evaluator
+
+.. autoclass:: CharacterGenderEvaluator
diff --git a/genderbench/docs/source/api/genderbench.probing.harness.Harness.rst b/genderbench/docs/source/api/genderbench.probing.harness.Harness.rst
new file mode 100644
index 0000000..d9fb947
--- /dev/null
+++ b/genderbench/docs/source/api/genderbench.probing.harness.Harness.rst
@@ -0,0 +1,7 @@
+Harness
+====================================
+
+.. currentmodule:: genderbench.probing.harness
+
+.. autoclass:: Harness
+ :members: \ No newline at end of file
diff --git a/genderbench/docs/source/api/genderbench.probing.mark_definition.MarkDefinition.rst b/genderbench/docs/source/api/genderbench.probing.mark_definition.MarkDefinition.rst
new file mode 100644
index 0000000..6a68201
--- /dev/null
+++ b/genderbench/docs/source/api/genderbench.probing.mark_definition.MarkDefinition.rst
@@ -0,0 +1,9 @@
+.. _api_mark_definition:
+
+MarkDefinition
+===========================================
+
+.. currentmodule:: genderbench.probing.mark_definition
+
+.. autoclass:: MarkDefinition
+ :members: \ No newline at end of file
diff --git a/genderbench/docs/source/api/genderbench.probing.metric_calculator.MetricCalculator.rst b/genderbench/docs/source/api/genderbench.probing.metric_calculator.MetricCalculator.rst
new file mode 100644
index 0000000..17234a3
--- /dev/null
+++ b/genderbench/docs/source/api/genderbench.probing.metric_calculator.MetricCalculator.rst
@@ -0,0 +1,9 @@
+.. _api_metric_calculator:
+
+MetricCalculator
+=======================================================
+
+.. currentmodule:: genderbench.probing.metric_calculator
+
+.. autoclass:: MetricCalculator
+ :members: \ No newline at end of file
diff --git a/genderbench/docs/source/api/genderbench.probing.probe.Probe.rst b/genderbench/docs/source/api/genderbench.probing.probe.Probe.rst
new file mode 100644
index 0000000..1abc352
--- /dev/null
+++ b/genderbench/docs/source/api/genderbench.probing.probe.Probe.rst
@@ -0,0 +1,9 @@
+.. _api_probe:
+
+Probe
+================================
+
+.. currentmodule:: genderbench.probing.probe
+
+.. autoclass:: Probe
+ :members: \ No newline at end of file
diff --git a/genderbench/docs/source/api/genderbench.probing.probe_item.ProbeItem.rst b/genderbench/docs/source/api/genderbench.probing.probe_item.ProbeItem.rst
new file mode 100644
index 0000000..db803a7
--- /dev/null
+++ b/genderbench/docs/source/api/genderbench.probing.probe_item.ProbeItem.rst
@@ -0,0 +1,7 @@
+ProbeItem
+=========================================
+
+.. currentmodule:: genderbench.probing.probe_item
+
+.. autoclass:: ProbeItem
+ :members: \ No newline at end of file
diff --git a/genderbench/docs/source/api/genderbench.probing.prompt.Prompt.rst b/genderbench/docs/source/api/genderbench.probing.prompt.Prompt.rst
new file mode 100644
index 0000000..ce652e7
--- /dev/null
+++ b/genderbench/docs/source/api/genderbench.probing.prompt.Prompt.rst
@@ -0,0 +1,7 @@
+Prompt
+==================================
+
+.. currentmodule:: genderbench.probing.prompt
+
+.. autoclass:: Prompt
+ :members: \ No newline at end of file