Skip to content

[Fix] Typos in KNNClassifier #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jamesb93 merged 1 commit into from
Jun 13, 2022
Merged

[Fix] Typos in KNNClassifier #142

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions doc/KNNClassifier.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
:sc-categories: Classification, KNN
:sc-related: Classes/FluidKNNRegressor, Classes/FluidDataSet, Classes/FluidLabelSet, Classes/MLPClassifier
:see-also:
:description: A nearest-neighbour classifier using a :fluid-obj:`KDTree` .
:description: A nearest neighbour classifier using a :fluid-obj:`KDTree` .

:discussion:

Expand Down Expand Up @@ -31,18 +31,18 @@

:message predict:

:arg dataSet: :fluid-obj:`DataSet` of data points to predict labels for
:arg dataSet: A :fluid-obj:`DataSet` of data points to predict labels for

:arg labelSet: :fluid-obj:`LabelSet` to write the predicted labels into
:arg labelSet: A :fluid-obj:`LabelSet` to write the predicted labels into

:arg action: Run when done

Given a fitted model, predict labels for a :fluid-obj:`DataSet` and write these to a :fluid-obj:`LabelSet`

:message predictPoint:

:arg buffer: A data point
:arg buffer: A data point stored in a |buffer|

:arg action: Run when done, passes predicted label as argument

Given a fitted model, predict a label for a data point in ``buffer`` and return to the caller
Given a fitted model, predict a label for a data point in |buffer| and return to the caller