Skip to content

Commit a00eb77

Browse files
committed
docs: reorganise detector metrics out of code reference section (#1617)
2 parents a0ae35b + 9386213 commit a00eb77

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

docs/source/detector_metrics.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Detector Metrics: F1 Score and Ranking
2-
======================================
1+
Detector Quality Metrics
2+
========================
33

44
Detectors in garak attempt to identify specific failure modes in model outputs. To assess detector performance, they must be evaluated against labeled benchmark datasets where the ground truth is known. This evaluation process measures how accurately each detector identifies its target failure mode.
55

@@ -148,6 +148,8 @@ Key Fields
148148

149149
The primary ranking metric is ``hit_f1`` under each detector's metrics.
150150

151+
.. _Confidence Intervals:
152+
151153
Confidence Intervals
152154
--------------------
153155

docs/source/index.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,11 @@ Check out the :doc:`usage` section for further information, including :doc:`inst
3838
configurable
3939
cliref
4040
reporting
41-
translation
42-
ascii_smuggling
4341
faster
4442
FAQ <https://github.com/NVIDIA/garak/blob/main/FAQ.md>
4543

4644
.. toctree::
47-
:caption: Reference
45+
:caption: Code Reference
4846
:maxdepth: 1
4947
:hidden:
5048

@@ -54,7 +52,6 @@ Check out the :doc:`usage` section for further information, including :doc:`inst
5452
cli
5553
command
5654
detectors
57-
detector_metrics
5855
evaluators
5956
exception
6057
generators
@@ -68,6 +65,15 @@ Check out the :doc:`usage` section for further information, including :doc:`inst
6865
_plugins
6966
analyze
7067

68+
.. toctree::
69+
:caption: Technologies
70+
:maxdepth: 1
71+
:hidden:
72+
73+
detector_metrics
74+
translation
75+
ascii_smuggling
76+
analyze.tbsa
7177

7278
.. toctree::
7379
:caption: Extending and Contributing

0 commit comments

Comments
 (0)