From 820aed2ed855f4b3bfe0691e1d91c600bd4b3908 Mon Sep 17 00:00:00 2001
From: Martin <1500595+bmmtstb@users.noreply.github.com>
Date: Fri, 13 Sep 2024 19:23:14 +0200
Subject: [PATCH] fixed docs

Signed-off-by: Martin <1500595+bmmtstb@users.noreply.github.com>
---
 dgs/models/engine/dgs_engine.py | 3 +--
 docs/conf.py                    | 6 ++----
 docs/metrics.rst                | 8 ++++----
 3 files changed, 7 insertions(+), 10 deletions(-)

diff --git a/dgs/models/engine/dgs_engine.py b/dgs/models/engine/dgs_engine.py
index 64f3801..3868d72 100644
--- a/dgs/models/engine/dgs_engine.py
+++ b/dgs/models/engine/dgs_engine.py
@@ -91,7 +91,7 @@ class DGSEngine(EngineModule):
         Default ``DEF_VAL.engine.dgs.acc_k_eval``.
 
     eval_accuracy (bool, optional):
-        Whether to evaluate the alpha-prediction accuracy or the |MOTA|_ / |HOTA|_ of the model during evaluation.
+        Whether to evaluate the alpha-prediction accuracy or the |MOTA| / |HOTA| of the model during evaluation.
         Default ``DEF_VAL.engine.dgs.eval_accuracy``.
 
     submission (Union[str, NodePath]):
@@ -584,7 +584,6 @@ def _eval_tracking(self) -> None:
 
         self._track(dl=self.val_dl, name="Eval")
 
-    @enable_keyboard_interrupt
     @t.no_grad()
     def evaluate(self) -> Results:
         r"""Run the model evaluation on the eval data.
diff --git a/docs/conf.py b/docs/conf.py
index 141b11c..a5b6f67 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -66,10 +66,8 @@
 .. _torchreid: https://github.com/KaiyangZhou/deep-person-reid
 .. |MOT| replace:: ``MOT``
 .. _MOT: https://motchallenge.net/
-.. |MOTA| replace:: ``MOTA``
-.. _MOTA: _metrics_mota
-.. |HOTA| replace:: ``HOTA``
-.. _HOTA: _metrics_hota
+.. |MOTA| replace:: :ref:` ``MOTA`` <metrics_mota>`
+.. |HOTA| replace:: :ref:` ``HOTA`` <metrics_hota>`
 """
 
 # tell autodoc that we don't want these packages to be imported
diff --git a/docs/metrics.rst b/docs/metrics.rst
index bc139ea..05c057e 100644
--- a/docs/metrics.rst
+++ b/docs/metrics.rst
@@ -14,14 +14,14 @@ Tracking Metrics
 
 .. _metrics_mota:
 
-MOTA
-====
+Multi-Object Tracking Accuracy
+==============================
 
 TODO
 
 .. _metrics_hota:
 
-HOTA
-====
+Higher-Order Tracking Accuracy
+==============================
 
 TODO