Commit c712b998 by Gaspard Ducamp

[pyAgrum/doc] Several docs added

parent 37e2992c
Pipeline #13485702 passed with stage
in 1 minute 47 seconds
......@@ -11,30 +11,396 @@ Parameters
----------
name: str
the name of the Bayes Net (optional)
source : :class:BayesNet
source : pyAgrum.BayesNet
the Bayesian network to copy
"
%feature("docstring") gum::BayesNet::fastPrototype
%feature("docstring") gum::BayesNet::add
"
Add a variable to the pyAgrum.BayesNet.
Parameters
----------
variable : pyAgrum.DiscreteVariable
the variable added
name : str
the variable name
nbrmod : int
the numbre of modalities for the new variable
id : int
the variable forced id in the pyAgrum.BayesNet
Returns
-------
int
the id of the new node
Warnings
--------
DuplicateLabel raised if variable.name() is already used in this pyAgrum.BayesNet.
Warnings
--------
NotAllowed if nbrmod<2
Warnings
--------
DuplicateElement raised if id is already used.
"
%feature("docstring") gum::BayesNet::addAMPLITUDE
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addAND
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addArc
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addCOUNT
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addEXISTS
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addFORALL
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addLogit
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addMAX
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addMEDIAN
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addMIN
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addNoisyAND
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addNoisyOR
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addNoisyORCompound
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addNoisyORNet
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addOR
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::addWeightedArc
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::arcs
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::beginTopologyTransformation
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::changePotential
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::changeVariableName
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::children
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::cpt
"
FOO BAR
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::endTopologyTransformation
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::erase
"
FOO BAR
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::eraseArc
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::fastPrototype
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::dag
%feature("docstring") gum::BayesNet::generateCPT
"
FOO BAR
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::generateCPTs
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::idFromName
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::ids
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::loadBIF
"
FOO BAR
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::loadBIFXML
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::loadDSL
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::loadNET
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::loadO3PRM
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::loadUAI
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::minimalCondSet
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::moralGraph
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::names
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::nodeId
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::parents
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::reverseArc
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::saveBIF
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::saveBIFXML
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::saveDSL
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::saveNET
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::saveO3PRM
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::saveUAI
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::variable
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::variableFromName
"
Warnings
--------
A Faire
"
%feature("docstring") gum::BayesNet::variableNodeMap
"
Warnings
--------
A Faire
"
%feature("docstring") gum::DAGmodel::log10DomainSize
"
in DAGmodel
Warnings
--------
A Faire
"
%feature("docstring") gum::DAGmodel::completeInstantiation
"
in DAGmodel
Warnings
--------
A Faire
"
%feature("docstring") gum::DAGmodel::dag
"
in DAGmodel
Warnings
--------
A Faire
"
%feature("docstring") gum::DAGmodel::empty
"
in DAGmodel
Warnings
--------
A Faire
"
%feature("docstring") gum::DAGmodel::hasSameStructure
"
in DAGmodel
Warnings
--------
A Faire
"
%feature("docstring") gum::DAGmodel::property
"
in DAGmodel
Warnings
--------
A Faire
"
%feature("docstring") gum::DAGmodel::propertyWithDefault
"
in DAGmodel
Warnings
--------
A Faire
"
%feature("docstring") gum::DAGmodel::setProperty
"
in DAGmodel
Warnings
--------
A Faire
"
%feature("docstring") gum::DAGmodel::size
"
in DAGmodel
Warnings
--------
A Faire
"
%feature("docstring") gum::DAGmodel::sizeArcs
"
in DAGmodel
Warnings
--------
A Faire
"
%feature("docstring") gum::DAGmodel::topologicalOrder
"
in DAGmodel
Warnings
--------
A Faire
"
\ No newline at end of file
%feature("docstring") gum::IBayesNet::dim
"
in IBayesNet
Warnings
--------
A Faire
"
%feature("docstring") gum::IBayesNet::jointProbability
"
in IBayesNet
Warnings
--------
A Faire
"
%feature("docstring") gum::IBayesNet::log2JointProbability
"
in IBayesNet
Warnings
--------
A Faire
"
%feature("docstring") gum::IBayesNet::maxNonOneParam
"
in IBayesNet
Warnings
--------
A Faire
"
%feature("docstring") gum::IBayesNet::maxParam
"
in IBayesNet
Warnings
--------
A Faire
"
%feature("docstring") gum::IBayesNet::maxVarDomainSize
"
in IBayesNet
Warnings
--------
A Faire
"
%feature("docstring") gum::IBayesNet::minNonZeroParam
"
in IBayesNet
Warnings
--------
A Faire
"
%feature("docstring") gum::IBayesNet::minParam
"
in IBayesNet
Warnings
--------
A Faire
"
%feature("docstring") gum::IBayesNet::toDot
"
in IBayesNet
Warnings
--------
A Faire
"
\ No newline at end of file
......@@ -9,9 +9,26 @@
%feature("docstring") gum::Instantiation
"
Warnings
--------
A faire
Class for assigning/browsing values to tuples of discrete variables.
Instantiation is designed to assign values to tuples of variables and to efficiently loop over values of subsets of variables.
Available constructors:
``Instantiation() -> Instantiation``
``Instantiation(aI) -> Instantiation``
Parameters
----------
aI: pyAgrum.Instantiation
The Instantiation we copy
Returns
-------
pyAgrum.Instantiation
An empty tuple or a copy of the one in parameters
"
%feature("docstring") gum::Instantiation::add
......@@ -59,10 +76,6 @@ Warnings
%feature("docstring") gum::Instantiation::clear
"
Erase all variables from an Instantiation.
Warnings
--------
?
"
%feature("docstring") gum::Instantiation::contains
......@@ -392,7 +405,21 @@ Removes the flag overflow.
%feature("docstring") gum::Instantiation::val
"
Returns the current value of the variable at position i.
Parameters
----------
i : int
The index of the variable.
var : pyAgrum.DiscreteVariable
The variable the value of which we wish to know
Returns
-------
int
the current value of the variable.
Warnings
--------
NotFound raised if the element cannot be found.
"
%feature("docstring") gum::Instantiation::variable
......
%ignore gum::Potential::populate;
%feature("docstring") gum::Potential
"
Class representing a potential.
Available constructors:
``Potential() -> Potential``
``Potential(src) -> Potential``
Parameters
----------
src: pyAgrum.Potential
The Potential to copy
Returns
-------
pyAgrum.Potential
The new Potential
"
%feature("docstring") gum::Potential::KL
"
Compute the Kullback-Leibler divergence between the potential and p, check the compatibility and call fastKL.
Parameters
----------
p : pyAgrum.Potential
the potential from which we want to calculate the divergence.
Returns
-------
float
The value of the divergence
Warnings
--------
InvalidArgument raised if p is not compatible with the potential (dimension, variables)
Warnings
--------
FatalError raised if a zero is found in p or the potential and not in the other.
"
%feature("docstring") gum::Potential::abs
"
Apply abs on every element of the container
Returns
-------
pyAgrum.Potential
a reference to the modified potential.
"
%feature("docstring") gum::Potential::add
"
Add a discrete variable to the potential.
Parameters
----------
v : pyAgrum.DiscreteVariable
the var to be added
Warnings
--------
Error raised if DiscretizedVariable added with no Tick.
"
%feature("docstring") gum::Potential::contains
"
Parameters
----------
v : pyAgrum.Potential
a DiscreteVariable.
Returns
-------
bool
True if the var is in the potential
"
%feature("docstring") gum::Potential::empty
"
Returns
-------
bool
Returns true if no variable is in the potential.
"
%feature("docstring") gum::Potential::entropy
"
Returns
-------
double
the entropy of the potential
"
%feature("docstring") gum::Potential::extract
"
create a new Potential extracted from self given a partial instantiation.
Parameters
----------
inst : pyAgrum.instantiation
a partial instantiation
dict : dict
a dictionnary containing discrete variables (?)
Returns
-------
pyAgrum.Potential
the new Potential
"
%feature("docstring") gum::Potential::fastKL
"
compute KL divergence between this and p without testing compatibilty (undefined errors may occur in this case)
Parameters
----------
p : pyAgrum.Potential
the potential from which we want to calculate the divergence.