Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
API
===

.. automodule:: gpu_tracker

gpu_tracker.tracker
-------------------
.. automodule:: gpu_tracker.tracker
:members:
:undoc-members:

gpu_tracker.sub_tracker
-----------------------
.. automodule:: gpu_tracker.sub_tracker
:members:
:undoc-members:
2 changes: 1 addition & 1 deletion src/gpu_tracker/sub_tracker.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""The ``sub_tracker`` module contains the ``SubTracker`` class which can alternatively be imported directly from the ``gpu_tracker`` package."""
"""The ``sub_tracker`` module contains the ``SubTracker`` class which can alternatively be imported directly from the ``gpu_tracker`` package. Additionally, it contains the ``SubTrackingAnalyzer`` class which generates the ``SubTrackingResults`` from the data produced by the ``SubTracker`` and finally the ``TrackingComparison`` which generates the ``ComparisonResults`` comparing the ``SubTrackingResults`` of multiple tracking sessions."""
from __future__ import annotations
import inspect
import os
Expand Down
Loading