Improve dataset documentation.

This commit is contained in:
Alexander Engelsberger
2021-05-18 18:54:43 +02:00
parent b935e9caf3
commit b2e1df7308
8 changed files with 81 additions and 8 deletions

View File

@@ -5,9 +5,20 @@ ProtoTorch API Reference
Datasets
--------------------------------------
Common Datasets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: prototorch.datasets
:members:
:undoc-members:
Abstract Datasets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Abstract Datasets are used to build your own datasets.
.. autoclass:: prototorch.datasets.abstract.NumpyDataset
:members:
Functions
--------------------------------------

View File

@@ -46,6 +46,7 @@ extensions = [
"sphinx.ext.viewcode",
"sphinx_rtd_theme",
"sphinxcontrib.katex",
'sphinx_autodoc_typehints',
]
# katex_prerender = True