update docu

mobilise-d · Feb 3, 2025 · 2f55255 · 2f55255
1 parent 9e4b7ac
commit 2f55255
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -214,6 +214,7 @@ def substitute(matchobj) -> str:
             "../examples/dev_guides",
             "../revalidation/gait_sequences",
             "../revalidation/initial_contacts",
+            "../revalidation/cadence",
             "../revalidation/stride_length",
         ]
     ),

diff --git a/docs/modules/cadence.rst b/docs/modules/cadence.rst
@@ -40,3 +40,37 @@ Docu-helper
 
     base_cad_docfiller
 
+Pipelines
++++++++++
+.. currentmodule:: mobgap.cadence
+
+.. autosummary::
+   :toctree: generated/cadence
+   :template: class.rst
+
+    pipeline.CadEmulationPipeline
+
+Evaluation
+++++++++++
+As the structure of the Cadence output is very similar to the output of the full pipeline, we recommend using the
+pipeline level evaluation functions to create custom evaluations.
+
+Evaluation Scores
++++++++++++++++++
+These scores are expected to be used in combination with :class:`~mobgap.utils.evaluation.Evaluation` and
+:class:`~mobgap.utils.evaluation.EvaluationCV` or directly with :func:`~tpcp.validation.cross_validation` and
+:func:`~tpcp.validation.validation`.
+
+.. currentmodule:: mobgap.cadence.evaluation
+
+.. autosummary::
+   :toctree: generated/cadence
+
+    cad_score
+
+.. autosummary::
+   :toctree: generated/cadence
+   :template: func.rst
+
+    cad_per_datapoint_score
+    cad_final_agg