Skip to content
This repository was archived by the owner on Nov 16, 2023. It is now read-only.

Fix broken docs #369

Merged
merged 3 commits into from
Nov 21, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/python/docs/docstrings/Dart.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
<https://arxiv.org/abs/1505.01866>`_ is an
ensemble method of boosted regression trees. The Dropouts meet
Multiple Additive Regression
Trees (DART) employs dropouts in MART and overcomes the issues of over-
Trees (DART) employs dropouts in MART and overcomes the issues of over-
specialization of MART,
achiving better performance in many tasks.
achieving better performance in many tasks.


**Reference**
Expand Down
2 changes: 1 addition & 1 deletion src/python/docs/docstrings/FastLinearBinaryClassifier.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""

A Stochastic Dual Coordinate Ascent (SDCA) optimization trainer
for linear binary classification and regression.
for linear binary classification.

.. remarks::
``FastLinearBinaryClassifier`` is a trainer based on the Stochastic
Expand Down
3 changes: 2 additions & 1 deletion src/python/docs/docstrings/FastLinearClassifier.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""

Train an SDCA multi class model
A Stochastic Dual Coordinate Ascent (SDCA) optimization trainer for
multi class classification.

.. remarks::
``FastLinearClassifier`` is a trainer based on the Stochastic Dual
Expand Down
2 changes: 1 addition & 1 deletion src/python/docs/docstrings/FastLinearRegressor.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""

A Stochastic Dual Coordinate Ascent (SDCA) optimization trainer
for linear binary classification and regression.
for linear regression.

.. remarks::
``FastLinearRegressor`` is a trainer based on the Stochastic Dual
Expand Down
3 changes: 1 addition & 2 deletions src/python/docs/docstrings/FromKey.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
"""

Text transforms that can be performed on data before training
a model.
Converts the key types back to their original values.

.. remarks::
The ``FromKey`` transform converts a column of keys, generated using
Expand Down
4 changes: 2 additions & 2 deletions src/python/docs/docstrings/Goss.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
.. remarks::
Gradient-based One-Side Sampling (GOSS) employs an adaptive sampling
named gradient-based
sampling. For datasets with large sample size, GOSS has considerable
sampling. For datasets with large sample size, GOSS has considerable
advantage in terms of
statistical and computational efficiency.
statistical and computational efficiency.



Expand Down
15 changes: 7 additions & 8 deletions src/python/docs/docstrings/Handler.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,13 @@
For more details see `Columns </nimbusml/concepts/columns>`_.

:param replace_with: The method to use to replace NaN values. The
following choices are available.

* Def: Replace with default value of that type, usually ``0``. If no
replace
method is specified, this is the default strategy.
* Mean: Replace NaN values with the mean of the values in that column.
* Min: Replace with minimum value in the column.
* Max: Replace with maximum value in the column.
following choices are available.

* Def: Replace with default value of that type, usually ``0``. If no
replace method is specified, this is the default strategy.
* Mean: Replace NaN values with the mean of the values in that column.
* Min: Replace with minimum value in the column.
* Max: Replace with maximum value in the column.

.. seealso::
:py:class:`Filter <nimbusml.preprocessing.missing_values.Filter>`,
Expand Down
2 changes: 1 addition & 1 deletion src/python/docs/docstrings/Loader.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""

Loaders image data.
Loads image data.

.. remarks::
``Loader`` loads images from paths.
Expand Down
2 changes: 1 addition & 1 deletion src/python/docs/docstrings/NGram.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""

Extracts NGrams from text and convert them to vector using
Extracts NGrams from text and converts them to vector using
dictionary.

.. remarks::
Expand Down
2 changes: 1 addition & 1 deletion src/python/docs/docstrings/NgramHash.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""

Extracts NGrams from text and convert them to vector using hashing
Extracts NGrams from text and converts them to vector using hashing
trick.

.. remarks::
Expand Down
6 changes: 3 additions & 3 deletions src/python/docs/docstrings/Resizer.txt
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
"""

Resizers an image to a specified dimension using a specified
Resizes an image to a specified dimension using a specified
resizing method.

.. remarks::
``Resizer`` resizers an image to the specified height and width
``Resizer`` resizes an image to the specified height and width
using a specified resizing method. The input variables to this
transforms must
be images, typically the result of the ``Loader`` transform.

:param columns: a dictionary of key-value pairs, where key is the output
:param columns: A dictionary of key-value pairs, where key is the output
column name and value is the input column name.

* Multiple key-value pairs are allowed.
Expand Down
3 changes: 1 addition & 2 deletions src/python/docs/docstrings/ToKey.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
"""

Text transforms that can be performed on data before training
a model.
Converts input values (words, numbers, etc.) to index in a dictionary.

.. remarks::
The ``ToKey`` transform converts a column of text to key values
Expand Down
4 changes: 2 additions & 2 deletions src/python/nimbusml/ensemble/booster/dart.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ class Dart(core):
<https://arxiv.org/abs/1505.01866>`_ is an
ensemble method of boosted regression trees. The Dropouts meet
Multiple Additive Regression
Trees (DART) employs dropouts in MART and overcomes the issues of over-
Trees (DART) employs dropouts in MART and overcomes the issues of over-
specialization of MART,
achiving better performance in many tasks.
achieving better performance in many tasks.


**Reference**
Expand Down
4 changes: 2 additions & 2 deletions src/python/nimbusml/ensemble/booster/goss.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ class Goss(core):
.. remarks::
Gradient-based One-Side Sampling (GOSS) employs an adaptive sampling
named gradient-based
sampling. For datasets with large sample size, GOSS has considerable
sampling. For datasets with large sample size, GOSS has considerable
advantage in terms of
statistical and computational efficiency.
statistical and computational efficiency.



Expand Down
2 changes: 1 addition & 1 deletion src/python/nimbusml/feature_extraction/image/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
class Loader(core, BaseTransform, TransformerMixin):
"""

Loaders image data.
Loads image data.

.. remarks::
``Loader`` loads images from paths.
Expand Down
6 changes: 3 additions & 3 deletions src/python/nimbusml/feature_extraction/image/resizer.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@
class Resizer(core, BaseTransform, TransformerMixin):
"""

Resizers an image to a specified dimension using a specified
Resizes an image to a specified dimension using a specified
resizing method.

.. remarks::
``Resizer`` resizers an image to the specified height and width
``Resizer`` resizes an image to the specified height and width
using a specified resizing method. The input variables to this
transforms must
be images, typically the result of the ``Loader`` transform.

:param columns: a dictionary of key-value pairs, where key is the output
:param columns: A dictionary of key-value pairs, where key is the output
column name and value is the input column name.

* Multiple key-value pairs are allowed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
class Ngram(core):
"""

Extracts NGrams from text and convert them to vector using
Extracts NGrams from text and converts them to vector using
dictionary.

.. remarks::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
class NgramHash(core):
"""

Extracts NGrams from text and convert them to vector using hashing
Extracts NGrams from text and converts them to vector using hashing
trick.

.. remarks::
Expand Down
4 changes: 2 additions & 2 deletions src/python/nimbusml/internal/core/ensemble/booster/dart.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ class Dart(Component):
<https://arxiv.org/abs/1505.01866>`_ is an
ensemble method of boosted regression trees. The Dropouts meet
Multiple Additive Regression
Trees (DART) employs dropouts in MART and overcomes the issues of over-
Trees (DART) employs dropouts in MART and overcomes the issues of over-
specialization of MART,
achiving better performance in many tasks.
achieving better performance in many tasks.


**Reference**
Expand Down
4 changes: 2 additions & 2 deletions src/python/nimbusml/internal/core/ensemble/booster/goss.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ class Goss(Component):
.. remarks::
Gradient-based One-Side Sampling (GOSS) employs an adaptive sampling
named gradient-based
sampling. For datasets with large sample size, GOSS has considerable
sampling. For datasets with large sample size, GOSS has considerable
advantage in terms of
statistical and computational efficiency.
statistical and computational efficiency.



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
class Loader(BasePipelineItem, DefaultSignature):
"""

Loaders image data.
Loads image data.

.. remarks::
``Loader`` loads images from paths.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@
class Resizer(BasePipelineItem, DefaultSignature):
"""

Resizers an image to a specified dimension using a specified
Resizes an image to a specified dimension using a specified
resizing method.

.. remarks::
``Resizer`` resizers an image to the specified height and width
``Resizer`` resizes an image to the specified height and width
using a specified resizing method. The input variables to this
transforms must
be images, typically the result of the ``Loader`` transform.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
class Ngram(Component):
"""

Extracts NGrams from text and convert them to vector using
Extracts NGrams from text and converts them to vector using
dictionary.

.. remarks::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
class NgramHash(Component):
"""

Extracts NGrams from text and convert them to vector using hashing
Extracts NGrams from text and converts them to vector using hashing
trick.

.. remarks::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class FastLinearBinaryClassifier(
"""

A Stochastic Dual Coordinate Ascent (SDCA) optimization trainer
for linear binary classification and regression.
for linear binary classification.

.. remarks::
``FastLinearBinaryClassifier`` is a trainer based on the Stochastic
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ class FastLinearClassifier(
DefaultSignatureWithRoles):
"""

Train an SDCA multi class model
A Stochastic Dual Coordinate Ascent (SDCA) optimization trainer for
multi class classification.

.. remarks::
``FastLinearClassifier`` is a trainer based on the Stochastic Dual
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class FastLinearRegressor(
"""

A Stochastic Dual Coordinate Ascent (SDCA) optimization trainer
for linear binary classification and regression.
for linear regression.

.. remarks::
``FastLinearRegressor`` is a trainer based on the Stochastic Dual
Expand Down
3 changes: 1 addition & 2 deletions src/python/nimbusml/internal/core/preprocessing/fromkey.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@
class FromKey(BasePipelineItem, DefaultSignature):
"""

Text transforms that can be performed on data before training
a model.
Converts the key types back to their original values.

.. remarks::
The ``FromKey`` transform converts a column of keys, generated using
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,13 @@ class Handler(BasePipelineItem, DefaultSignature):
were imputed. This works for columns that have numeric type.

:param replace_with: The method to use to replace NaN values. The
following choices are available.

* Def: Replace with default value of that type, usually ``0``. If no
replace
method is specified, this is the default strategy.
* Mean: Replace NaN values with the mean of the values in that column.
* Min: Replace with minimum value in the column.
* Max: Replace with maximum value in the column.
following choices are available.

* Def: Replace with default value of that type, usually ``0``. If no
replace method is specified, this is the default strategy.
* Mean: Replace NaN values with the mean of the values in that column.
* Min: Replace with minimum value in the column.
* Max: Replace with maximum value in the column.

:param impute_by_slot: Whether to impute values by slot.

Expand Down
3 changes: 1 addition & 2 deletions src/python/nimbusml/internal/core/preprocessing/tokey.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@
class ToKey(BasePipelineItem, DefaultSignature):
"""

Text transforms that can be performed on data before training
a model.
Converts input values (words, numbers, etc.) to index in a dictionary.

.. remarks::
The ``ToKey`` transform converts a column of text to key values
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class FastLinearBinaryClassifier(
"""

A Stochastic Dual Coordinate Ascent (SDCA) optimization trainer
for linear binary classification and regression.
for linear binary classification.

.. remarks::
``FastLinearBinaryClassifier`` is a trainer based on the Stochastic
Expand Down
3 changes: 2 additions & 1 deletion src/python/nimbusml/linear_model/fastlinearclassifier.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
class FastLinearClassifier(core, BasePredictor, ClassifierMixin):
"""

Train an SDCA multi class model
A Stochastic Dual Coordinate Ascent (SDCA) optimization trainer for
multi class classification.

.. remarks::
``FastLinearClassifier`` is a trainer based on the Stochastic Dual
Expand Down
2 changes: 1 addition & 1 deletion src/python/nimbusml/linear_model/fastlinearregressor.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class FastLinearRegressor(core, BasePredictor, RegressorMixin):
"""

A Stochastic Dual Coordinate Ascent (SDCA) optimization trainer
for linear binary classification and regression.
for linear regression.

.. remarks::
``FastLinearRegressor`` is a trainer based on the Stochastic Dual
Expand Down
2 changes: 1 addition & 1 deletion src/python/nimbusml/model_selection/cv.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ class CV:
the average of each metric on all models.

:param pipeline: Pipeline object or a list of pipeline steps that's
used for cross validation
used for cross validation
'''

fold_column_name = 'Fold'
Expand Down
4 changes: 2 additions & 2 deletions src/python/nimbusml/pipeline.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,10 @@ class Pipeline:
for more details on how to select these.

:param steps: the list of operator or (name, operator) tuples that
are chained in the appropriate order.
are chained in the appropriate order.

:param model: the path to the model file (".zip") if want to load a
model directly from file (such as a trained model from ML.NET).
model directly from file (such as a trained model from ML.NET).

:param random_state: the integer used as the random seed.

Expand Down
3 changes: 1 addition & 2 deletions src/python/nimbusml/preprocessing/fromkey.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@
class FromKey(core, BaseTransform, TransformerMixin):
"""

Text transforms that can be performed on data before training
a model.
Converts the key types back to their original values.

.. remarks::
The ``FromKey`` transform converts a column of keys, generated using
Expand Down
Loading