.. _l-properties:

Properties
==========

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| property                                                                                 | class parent            | truncated documentation                                                                                          |
+==========================================================================================+=========================+==================================================================================================================+
| :meth:`Appendix <mlstatpy.ml.ml_grid_benchmark.MlGridBenchMark.Appendix>`                | MlGridBenchMark         | Returns the metrics.                                                                                             |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`Data <mlstatpy.ml.roc.ROC.Data>`                                                  | ROC                     | Returns the underlying dataframe.                                                                                |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`Graphs <mlstatpy.ml.ml_grid_benchmark.MlGridBenchMark.Graphs>`                    | MlGridBenchMark         | Returns images of graphs.                                                                                        |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`Label <mlstatpy.graph.graph_distance.Edge.Label>`                                 | Edge                    | returns the label                                                                                                |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`Label <mlstatpy.graph.graph_distance.Vertex.Label>`                               | Vertex                  | returns the label                                                                                                |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`Metadata <mlstatpy.ml.ml_grid_benchmark.MlGridBenchMark.Metadata>`                | MlGridBenchMark         | Returns the metrics.                                                                                             |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`Metrics <mlstatpy.ml.ml_grid_benchmark.MlGridBenchMark.Metrics>`                  | MlGridBenchMark         | Returns the metrics.                                                                                             |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`Name <mlstatpy.ml.ml_grid_benchmark.MlGridBenchMark.Name>`                        | MlGridBenchMark         | Returns the name of the benchmark.                                                                               |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlstatpy.ml.neural_tree.BaseNeuralTreeNet._repr_html_>`           | BaseNeuralTreeNet       | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ... |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlstatpy.ml.neural_tree.NeuralTreeNetClassifier._repr_html_>`     | NeuralTreeNetClassifier | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ... |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlstatpy.ml.neural_tree.NeuralTreeNetRegressor._repr_html_>`      | NeuralTreeNetRegressor  | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ... |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`bias <mlstatpy.ml._neural_tree_node.NeuralTreeNode.bias>`                         | NeuralTreeNode          | Returns the weights.                                                                                             |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`input_weights <mlstatpy.ml._neural_tree_node.NeuralTreeNode.input_weights>`       | NeuralTreeNode          | Returns the weights.                                                                                             |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`ndim <mlstatpy.ml._neural_tree_node.NeuralTreeNode.ndim>`                         | NeuralTreeNode          | Returns the input dimension.                                                                                     |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`ndim_out <mlstatpy.ml._neural_tree_node.NeuralTreeNode.ndim_out>`                 | NeuralTreeNode          | Returns the output dimension.                                                                                    |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`root <mlstatpy.nlp.completion.CompletionTrieNode.root>`                           | CompletionTrieNode      | Returns the initial node with no parent.                                                                         |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`shape <mlstatpy.ml.kppv.NuagePoints.shape>`                                       | NuagePoints             | Retourne la dimension du nuage.                                                                                  |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`shape <mlstatpy.ml.kppv_laesa.NuagePointsLaesa.shape>`                            | NuagePointsLaesa        | Retourne la dimension du nuage.                                                                                  |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`shape <mlstatpy.ml.neural_tree.NeuralTreeNet.shape>`                              | NeuralTreeNet           | Returns the shape of the coefficients.                                                                           |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`training_weights <mlstatpy.ml._neural_tree_api._TrainingAPI.training_weights>`    | _TrainingAPI            | Returns the weights.                                                                                             |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`training_weights <mlstatpy.ml._neural_tree_node.NeuralTreeNode.training_weights>` | NeuralTreeNode          | Returns the weights stored in the neuron.                                                                        |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+
| :meth:`training_weights <mlstatpy.ml.neural_tree.NeuralTreeNet.training_weights>`        | NeuralTreeNet           | Returns the weights.                                                                                             |
+------------------------------------------------------------------------------------------+-------------------------+------------------------------------------------------------------------------------------------------------------+