Skip to content
Snippets Groups Projects
Commit dc504682 authored by André Anjos's avatar André Anjos :speech_balloon:
Browse files

Improved documentation

parent 58b59aa6
No related branches found
No related tags found
No related merge requests found
...@@ -118,6 +118,9 @@ Cost ...@@ -118,6 +118,9 @@ Cost
Returns the object on success or a NULL pointer on failure. Returns the object on success or a NULL pointer on failure.
Data Shuffler
-------------
.. cpp:type PyBobLearnDataShufflerObject .. cpp:type PyBobLearnDataShufflerObject
The pythonic representation for a :py:class:`xbob.learn.mlp.DataShuffler` The pythonic representation for a :py:class:`xbob.learn.mlp.DataShuffler`
...@@ -142,6 +145,9 @@ Cost ...@@ -142,6 +145,9 @@ Cost
``0`` otherwise. ``0`` otherwise.
Trainers
--------
.. cpp:type PyBobLearnMLPTrainerObject .. cpp:type PyBobLearnMLPTrainerObject
The pythonic representation for a :py:class:`xbob.learn.mlp.Trainer` object. The pythonic representation for a :py:class:`xbob.learn.mlp.Trainer` object.
......
...@@ -136,9 +136,8 @@ The class used to train a MLP [1]_ with backpropagation [2]_ is ...@@ -136,9 +136,8 @@ The class used to train a MLP [1]_ with backpropagation [2]_ is
|project|: :py:class:`xbob.learn.mlp.SquareError`, like before, or |project|: :py:class:`xbob.learn.mlp.SquareError`, like before, or
:py:class:`xbob.learn.mlp.CrossEntropyLoss` (normally in association with :py:class:`xbob.learn.mlp.CrossEntropyLoss` (normally in association with
:py:class:`bob.learn.activation.Logistic`). You can implement your own :py:class:`bob.learn.activation.Logistic`). You can implement your own
cost/loss functions. Nevertheless, to do so, you must do it using our C++ API cost/loss functions. Nevertheless, to do so, you must do it using our
and then bind it to Python in your own :doc:`Satellite Package C/C++-API and then bind it to Python in your own package.
<OrganizeYourCode>`.
Backpropagation [2]_ requires a learning rate to be set. In the previous Backpropagation [2]_ requires a learning rate to be set. In the previous
example, the default value ``0.1`` has been used. This might be updated using example, the default value ``0.1`` has been used. This might be updated using
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment