Skip to content

[Docs] Update Normalize Docs #76

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 3 commits into from
Mar 24, 2022
Merged

[Docs] Update Normalize Docs #76

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c93c49
update normalize entry
Feb 10, 2022
4567862
update description
Feb 10, 2022
2d304b8
pa's requests
Mar 24, 2022
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
13 changes: 6 additions & 7 deletions doc/Normalize.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
:species: data
:sc-categories: FluidManipulation
:sc-related: Classes/FluidStandardize, Classes/FluidDataSet
:see-also:
:description: Normalize the entries of a :fluid-obj:`DataSet`, or normalize a data point according to the learned bounds of a data set.

:see-also: Standardize, RobustScale
:description: Normalize a :fluid-obj:`DataSet` or single point of data according to learnt minimum and maximum values.

:control min:

Expand All @@ -23,28 +22,28 @@

:arg dataSet: The :fluid-obj:`DataSet` to normalize

Compute the normalization factors from a :fluid-obj:`DataSet` for later.
Compute the normalization factors from a :fluid-obj:`DataSet` and store them internally.

:message transform:

:arg sourceDataSet: The :fluid-obj:`DataSet` to normalize

:arg destDataSet: The :fluid-obj:`DataSet` to populate with normalized data

Normalize a :fluid-obj:`DataSet` into another :fluid-obj:`DataSet`, using the learned extrema from a previous call to :fluid-obj:`Normalize#fit`
Transform a :fluid-obj:`DataSet` using learned extrema from :fluid-obj:`Normalize#fit` and copy the results to the destination :fluid-obj:`DataSet`.

:message fitTransform:

:arg sourceDataSet: The :fluid-obj:`DataSet` to normalize

:arg destDataSet: The :fluid-obj:`DataSet` to populate with normalized data

Normalize a :fluid-obj:`DataSet`
Normalize a :fluid-obj:`DataSet` and copy the results to :fluid-obj:`DataSet`.

:message transformPoint:

:arg sourceBuffer: A |buffer| with the new data point

:arg destBuffer: A |buffer| to contain the normalized value

Normalize a new data point, using the learned extrema from a previous call to :fluid-obj:`Normalize#fit`
Normalize a single data point, using the learned extrema from a previous call to :fluid-obj:`Normalize#fit`