Restructure API docs for integrations

AdaptiveMotorControlLab · Oct 29, 2023 · 78afc34 · 78afc34
1 parent f0fe607
commit 78afc34
Show file tree

Hide file tree

Showing 8 changed files with 53 additions and 16 deletions.
diff --git a/cebra/data/load.py b/cebra/data/load.py
@@ -9,7 +9,22 @@
 # Please see LICENSE.md for the full license document:
 # https://github.com/AdaptiveMotorControlLab/CEBRA/LICENSE.md
 #
-"""A simple API for loading various data formats used with CEBRA."""
+"""A simple API for loading various data formats used with CEBRA.
+
+Availability of different data formats depends on the installed
+depedencies. If a dependency is not installed, an attempt to load
+a file of that format will throw an error with further installation
+instructions.
+
+Currently available formats:
+
+- HDF5 via ``h5py``
+- Pickle files via ``pickle``
+- Joblib files via ``joblib``
+- Various dataframe formats via ``pandas``.
+- Matlab files via ``scipy.io.loadmat``
+- DeepLabCut (single animal) files via ``deeplabcut``
+"""
 
 import abc
 import pathlib

diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -40,5 +40,14 @@ these components in other contexts and research code bases.
    api/pytorch/integrations
    api/pytorch/helpers
 
+.. toctree::
+   :hidden:
+   :caption: Integrations
+
+   api/integrations/data
+   api/integrations/matplotlib
+   api/integrations/plotly
+   api/integrations/deeplabcut
+
 
 .. _Scikit-learn estimators: https://scikit-learn.org/stable/developers/develop.html
diff --git a/docs/source/api/integrations/data.rst b/docs/source/api/integrations/data.rst
@@ -0,0 +1,6 @@
+Data Loading
+------------
+
+.. automodule:: cebra.data.load
+   :show-inheritance:
+   :members:
diff --git a/docs/source/api/integrations/deeplabcut.rst b/docs/source/api/integrations/deeplabcut.rst
@@ -0,0 +1,8 @@
+DeepLabCut
+----------
+
+.. automodule:: cebra.integrations.deeplabcut
+   :show-inheritance:
+   :members:
+
+
diff --git a/docs/source/api/integrations/matplotlib.rst b/docs/source/api/integrations/matplotlib.rst
@@ -0,0 +1,7 @@
+Plotting with ``matplotlib``
+----------------------------
+
+.. automodule:: cebra.integrations.matplotlib
+   :show-inheritance:
+   :members:
+
diff --git a/docs/source/api/integrations/plotly.rst b/docs/source/api/integrations/plotly.rst
@@ -0,0 +1,7 @@
+Plotting with ``plotly``
+----------------------------
+
+.. automodule:: cebra.integrations.plotly
+   :show-inheritance:
+   :members:
+
diff --git a/docs/source/api/pytorch/helpers.rst b/docs/source/api/pytorch/helpers.rst
@@ -21,14 +21,6 @@ Registry
    :show-inheritance:
 
 
-Plots
------
-
-.. automodule:: cebra.integrations.matplotlib
-   :show-inheritance:
-   :members:
-
-
 Grid-Search
 -----------
 

diff --git a/docs/source/api/pytorch/integrations.rst b/docs/source/api/pytorch/integrations.rst