Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
reidjohnson committed Sep 6, 2024
1 parent 0ff3683 commit 0cb162d
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions quantile_forest/_quantile_forest.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,7 @@ class calls the ``fit`` method of the ``ForestRegressor`` and creates a


class BaseForestQuantileRegressor(ForestRegressor):
"""
Base class for quantile regression forests.
"""Base class for quantile regression forests.
Warning: This class should not be used directly. Use derived classes
instead.
Expand Down Expand Up @@ -1105,7 +1104,7 @@ class RandomForestQuantileRegressor(BaseForestQuantileRegressor):
- If float, then `max_samples_leaf` is a fraction and
`ceil(max_samples_leaf * n_samples)` are the maximum
number of samples for each node.
- If None then unlimited number of leaf samples.
- If None, then unlimited number of leaf samples.
min_weight_fraction_leaf : float, default=0.0
The minimum weighted fraction of the sum total of weights (of all
Expand Down Expand Up @@ -1137,7 +1136,7 @@ class RandomForestQuantileRegressor(BaseForestQuantileRegressor):
max_leaf_nodes : int, default=None
Grow trees with ``max_leaf_nodes`` in best-first fashion.
Best nodes are defined as relative reduction in impurity.
If None then unlimited number of leaf nodes.
If None, then unlimited number of leaf nodes.
min_impurity_decrease : float, default=0.0
A node will be split if this split induces a decrease of the impurity
Expand Down Expand Up @@ -1234,7 +1233,8 @@ class RandomForestQuantileRegressor(BaseForestQuantileRegressor):
known as the Gini importance.
Warning: impurity-based feature importances can be misleading for
high cardinality features (many unique values).
high cardinality features (many unique values). See
:func:`sklearn.inspection.permutation_importance` as an alternative.
n_features_in_ : int
Number of features seen during :term:`fit`.
Expand Down Expand Up @@ -1448,7 +1448,7 @@ class ExtraTreesQuantileRegressor(BaseForestQuantileRegressor):
- If float, then `max_samples_leaf` is a fraction and
`ceil(max_samples_leaf * n_samples)` are the maximum
number of samples for each node.
- If None then unlimited number of leaf samples.
- If None, then unlimited number of leaf samples.
min_weight_fraction_leaf : float, default=0.0
The minimum weighted fraction of the sum total of weights (of all
Expand Down Expand Up @@ -1480,7 +1480,7 @@ class ExtraTreesQuantileRegressor(BaseForestQuantileRegressor):
max_leaf_nodes : int, default=None
Grow trees with ``max_leaf_nodes`` in best-first fashion.
Best nodes are defined as relative reduction in impurity.
If None then unlimited number of leaf nodes.
If None, then unlimited number of leaf nodes.
min_impurity_decrease : float, default=0.0
A node will be split if this split induces a decrease of the impurity
Expand Down Expand Up @@ -1580,7 +1580,8 @@ class ExtraTreesQuantileRegressor(BaseForestQuantileRegressor):
known as the Gini importance.
Warning: impurity-based feature importances can be misleading for
high cardinality features (many unique values).
high cardinality features (many unique values). See
:func:`sklearn.inspection.permutation_importance` as an alternative.
n_features_in_ : int
Number of features seen during :term:`fit`.
Expand Down

0 comments on commit 0cb162d

Please sign in to comment.