Skip to content

Commit 77a1b23

Browse files
themattinthehattthemattinthehatt
authored
docs refactoring (#285)
* docs refactoring * add missing doc
1 parent ddee853 commit 77a1b23

File tree

40 files changed

+123
-150
lines changed

40 files changed

+123
-150
lines changed

‎docs/api/lightning_pose.data.datamodules.BaseDataModule.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,13 @@ BaseDataModule
1111
.. autosummary::
1212

1313
~BaseDataModule.full_labeled_dataloader
14-
~BaseDataModule.setup
1514
~BaseDataModule.test_dataloader
1615
~BaseDataModule.train_dataloader
1716
~BaseDataModule.val_dataloader
1817

1918
.. rubric:: Methods Documentation
2019

2120
.. automethod:: full_labeled_dataloader
22-
.. automethod:: setup
2321
.. automethod:: test_dataloader
2422
.. automethod:: train_dataloader
2523
.. automethod:: val_dataloader

‎docs/api/lightning_pose.data.utils.BaseLabeledBatchDict.rst renamed to ‎docs/api/lightning_pose.data.datatypes.BaseLabeledBatchDict.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
BaseLabeledBatchDict
22
====================
33

4-
.. currentmodule:: lightning_pose.data.utils
4+
.. currentmodule:: lightning_pose.data.datatypes
55

66
.. autoclass:: BaseLabeledBatchDict
77
:show-inheritance:

‎docs/api/lightning_pose.data.utils.BaseLabeledExampleDict.rst renamed to ‎docs/api/lightning_pose.data.datatypes.BaseLabeledExampleDict.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
BaseLabeledExampleDict
22
======================
33

4-
.. currentmodule:: lightning_pose.data.utils
4+
.. currentmodule:: lightning_pose.data.datatypes
55

66
.. autoclass:: BaseLabeledExampleDict
77
:show-inheritance:

‎docs/api/lightning_pose.data.utils.HeatmapLabeledBatchDict.rst renamed to ‎docs/api/lightning_pose.data.datatypes.HeatmapLabeledBatchDict.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
HeatmapLabeledBatchDict
22
=======================
33

4-
.. currentmodule:: lightning_pose.data.utils
4+
.. currentmodule:: lightning_pose.data.datatypes
55

66
.. autoclass:: HeatmapLabeledBatchDict
77
:show-inheritance:

‎docs/api/lightning_pose.data.utils.HeatmapLabeledExampleDict.rst renamed to ‎docs/api/lightning_pose.data.datatypes.HeatmapLabeledExampleDict.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
HeatmapLabeledExampleDict
22
=========================
33

4-
.. currentmodule:: lightning_pose.data.utils
4+
.. currentmodule:: lightning_pose.data.datatypes
55

66
.. autoclass:: HeatmapLabeledExampleDict
77
:show-inheritance:

‎docs/api/lightning_pose.data.utils.MultiviewHeatmapLabeledBatchDict.rst renamed to ‎docs/api/lightning_pose.data.datatypes.MultiviewHeatmapLabeledBatchDict.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
MultiviewHeatmapLabeledBatchDict
22
================================
33

4-
.. currentmodule:: lightning_pose.data.utils
4+
.. currentmodule:: lightning_pose.data.datatypes
55

66
.. autoclass:: MultiviewHeatmapLabeledBatchDict
77
:show-inheritance:

‎docs/api/lightning_pose.data.utils.MultiviewHeatmapLabeledExampleDict.rst renamed to ‎docs/api/lightning_pose.data.datatypes.MultiviewHeatmapLabeledExampleDict.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
MultiviewHeatmapLabeledExampleDict
22
==================================
33

4-
.. currentmodule:: lightning_pose.data.utils
4+
.. currentmodule:: lightning_pose.data.datatypes
55

66
.. autoclass:: MultiviewHeatmapLabeledExampleDict
77
:show-inheritance:

‎docs/api/lightning_pose.data.utils.MultiviewLabeledBatchDict.rst renamed to ‎docs/api/lightning_pose.data.datatypes.MultiviewLabeledBatchDict.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
MultiviewLabeledBatchDict
22
=========================
33

4-
.. currentmodule:: lightning_pose.data.utils
4+
.. currentmodule:: lightning_pose.data.datatypes
55

66
.. autoclass:: MultiviewLabeledBatchDict
77
:show-inheritance:

‎docs/api/lightning_pose.data.utils.MultiviewLabeledExampleDict.rst renamed to ‎docs/api/lightning_pose.data.datatypes.MultiviewLabeledExampleDict.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
MultiviewLabeledExampleDict
22
===========================
33

4-
.. currentmodule:: lightning_pose.data.utils
4+
.. currentmodule:: lightning_pose.data.datatypes
55

66
.. autoclass:: MultiviewLabeledExampleDict
77
:show-inheritance:

‎docs/api/lightning_pose.data.utils.MultiviewUnlabeledBatchDict.rst renamed to ‎docs/api/lightning_pose.data.datatypes.MultiviewUnlabeledBatchDict.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
MultiviewUnlabeledBatchDict
22
===========================
33

4-
.. currentmodule:: lightning_pose.data.utils
4+
.. currentmodule:: lightning_pose.data.datatypes
55

66
.. autoclass:: MultiviewUnlabeledBatchDict
77
:show-inheritance:

0 commit comments

Comments
 (0)