From 4c93c49e58d67de23cddacaf4fd80085835796b0 Mon Sep 17 00:00:00 2001 From: James Bradbury Date: Thu, 10 Feb 2022 13:37:31 +0000 Subject: [PATCH 1/3] update normalize entry --- doc/Normalize.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/Normalize.rst b/doc/Normalize.rst index 8838807..5b3c71d 100644 --- a/doc/Normalize.rst +++ b/doc/Normalize.rst @@ -2,7 +2,7 @@ :species: data :sc-categories: FluidManipulation :sc-related: Classes/FluidStandardize, Classes/FluidDataSet -:see-also: +:see-also: Standardize, RobustScale :description: Normalize the entries of a :fluid-obj:`DataSet`, or normalize a data point according to the learned bounds of a data set. @@ -23,7 +23,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 +31,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 +39,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 +47,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` From 456786255f450f42d7c96b53231a9b034cb20560 Mon Sep 17 00:00:00 2001 From: James Bradbury Date: Thu, 10 Feb 2022 13:38:55 +0000 Subject: [PATCH 2/3] update description --- doc/Normalize.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/Normalize.rst b/doc/Normalize.rst index 5b3c71d..ea264e3 100644 --- a/doc/Normalize.rst +++ b/doc/Normalize.rst @@ -3,7 +3,7 @@ :sc-categories: FluidManipulation :sc-related: Classes/FluidStandardize, Classes/FluidDataSet :see-also: Standardize, RobustScale -:description: Normalize the entries of a :fluid-obj:`DataSet`, or normalize a data point according to the learned bounds of a data set. +:description: Normalize a :fluid-obj:`DataSet` according to learned minimum and maximum values. :control min: From 2d304b859630ff456f819159735ced26a8f1ada3 Mon Sep 17 00:00:00 2001 From: James Bradbury Date: Thu, 24 Mar 2022 11:29:00 +0000 Subject: [PATCH 3/3] pa's requests --- doc/Normalize.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/Normalize.rst b/doc/Normalize.rst index ea264e3..f090ef7 100644 --- a/doc/Normalize.rst +++ b/doc/Normalize.rst @@ -3,8 +3,7 @@ :sc-categories: FluidManipulation :sc-related: Classes/FluidStandardize, Classes/FluidDataSet :see-also: Standardize, RobustScale -:description: Normalize a :fluid-obj:`DataSet` according to learned minimum and maximum values. - +:description: Normalize a :fluid-obj:`DataSet` or single point of data according to learnt minimum and maximum values. :control min: