prototorch_models/docs/source/library.rst

.. Available Models

Models
========================================

.. image:: _static/img/model_tree.png
   :width: 600

Unsupervised Methods
-----------------------------------------
.. autoclass:: prototorch.models.knn.KNN
   :members:

.. autoclass:: prototorch.models.unsupervised.NeuralGas
   :members:

.. autoclass:: prototorch.models.unsupervised.GrowingNeuralGas
   :members:

Classical Learning Vector Quantization
-----------------------------------------
Original LVQ models introduced by :cite:t:`kohonen1989`.
These heuristic algorithms do not use gradient descent.

.. autoclass:: prototorch.models.lvq.LVQ1
   :members:
.. autoclass:: prototorch.models.lvq.LVQ21
   :members:

It is also possible to use the GLVQ structure as shown by :cite:t:`sato1996` in chapter 4.
This allows the use of gradient descent methods.

.. autoclass:: prototorch.models.glvq.GLVQ1
   :members:
.. autoclass:: prototorch.models.glvq.GLVQ21
   :members:

Generalized Learning Vector Quantization
-----------------------------------------

:cite:t:`sato1996` presented a LVQ variant with a cost function called GLVQ.
This allows the use of gradient descent methods.

.. autoclass:: prototorch.models.glvq.GLVQ
   :members:

The cost function of GLVQ can be extended by a learnable dissimilarity.
These learnable dissimilarities assign relevances to each data dimension during the learning phase.
For example GRLVQ :cite:p:`hammer2002` and GMLVQ :cite:p:`schneider2009` .

.. autoclass:: prototorch.models.glvq.GRLVQ
   :members:

.. autoclass:: prototorch.models.glvq.GMLVQ
   :members:

The dissimilarity from GMLVQ can be interpreted as a projection into another dataspace.
Applying this projection only to the data results in LVQMLN

.. autoclass:: prototorch.models.glvq.LVQMLN
   :members:

The projection idea from GMLVQ can be extended to an arbitrary transformation with learnable parameters.

.. autoclass:: prototorch.models.glvq.SiameseGLVQ
   :members:

Probabilistic Models
--------------------------------------------

Probabilistic variants assume, that the prototypes generate a probability distribution over the classes.
For a test sample they return a distribution instead of a class assignment.

The following two algorihms were presented by :cite:t:`seo2003` .
Every prototypes is a center of a gaussian distribution of its class, generating a mixture model.

.. autoclass:: prototorch.models.probabilistic.SLVQ
   :members:

.. autoclass:: prototorch.models.probabilistic.RSLVQ
   :members:

:cite:t:`villmann2018` proposed two changes to RSLVQ: First incooperate the winning rank into the prior probability calculation.
And second use divergence as loss function.

.. autoclass:: prototorch.models.probabilistic.PLVQ
   :members:

Classification by Component
--------------------------------------------

The Classification by Component (CBC) has been introduced by :cite:t:`saralajew2019` .
In a CBC architecture there is no class assigned to the prototypes.
Instead the dissimilarities are used in a reasoning process, that favours or rejects a class by a learnable degree.
The output of a CBC network is a probability distribution over all classes.

.. autoclass:: prototorch.models.cbc.CBC
   :members:

.. autoclass:: prototorch.models.cbc.ImageCBC
   :members:

Visualization
========================================

Visualization is very specific to its application.
PrototorchModels delivers visualization for two dimensional data and image data.

The visulizations can be shown in a seperate window and inside a tensorboard.

.. automodule:: prototorch.models.vis
   :members:
   :undoc-members:

Bibliography
========================================
.. bibliography::
Add basic documentation files. 2021-05-13 13:22:32 +00:00			`.. Available Models`

Update Documentation Clean up project 2021-05-21 13:42:45 +00:00			`Models`
Add basic documentation files. 2021-05-13 13:22:32 +00:00			`========================================`

Add model tree to documentation. 2021-05-26 19:29:37 +00:00			`.. image:: _static/img/model_tree.png`
			`:width: 600`

Add basic documentation files. 2021-05-13 13:22:32 +00:00			`Unsupervised Methods`
			`-----------------------------------------`
[FEATURE] Add PLVQ model 2021-06-08 13:01:08 +00:00			`.. autoclass:: prototorch.models.knn.KNN`
Add basic documentation files. 2021-05-13 13:22:32 +00:00			`:members:`

Update Documentation Clean up project 2021-05-21 13:42:45 +00:00			`.. autoclass:: prototorch.models.unsupervised.NeuralGas`
Add basic documentation files. 2021-05-13 13:22:32 +00:00			`:members:`

[FEATURE] Add Growing Neural Gas 2021-06-01 15:19:43 +00:00			`.. autoclass:: prototorch.models.unsupervised.GrowingNeuralGas`
			`:members:`
Add basic documentation files. 2021-05-13 13:22:32 +00:00
			`Classical Learning Vector Quantization`
			`-----------------------------------------`
Add references to the documentation. 2021-05-26 19:20:17 +00:00			Original LVQ models introduced by :cite:t:`kohonen1989`.
Update Documentation Clean up project 2021-05-21 13:42:45 +00:00			`These heuristic algorithms do not use gradient descent.`
Add basic documentation files. 2021-05-13 13:22:32 +00:00
[BUGFIX] Update paths in documentaion for LVQ 2021-05-26 14:19:10 +00:00			`.. autoclass:: prototorch.models.lvq.LVQ1`
Add basic documentation files. 2021-05-13 13:22:32 +00:00			`:members:`
[BUGFIX] Update paths in documentaion for LVQ 2021-05-26 14:19:10 +00:00			`.. autoclass:: prototorch.models.lvq.LVQ21`
Add basic documentation files. 2021-05-13 13:22:32 +00:00			`:members:`

Add references to the documentation. 2021-05-26 19:20:17 +00:00			It is also possible to use the GLVQ structure as shown by :cite:t:`sato1996` in chapter 4.
Update Documentation Clean up project 2021-05-21 13:42:45 +00:00			`This allows the use of gradient descent methods.`

			`.. autoclass:: prototorch.models.glvq.GLVQ1`
			`:members:`
			`.. autoclass:: prototorch.models.glvq.GLVQ21`
			`:members:`

Add basic documentation files. 2021-05-13 13:22:32 +00:00			`Generalized Learning Vector Quantization`
			`-----------------------------------------`

Add references to the documentation. 2021-05-26 19:20:17 +00:00			:cite:t:`sato1996` presented a LVQ variant with a cost function called GLVQ.
			`This allows the use of gradient descent methods.`

Add basic documentation files. 2021-05-13 13:22:32 +00:00			`.. autoclass:: prototorch.models.glvq.GLVQ`
			`:members:`

Add references to the documentation. 2021-05-26 19:20:17 +00:00			`The cost function of GLVQ can be extended by a learnable dissimilarity.`
			`These learnable dissimilarities assign relevances to each data dimension during the learning phase.`
			For example GRLVQ :cite:p:`hammer2002` and GMLVQ :cite:p:`schneider2009` .
Add basic documentation files. 2021-05-13 13:22:32 +00:00
			`.. autoclass:: prototorch.models.glvq.GRLVQ`
			`:members:`

			`.. autoclass:: prototorch.models.glvq.GMLVQ`
			`:members:`

Add references to the documentation. 2021-05-26 19:20:17 +00:00			`The dissimilarity from GMLVQ can be interpreted as a projection into another dataspace.`
			`Applying this projection only to the data results in LVQMLN`

Add basic documentation files. 2021-05-13 13:22:32 +00:00			`.. autoclass:: prototorch.models.glvq.LVQMLN`
			`:members:`

Add references to the documentation. 2021-05-26 19:20:17 +00:00			`The projection idea from GMLVQ can be extended to an arbitrary transformation with learnable parameters.`

			`.. autoclass:: prototorch.models.glvq.SiameseGLVQ`
			`:members:`

			`Probabilistic Models`
			`--------------------------------------------`

			`Probabilistic variants assume, that the prototypes generate a probability distribution over the classes.`
			`For a test sample they return a distribution instead of a class assignment.`

test(githooks): Add githooks for automatic commit checks 2021-06-16 14:16:34 +00:00			The following two algorihms were presented by :cite:t:`seo2003` .
Add references to the documentation. 2021-05-26 19:20:17 +00:00			`Every prototypes is a center of a gaussian distribution of its class, generating a mixture model.`

[REFACTOR] Rename LikelihoodRatioLVQ to SLVQ 2021-06-08 06:38:11 +00:00			`.. autoclass:: prototorch.models.probabilistic.SLVQ`
Add references to the documentation. 2021-05-26 19:20:17 +00:00			`:members:`

			`.. autoclass:: prototorch.models.probabilistic.RSLVQ`
			`:members:`

[FEATURE] Add PLVQ model 2021-06-08 13:01:08 +00:00			:cite:t:`villmann2018` proposed two changes to RSLVQ: First incooperate the winning rank into the prior probability calculation.
			`And second use divergence as loss function.`
Add references to the documentation. 2021-05-26 19:20:17 +00:00
[FEATURE] Add PLVQ model 2021-06-08 13:01:08 +00:00			`.. autoclass:: prototorch.models.probabilistic.PLVQ`
			`:members:`
Add references to the documentation. 2021-05-26 19:20:17 +00:00
Update Documentation Clean up project 2021-05-21 13:42:45 +00:00			`Classification by Component`
Add references to the documentation. 2021-05-26 19:20:17 +00:00			`--------------------------------------------`

			The Classification by Component (CBC) has been introduced by :cite:t:`saralajew2019` .
			`In a CBC architecture there is no class assigned to the prototypes.`
			`Instead the dissimilarities are used in a reasoning process, that favours or rejects a class by a learnable degree.`
			`The output of a CBC network is a probability distribution over all classes.`

Add basic documentation files. 2021-05-13 13:22:32 +00:00			`.. autoclass:: prototorch.models.cbc.CBC`
			`:members:`

			`.. autoclass:: prototorch.models.cbc.ImageCBC`
Update Documentation Clean up project 2021-05-21 13:42:45 +00:00			`:members:`

			`Visualization`
			`========================================`

Add references to the documentation. 2021-05-26 19:20:17 +00:00			`Visualization is very specific to its application.`
			`PrototorchModels delivers visualization for two dimensional data and image data.`

			`The visulizations can be shown in a seperate window and inside a tensorboard.`

Update Documentation Clean up project 2021-05-21 13:42:45 +00:00			`.. automodule:: prototorch.models.vis`
			`:members:`
Add references to the documentation. 2021-05-26 19:20:17 +00:00			`:undoc-members:`

			`Bibliography`
			`========================================`
test(githooks): Add githooks for automatic commit checks 2021-06-16 14:16:34 +00:00			`.. bibliography::`