@@ -41,7 +41,7 @@ General Concepts
41
41
contributor documentation <api_overview>`.
42
42
43
43
The specific interfaces that constitute Scikit-learn's public API are
44
- largely documented in :ref: `api_ref `. However we less formally consider
44
+ largely documented in :ref: `api_ref `. However, we less formally consider
45
45
anything as public API if none of the identifiers required to access it
46
46
begins with ``_ ``. We generally try to maintain :term: `backwards
47
47
compatibility ` for all objects in the public API.
@@ -106,12 +106,12 @@ General Concepts
106
106
are documented under an estimator's *Parameters * documentation.
107
107
108
108
backwards compatibility
109
- We generally try to maintain backwards compatibility (i.e. interfaces
109
+ We generally try to maintain backward compatibility (i.e. interfaces
110
110
and behaviors may be extended but not changed or removed) from release
111
111
to release but this comes with some exceptions:
112
112
113
113
Public API only
114
- The behaviour of objects accessed through private identifiers
114
+ The behavior of objects accessed through private identifiers
115
115
(those beginning ``_ ``) may be changed arbitrarily between
116
116
versions.
117
117
As documented
@@ -145,8 +145,8 @@ General Concepts
145
145
assumed but not formally tested.
146
146
147
147
Despite this informal contract with our users, the software is provided
148
- as is, as stated in the licence . When a release inadvertently
149
- introduces changes that are not backwards compatible, these are known
148
+ as is, as stated in the license . When a release inadvertently
149
+ introduces changes that are not backward compatible, these are known
150
150
as software regressions.
151
151
152
152
callable
@@ -647,7 +647,7 @@ General Concepts
647
647
first axis and a fixed, finite set of :term: `features ` on the second
648
648
is called rectangular.
649
649
650
- This term excludes samples with non-vectorial structure , such as text,
650
+ This term excludes samples with non-vectorial structures , such as text,
651
651
an image of arbitrary size, a time series of arbitrary length, a set of
652
652
vectors, etc. The purpose of a :term: `vectorizer ` is to produce
653
653
rectangular forms of such data.
@@ -684,7 +684,7 @@ General Concepts
684
684
versions happen via a :ref: `SLEP <slep >` and follows the
685
685
decision-making process outlined in :ref: `governance `.
686
686
For all votes, a proposal must have been made public and discussed before the
687
- vote. Such proposal must be a consolidated document, in the form of a
687
+ vote. Such a proposal must be a consolidated document, in the form of a
688
688
‘Scikit-Learn Enhancement Proposal’ (SLEP), rather than a long discussion on an
689
689
issue. A SLEP must be submitted as a pull-request to
690
690
`enhancement proposals <https://scikit-learn-enhancement-proposals.readthedocs.io >`_ using the
@@ -881,12 +881,12 @@ Class APIs and Estimator Types
881
881
In a meta-estimator's :term: `fit ` method, any contained estimators
882
882
should be :term: `cloned ` before they are fit (although FIXME: Pipeline
883
883
and FeatureUnion do not do this currently). An exception to this is
884
- that an estimator may explicitly document that it accepts a prefitted
884
+ that an estimator may explicitly document that it accepts a pre-fitted
885
885
estimator (e.g. using ``prefit=True `` in
886
886
:class: `feature_selection.SelectFromModel `). One known issue with this
887
- is that the prefitted estimator will lose its model if the
887
+ is that the pre-fitted estimator will lose its model if the
888
888
meta-estimator is cloned. A meta-estimator should have ``fit `` called
889
- before prediction, even if all contained estimators are prefitted .
889
+ before prediction, even if all contained estimators are pre-fitted .
890
890
891
891
In cases where a meta-estimator's primary behaviors (e.g.
892
892
:term: `predict ` or :term: `transform ` implementation) are functions of
@@ -1008,7 +1008,7 @@ Target Types
1008
1008
1009
1009
binary
1010
1010
A classification problem consisting of two classes. A binary target
1011
- may represented as for a :term: `multiclass ` problem but with only two
1011
+ may be represented as for a :term: `multiclass ` problem but with only two
1012
1012
labels. A binary decision function is represented as a 1d array.
1013
1013
1014
1014
Semantically, one class is often considered the "positive" class.
@@ -1028,7 +1028,7 @@ Target Types
1028
1028
1029
1029
continuous
1030
1030
A regression problem where each sample's target is a finite floating
1031
- point number, represented as a 1-dimensional array of floats (or
1031
+ point number represented as a 1-dimensional array of floats (or
1032
1032
sometimes ints).
1033
1033
1034
1034
:func: `~utils.multiclass.type_of_target ` will return 'continuous' for
@@ -1078,7 +1078,7 @@ Target Types
1078
1078
A classification problem where each sample's target consists of
1079
1079
``n_outputs `` :term: `outputs `, each a class label, for a fixed int
1080
1080
``n_outputs > 1 `` in a particular dataset. Each output has a
1081
- fixed set of available classes, and each sample is labelled with a
1081
+ fixed set of available classes, and each sample is labeled with a
1082
1082
class for each output. An output may be binary or multiclass, and in
1083
1083
the case where all outputs are binary, the target is
1084
1084
:term: `multilabel `.
@@ -1213,10 +1213,10 @@ Methods
1213
1213
and ``transform `` separately would be less efficient than together.
1214
1214
:class: `base.TransformerMixin ` provides a default implementation,
1215
1215
providing a consistent interface across transformers where
1216
- ``fit_transform `` is or is not specialised .
1216
+ ``fit_transform `` is or is not specialized .
1217
1217
1218
1218
In :term: `inductive ` learning -- where the goal is to learn a
1219
- generalised model that can be applied to new data -- users should be
1219
+ generalized model that can be applied to new data -- users should be
1220
1220
careful not to apply ``fit_transform `` to the entirety of a dataset
1221
1221
(i.e. training and test data together) before further modelling, as
1222
1222
this results in :term: `data leakage `.
@@ -1225,7 +1225,7 @@ Methods
1225
1225
Primarily for :term: `feature extractors `, but also used for other
1226
1226
transformers to provide string names for each column in the output of
1227
1227
the estimator's :term: `transform ` method. It outputs a list of
1228
- strings, and may take a list of strings as input, corresponding
1228
+ strings and may take a list of strings as input, corresponding
1229
1229
to the names of input columns from which output column names can
1230
1230
be generated. By default input features are named x0, x1, ....
1231
1231
@@ -1250,7 +1250,7 @@ Methods
1250
1250
``partial_fit ``
1251
1251
Facilitates fitting an estimator in an online fashion. Unlike ``fit ``,
1252
1252
repeatedly calling ``partial_fit `` does not clear the model, but
1253
- updates it with respect to the data provided. The portion of data
1253
+ updates it with the data provided. The portion of data
1254
1254
provided to ``partial_fit `` may be called a mini-batch.
1255
1255
Each mini-batch must be of consistent shape, etc. In iterative
1256
1256
estimators, ``partial_fit `` often only performs a single iteration.
@@ -1322,7 +1322,7 @@ Methods
1322
1322
to facilitate numerical stability.
1323
1323
1324
1324
``predict_proba ``
1325
- A method in :term: `classifiers ` and :term: `clusterers ` that are able to
1325
+ A method in :term: `classifiers ` and :term: `clusterers ` that can
1326
1326
return probability estimates for each class/cluster. Its input is
1327
1327
usually only some observed data, :term: `X `.
1328
1328
@@ -1381,7 +1381,7 @@ Methods
1381
1381
In a :term: `transformer `, transforms the input, usually only :term: `X `,
1382
1382
into some transformed space (conventionally notated as :term: `Xt `).
1383
1383
Output is an array or sparse matrix of length :term: `n_samples ` and
1384
- with number of columns fixed after :term: `fitting `.
1384
+ with the number of columns fixed after :term: `fitting `.
1385
1385
1386
1386
If the estimator was not already :term: `fitted `, calling this method
1387
1387
should raise a :class: `exceptions.NotFittedError `.
@@ -1405,8 +1405,8 @@ functions or non-estimator constructors.
1405
1405
:term: `multioutput ` (including :term: `multilabel `) tasks, the weights
1406
1406
are multiplied across outputs (i.e. columns of ``y ``).
1407
1407
1408
- By default all samples have equal weight such that classes are
1409
- effectively weighted by their their prevalence in the training data.
1408
+ By default, all samples have equal weight such that classes are
1409
+ effectively weighted by their prevalence in the training data.
1410
1410
This could be achieved explicitly with ``class_weight={label1: 1,
1411
1411
label2: 1, ...} `` for all class labels.
1412
1412
@@ -1581,10 +1581,11 @@ functions or non-estimator constructors.
1581
1581
in the User Guide.
1582
1582
1583
1583
Where multiple metrics can be evaluated, ``scoring `` may be given
1584
- either as a list of unique strings or a dict with names as keys and
1585
- callables as values. Note that this does *not * specify which score
1586
- function is to be maximised, and another parameter such as ``refit ``
1587
- may be used for this purpose.
1584
+ either as a list of unique strings or a dictionary with names as keys
1585
+ and callables as values. Note that this does *not * specify which score
1586
+ function is to be maximized, and another parameter such as ``refit ``
1587
+ maybe used for this purpose.
1588
+
1588
1589
1589
1590
The ``scoring `` parameter is validated and interpreted using
1590
1591
:func: `metrics.check_scoring `.
@@ -1604,9 +1605,9 @@ functions or non-estimator constructors.
1604
1605
When fitting an estimator repeatedly on the same dataset, but for
1605
1606
multiple parameter values (such as to find the value maximizing
1606
1607
performance as in :ref: `grid search <grid_search >`), it may be possible
1607
- to reuse aspects of the model learnt from the previous parameter value,
1608
+ to reuse aspects of the model learned from the previous parameter value,
1608
1609
saving time. When ``warm_start `` is true, the existing :term: `fitted `
1609
- model :term: `attributes ` are used to initialise the new model
1610
+ model :term: `attributes ` are used to initialize the new model
1610
1611
in a subsequent call to :term: `fit `.
1611
1612
1612
1613
Note that this is only applicable for some models and some
@@ -1701,8 +1702,8 @@ See concept :term:`sample property`.
1701
1702
.. glossary ::
1702
1703
1703
1704
``groups ``
1704
- Used in cross validation routines to identify samples which are
1705
- correlated. Each value is an identifier such that, in a supporting
1705
+ Used in cross- validation routines to identify samples that are correlated.
1706
+ Each value is an identifier such that, in a supporting
1706
1707
:term: `CV splitter `, samples from some ``groups `` value may not
1707
1708
appear in both a training set and its corresponding test set.
1708
1709
See :ref: `group_cv `.
0 commit comments