.. _l-properties:

Properties
==========

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


Summary
+++++++

+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| property                                                                                                                | class parent                        | truncated documentation                                                                                                |
+=========================================================================================================================+=====================================+========================================================================================================================+
| :meth:`Keys <mlinsights.sklapi.sklearn_parameters.SkLearnParameters.Keys>`                                              | SkLearnParameters                   | Returns parameter names.                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_estimator_type <mlinsights.mlbatch.pipeline_cache.PipelineCache._estimator_type>`                            | PipelineCache                       |                                                                                                                        |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_final_estimator <mlinsights.mlbatch.pipeline_cache.PipelineCache._final_estimator>`                          | PipelineCache                       |                                                                                                                        |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlbatch.pipeline_cache.PipelineCache._repr_html_>`                                    | PipelineCache                       | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.anmf_predictor.ApproximateNMFPredictor._repr_html_>`                          | ApproximateNMFPredictor             | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.categories_to_integers.CategoriesToIntegers._repr_html_>`                     | CategoriesToIntegers                | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.classification_kmeans.ClassifierAfterKMeans._repr_html_>`                     | ClassifierAfterKMeans               | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.decision_tree_logreg.DecisionTreeLogisticRegression._repr_html_>`             | DecisionTreeLogisticRegression      | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.extended_features.ExtendedFeatures._repr_html_>`                              | ExtendedFeatures                    | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.interval_regressor.IntervalRegressor._repr_html_>`                            | IntervalRegressor                   | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.kmeans_constraint.ConstraintKMeans._repr_html_>`                              | ConstraintKMeans                    | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.kmeans_l1.KMeansL1L2._repr_html_>`                                            | KMeansL1L2                          | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.piecewise_estimator.PiecewiseClassifier._repr_html_>`                         | PiecewiseClassifier                 | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.piecewise_estimator.PiecewiseEstimator._repr_html_>`                          | PiecewiseEstimator                  | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.piecewise_estimator.PiecewiseRegressor._repr_html_>`                          | PiecewiseRegressor                  | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.piecewise_tree_regression.PiecewiseTreeRegressor._repr_html_>`                | PiecewiseTreeRegressor              | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.predictable_tsne.PredictableTSNE._repr_html_>`                                | PredictableTSNE                     | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.quantile_mlpregressor.CustomizedMultilayerPerceptron._repr_html_>`            | CustomizedMultilayerPerceptron      | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.quantile_mlpregressor.QuantileMLPRegressor._repr_html_>`                      | QuantileMLPRegressor                | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.quantile_regression.QuantileLinearRegression._repr_html_>`                    | QuantileLinearRegression            | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.sklearn_text.TraceableCountVectorizer._repr_html_>`                           | TraceableCountVectorizer            | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.sklearn_text.TraceableTfidfVectorizer._repr_html_>`                           | TraceableTfidfVectorizer            | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.sklearn_transform_inv.BaseReciprocalTransformer._repr_html_>`                 | BaseReciprocalTransformer           | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.sklearn_transform_inv_fct.FunctionReciprocalTransformer._repr_html_>`         | FunctionReciprocalTransformer       | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.sklearn_transform_inv_fct.PermutationReciprocalTransformer._repr_html_>`      | PermutationReciprocalTransformer    | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2._repr_html_>`                  | TransformedTargetClassifier2        | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.target_predictors.TransformedTargetRegressor2._repr_html_>`                   | TransformedTargetRegressor2         | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.mlmodel.transfer_transformer.TransferTransformer._repr_html_>`                        | TransferTransformer                 | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.timeseries.ar.ARTimeSeriesRegressor._repr_html_>`                                     | ARTimeSeriesRegressor               | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.timeseries.base.BaseReciprocalTimeSeriesTransformer._repr_html_>`                     | BaseReciprocalTimeSeriesTransformer | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.timeseries.base.BaseTimeSeries._repr_html_>`                                          | BaseTimeSeries                      | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.timeseries.dummies.DummyTimeSeriesRegressor._repr_html_>`                             | DummyTimeSeriesRegressor            | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.timeseries.preprocessing.TimeSeriesDifference._repr_html_>`                           | TimeSeriesDifference                | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_repr_html_ <mlinsights.timeseries.preprocessing.TimeSeriesDifferenceInv._repr_html_>`                        | TimeSeriesDifferenceInv             | HTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should ...       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`classes_ <mlinsights.mlbatch.pipeline_cache.PipelineCache.classes_>`                                             | PipelineCache                       | The classes labels. Only exist if the last step is a classifier.                                                       |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`classes_ <mlinsights.mlmodel.target_predictors.TransformedTargetClassifier2.classes_>`                           | TransformedTargetClassifier2        | Returns the classes.                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`degree <mlinsights.timeseries.preprocessing.TimeSeriesDifference.degree>`                                        | TimeSeriesDifference                | Returns the degree.                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`feature_importances_ <mlinsights.mlmodel.piecewise_tree_regression.PiecewiseTreeRegressor.feature_importances_>` | PiecewiseTreeRegressor              | Return the feature importances. The importance of a feature is computed as the (normalized) total reduction ...        |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`feature_names_in_ <mlinsights.mlbatch.pipeline_cache.PipelineCache.feature_names_in_>`                           | PipelineCache                       | Names of features seen during first step `fit` method.                                                                 |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`idf_ <mlinsights.mlmodel.sklearn_text.TraceableTfidfVectorizer.idf_>`                                            | TraceableTfidfVectorizer            | Inverse document frequency vector, only defined if `use_idf=True`. Returns ------- ndarray of shape ...                |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`n_estimators_ <mlinsights.mlmodel.interval_regressor.IntervalRegressor.n_estimators_>`                           | IntervalRegressor                   | Returns the number of estimators = the number of buckets the data was split in.                                        |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`n_estimators_ <mlinsights.mlmodel.piecewise_estimator.PiecewiseClassifier.n_estimators_>`                        | PiecewiseClassifier                 | Returns the number of estimators = the number of buckets the data was split in.                                        |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`n_estimators_ <mlinsights.mlmodel.piecewise_estimator.PiecewiseEstimator.n_estimators_>`                         | PiecewiseEstimator                  | Returns the number of estimators = the number of buckets the data was split in.                                        |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`n_estimators_ <mlinsights.mlmodel.piecewise_estimator.PiecewiseRegressor.n_estimators_>`                         | PiecewiseRegressor                  | Returns the number of estimators = the number of buckets the data was split in.                                        |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`n_features_ <mlinsights.mlmodel.piecewise_tree_regression.PiecewiseTreeRegressor.n_features_>`                   | PiecewiseTreeRegressor              | DEPRECATED: The attribute `n_features_` is deprecated in 1.0 and will be removed in 1.2. Use `n_features_in_` instead. |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`n_features_in_ <mlinsights.mlbatch.pipeline_cache.PipelineCache.n_features_in_>`                                 | PipelineCache                       | Number of features seen during first step `fit` method.                                                                |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`named_steps <mlinsights.mlbatch.pipeline_cache.PipelineCache.named_steps>`                                       | PipelineCache                       | Access the steps by name. Read-only attribute to access any step by given name. Keys are steps names and ...           |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`tree_depth_ <mlinsights.mlmodel.decision_tree_logreg.DecisionTreeLogisticRegression.tree_depth_>`                | DecisionTreeLogisticRegression      | Returns the maximum depth of the tree.                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`tree_depth_ <mlinsights.mlmodel.decision_tree_logreg._DecisionTreeLogisticRegressionNode.tree_depth_>`           | _DecisionTreeLogisticRegressionNode | Returns the maximum depth of the tree.                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------+