Skip to content

Commit a303122

Browse files
authored
DOC: Remove FIXME tags from glossary (scikit-learn#31677)
1 parent 2520ceb commit a303122

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

doc/glossary.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -940,8 +940,11 @@ Class APIs and Estimator Types
940940
:class:`ensemble.BaggingClassifier`.
941941

942942
In a meta-estimator's :term:`fit` method, any contained estimators
943-
should be :term:`cloned` before they are fit (although FIXME: Pipeline
944-
and FeatureUnion do not do this currently). An exception to this is
943+
should be :term:`cloned` before they are fit.
944+
945+
.. FIXME: Pipeline and FeatureUnion do not do this currently
946+
947+
An exception to this is
945948
that an estimator may explicitly document that it accepts a pre-fitted
946949
estimator (e.g. using ``prefit=True`` in
947950
:class:`feature_selection.SelectFromModel`). One known issue with this
@@ -1590,8 +1593,7 @@ functions or non-estimator constructors.
15901593
estimators: some, but not all, use it to mean a single epoch (i.e. a
15911594
pass over every sample in the data).
15921595

1593-
FIXME perhaps we should have some common tests about the relationship
1594-
between ConvergenceWarning and max_iter.
1596+
.. FIXME: perhaps we should have some common tests about the relationship between ConvergenceWarning and max_iter.
15951597
15961598
``memory``
15971599
Some estimators make use of :class:`joblib.Memory` to
@@ -1859,12 +1861,11 @@ See concept :term:`sample property`.
18591861
the weight. Weights may be specified as floats, so that sample weights
18601862
are usually equivalent up to a constant positive scaling factor.
18611863

1862-
FIXME Is this interpretation always the case in practice? We have no
1863-
common tests.
1864+
.. FIXME: Is this interpretation always the case in practice? We have no common tests.
18641865
18651866
Some estimators, such as decision trees, support negative weights.
1866-
FIXME: This feature or its absence may not be tested or documented in
1867-
many estimators.
1867+
1868+
.. FIXME: This feature or its absence may not be tested or documented in many estimators.
18681869
18691870
This is not entirely the case where other parameters of the model
18701871
consider the number of samples in a region, as with ``min_samples`` in

0 commit comments

Comments
 (0)