Commit 74bb931f authored by Tiago de Freitas Pereira's avatar Tiago de Freitas Pereira
Browse files

More documentation

parent 413fd06e
......@@ -261,7 +261,7 @@ static auto init_f_method = bob::extension::VariableDoc(
"init_f_method",
"str",
"The method used for the initialization of :math:`$F$`.",
""
"Possible values are: ('RANDOM_F', 'BETWEEN_SCATTER')"
);
PyObject* PyBobLearnEMPLDATrainer_getFMethod(PyBobLearnEMPLDATrainerObject* self, void*) {
BOB_TRY
......@@ -287,7 +287,7 @@ static auto init_g_method = bob::extension::VariableDoc(
"init_g_method",
"str",
"The method used for the initialization of :math:`$G$`.",
""
"Possible values are: ('RANDOM_G', 'BETWEEN_SCATTER')"
);
PyObject* PyBobLearnEMPLDATrainer_getGMethod(PyBobLearnEMPLDATrainerObject* self, void*) {
BOB_TRY
......@@ -307,13 +307,12 @@ int PyBobLearnEMPLDATrainer_setGMethod(PyBobLearnEMPLDATrainerObject* self, PyOb
BOB_CATCH_MEMBER("init_g_method method could not be set", 0)
}
/***** init_sigma_method *****/
static auto init_sigma_method = bob::extension::VariableDoc(
"init_sigma_method",
"str",
"The method used for the initialization of :math:`$\\Sigma$`.",
""
"Possible values are: ('RANDOM_SIGMA', 'VARIANCE_G', 'CONSTANT', 'VARIANCE_DATA')"
);
PyObject* PyBobLearnEMPLDATrainer_getSigmaMethod(PyBobLearnEMPLDATrainerObject* self, void*) {
BOB_TRY
......
......@@ -9,6 +9,50 @@
This section includes information for using the pure Python API of
``bob.learn.em``.
Classes
-------
.. autosummary::
Trainers
--------
bob.learn.em.KMeansTrainer
bob.learn.em.ML_GMMTrainer
bob.learn.em.MAP_GMMTrainer
bob.learn.em.ISVTrainer
bob.learn.em.JFATrainer
bob.learn.em.IVectorTrainer
bob.learn.em.PLDATrainer
Machines
--------
bob.learn.em.KMeansMachine
bob.learn.em.Gaussian
bob.learn.em.GMMStats
bob.learn.em.GMMMachine
bob.learn.em.ISVBase
bob.learn.em.ISVMachine
bob.learn.em.JFABase
bob.learn.em.JFAMachine
bob.learn.em.IVectorMachine
bob.learn.em.PLDABase
bob.learn.em.PLDAMachine
Functions
---------
.. autosummary::
bob.learn.em.linear_scoring
bob.learn.em.tnorm
bob.learn.em.train
bob.learn.em.train_jfa
bob.learn.em.znorm
bob.learn.em.ztnorm
bob.learn.em.ztnorm_same_value
Detailed Information
--------------------
.. automodule:: bob.learn.em
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment