Commit 618360e8 by Gaspard Ducamp

[pyAgrum/doc] misc. updates

parent 46fbaed4
Pipeline #13711123 passed with stage
in 4 minutes 31 seconds
%feature("docstring") gum::learning::BNLearner
"
Available constructors:
``BNLearner(filename) -> BNLearner``
``BNLearner(filename,src,parse_database=false) -> BNLearner``
``BNLearner(learner) -> BNLearner``
Parameters
----------
filename: str
the file to learn from
src : pyAgrum.BayesNet
the Bayesian network used to find thoes modalities
parse_database : bool
if true, the modalities specified by the user will be considered as a superset of the modalities of the variables.
learner : pyAgrum.BNLearner
the BNLearner to copy
"
%feature("docstring") gum::learning::BNLearner::asIApproximationSchemeConfiguration
......
%feature("docstring") gum::IApproximationSchemeConfiguration::addForbiddenArc
"
The arc in parameters won't be added.
Parameters
----------
arc : pyAgrum
......@@ -12,15 +14,11 @@ head :
a variable's name (str)
tail :
a variable's name (str)
Warnings
--------
A continuer ?
"
%feature("docstring") gum::IApproximationSchemeConfiguration::addMandatoryArc
"
Allow to add prior structural knowledge
Allow to add prior structural knowledge.
Parameters
----------
......@@ -37,7 +35,7 @@ tail :
Warnings
--------
A continuer ?
InvalidDirectedCycle raised if the added arc creates a directed cycle in the DAG
"
%feature("docstring") gum::IApproximationSchemeConfiguration::burnIn
......@@ -66,6 +64,8 @@ double
%feature("docstring") gum::IApproximationSchemeConfiguration::eraseForbiddenArc
"
Allow the arc in parameter to be added if necessary.
Parameters
----------
arc : pyAgrum
......@@ -78,10 +78,6 @@ head :
a variable's name (str)
tail :
a variable's name (str)
Warnings
--------
A continuer ?
"
%feature("docstring") gum::IApproximationSchemeConfiguration::eraseMandatoryArc
......@@ -98,10 +94,6 @@ head :
a variable's name (str)
tail :
a variable's name (str)
Warnings
--------
A continuer ?
"
%feature("docstring") gum::IApproximationSchemeConfiguration::history
......@@ -380,49 +372,38 @@ Use no apriori.
%feature("docstring") gum::IApproximationSchemeConfiguration::useScoreAIC
"
Warnings
--------
A Faire
Indicate that we wish to use an AIC score.
"
%feature("docstring") gum::IApproximationSchemeConfiguration::useScoreBD
"
Warnings
--------
A Faire
Indicate that we wish to use a BD score.
"
%feature("docstring") gum::IApproximationSchemeConfiguration::useScoreBDeu
"
Warnings
--------
A Faire
Indicate that we wish to use a BDeu score.
"
%feature("docstring") gum::IApproximationSchemeConfiguration::useScoreBIC
"
Warnings
--------
A Faire
Indicate that we wish to use a BIC score.
"
%feature("docstring") gum::IApproximationSchemeConfiguration::useScoreK2
"
Warnings
--------
A Faire
Indicate that we wish to use a K2 score.
"
%feature("docstring") gum::IApproximationSchemeConfiguration::useScoreLog2Likelihood
"
Warnings
--------
A Faire
Indicate that we wish to use a Log2Likelihood score.
"
%feature("docstring") gum::IApproximationSchemeConfiguration::verbosity
"
Warnings
--------
A Faire
Returns
-------
bool
True if the verbosity is enabled
"
\ No newline at end of file
......@@ -2,7 +2,6 @@
%ignore gum::DisceteVariable::label;
%ignore gum::DisceteVariable::index;
%feature("docstring") gum::LabelizedVariable
"
LabelizedVariable is a discrete random variable with a customizable sequence of labels.
......@@ -57,6 +56,25 @@ Examples
>>> ## 'B'
"
%feature("docstring") gum::LabelizedVariable::addLabel
"
Add a label with a new index (we assume that we will NEVER remove a label).
Parameters
----------
aLabel : str
the label to be added to the labelized variable
Returns
-------
pyAgrum.LabelizedVariable
the labelized variable
Warnings
--------
DuplicateElement raised is raised if the variable already contains the label
"
%feature("docstring") gum::LabelizedVariable::changeLabel
"
Change the label at the specified index
......
Problèmes de type dans les signatures
-------------------------------------
gum::Idx -> int
gum::Size -> int
gum::NodeSet -> set
Problèmes d'exceptions
----------------------
RangeVar.setMinVal(new_minval) (resp. setMaxVal(new_maxval)) ne renvoie pas d'erreur si new_minval>maxval (resp. new_maxval<minval)
\ No newline at end of file
......@@ -7,16 +7,4 @@
def __getitem__(self,label): # adding the y() function here
return self.index(label)
%}
}
%feature("shadow") gum::LabelizedVariable::addLabel(const std::string aLabel) %{
def addLabel(self,*args):
$action(self,*args)
return self
%}
%feature("shadow") gum::DiscretizedVariable<double>::addTick(const double& aTick) %{
def addTick(self,*args):
$action(self,*args)
return self
%}
}
\ No newline at end of file
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