DOC Improve docs of BaseLabelPropagation.transduction_ #24985
Conversation
| @@ -105,6 +105,34 @@ class BaseLabelPropagation(ClassifierMixin, BaseEstimator, metaclass=ABCMeta): | |||
| ``None`` means 1 unless in a :obj:`joblib.parallel_backend` context. | |||
| ``-1`` means using all processors. See :term:`Glossary <n_jobs>` | |||
| for more details. | |||
|
|
|||
| Attributes | |||
There was a problem hiding this comment.
I don't know what the convention is -> unsure if the extra docs on BaseLabelPropagation make sense as users can't directly import/access this class.
Does someone know?
There was a problem hiding this comment.
Traditionally, we only include Attribute docs for public classes. For example, BaseDecisionTree does not include any docs for Attributes because it is private:
scikit-learn/sklearn/tree/_classes.py
Line 90 in 75db1bc
In this case, since BaseLabelPropagation is a private class, I would not include the Attributes section here.
There was a problem hiding this comment.
Done. Thanks!
| @@ -105,6 +105,34 @@ class BaseLabelPropagation(ClassifierMixin, BaseEstimator, metaclass=ABCMeta): | |||
| ``None`` means 1 unless in a :obj:`joblib.parallel_backend` context. | |||
| ``-1`` means using all processors. See :term:`Glossary <n_jobs>` | |||
| for more details. | |||
|
|
|||
| Attributes | |||
There was a problem hiding this comment.
Traditionally, we only include Attribute docs for public classes. For example, BaseDecisionTree does not include any docs for Attributes because it is private:
scikit-learn/sklearn/tree/_classes.py
Line 90 in 75db1bc
In this case, since BaseLabelPropagation is a private class, I would not include the Attributes section here.
thomasjpfan
changed the title
|
LGTM. Thanks @scottgigante-immunai |
The relationship between
fitandtransduction_is not super clear. This PR improves the documentation around that. Closes #24898.