diff --git a/doc/Normalize.rst b/doc/Normalize.rst index 8838807..f090ef7 100644 --- a/doc/Normalize.rst +++ b/doc/Normalize.rst @@ -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: @@ -23,7 +22,7 @@ :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: @@ -31,7 +30,7 @@ :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: @@ -39,7 +38,7 @@ :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: @@ -47,4 +46,4 @@ :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`