2021-05-13 09:56:38 +00:00
|
|
|
.. ProtoTorch API Reference
|
2021-04-14 17:20:08 +00:00
|
|
|
|
2021-05-13 09:56:38 +00:00
|
|
|
ProtoTorch API Reference
|
2021-04-14 17:20:08 +00:00
|
|
|
======================================
|
|
|
|
|
|
|
|
|
|
Datasets
|
|
|
|
|
--------------------------------------
|
2021-05-18 16:54:43 +00:00
|
|
|
|
|
|
|
|
Common Datasets
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2021-04-14 17:20:08 +00:00
|
|
|
.. automodule:: prototorch.datasets
|
|
|
|
|
:members:
|
2021-05-18 16:54:43 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Abstract Datasets
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
Abstract Datasets are used to build your own datasets.
|
|
|
|
|
|
|
|
|
|
.. autoclass:: prototorch.datasets.abstract.NumpyDataset
|
|
|
|
|
:members:
|
2021-04-14 17:20:08 +00:00
|
|
|
|
|
|
|
|
Functions
|
|
|
|
|
--------------------------------------
|
2021-04-21 12:55:54 +00:00
|
|
|
|
|
|
|
|
**Dimensions:**
|
|
|
|
|
|
|
|
|
|
- :math:`B` ... Batch size
|
|
|
|
|
- :math:`P` ... Number of prototypes
|
|
|
|
|
- :math:`n_x` ... Data dimension for vectorial data
|
|
|
|
|
- :math:`n_w` ... Data dimension for vectorial prototypes
|
|
|
|
|
|
|
|
|
|
Activations
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
.. automodule:: prototorch.functions.activations
|
|
|
|
|
:members:
|
|
|
|
|
:exclude-members: register_activation, get_activation
|
|
|
|
|
:undoc-members:
|
|
|
|
|
|
|
|
|
|
Distances
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
.. automodule:: prototorch.functions.distances
|
2021-04-14 17:20:08 +00:00
|
|
|
:members:
|
2021-04-21 12:55:54 +00:00
|
|
|
:exclude-members: sed
|
2021-04-14 17:20:08 +00:00
|
|
|
:undoc-members:
|
|
|
|
|
|
|
|
|
|
Modules
|
|
|
|
|
--------------------------------------
|
|
|
|
|
.. automodule:: prototorch.modules
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
|
|
|
|
|
Utilities
|
|
|
|
|
--------------------------------------
|
|
|
|
|
.. automodule:: prototorch.utils
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
