Skip to content

Commit

Permalink
fixed docs
Browse files Browse the repository at this point in the history
Signed-off-by: Martin <[email protected]>
  • Loading branch information
bmmtstb committed Sep 13, 2024
1 parent 60f4c5d commit 820aed2
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 10 deletions.
3 changes: 1 addition & 2 deletions dgs/models/engine/dgs_engine.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]):
Expand Down Expand Up @@ -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.
Expand Down
6 changes: 2 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Tracking Metrics

.. _metrics_mota:

MOTA
====
Multi-Object Tracking Accuracy
==============================

TODO

.. _metrics_hota:

HOTA
====
Higher-Order Tracking Accuracy
==============================

TODO

0 comments on commit 820aed2

Please sign in to comment.