Normalize / Standardize review

release-packaging/Classes/FluidNormalize.sc

@@ -9,19 +9,25 @@ FluidNormalize : FluidManipulationClient {
 		id = uid;
 	}
 
-    fit{|dataset, action|
-        this.prSendMsg(\fit,[dataset.asSymbol],action);
-    }
+	fit{|dataset, action|
+		this.prSendMsg(\fit,[dataset.asSymbol], action);
+	}
 
-	fitTransform{|dataset, action|
-        this.prSendMsg(\fit,[dataset.asSymbol],action);
-    }
+	transform{|sourceDataset, destDataset, action|
+		this.prSendMsg(\transform,
+			[sourceDataset.asSymbol, destDataset.asSymbol], action
+		);
+	}
 
-    transform{|sourceDataset, destDataset, action|
-        this.prSendMsg(\transform,[sourceDataset.asSymbol, destDataset.asSymbol],action);
-    }
+	fitTransform{|sourceDataset, destDataset, action|
+		this.prSendMsg(\fitTransform,
+			[sourceDataset.asSymbol, destDataset.asSymbol], action
+		);
+	}
 
-    transformPoint{|sourceBuffer, destBuffer, action|
-        this.prSendMsg(\transformPoint,[sourceBuffer.asUGenInput, destBuffer.asUGenInput],action);
-    }
+	transformPoint{|sourceBuffer, destBuffer, action|
+		this.prSendMsg(\transformPoint,
+			[sourceBuffer.asUGenInput, destBuffer.asUGenInput], action
+		);
+	}
 }

release-packaging/Classes/FluidStandardize.sc

@@ -9,19 +9,25 @@ FluidStandardize : FluidManipulationClient {
 		id = uid;
 	}
 
-    fit{|dataset, action|
-        this.prSendMsg(\fit,[dataset.asSymbol],action);
-    }
+	fit{|dataset, action|
+		this.prSendMsg(\fit, [dataset.asSymbol], action);
+	}
 
-    transform{|sourceDataset, destDataset, action|
-        this.prSendMsg(\transform,[sourceDataset.asSymbol, destDataset.asSymbol],action);
-    }
+	transform{|sourceDataset, destDataset, action|
+		this.prSendMsg(\transform,
+			[sourceDataset.asSymbol, destDataset.asSymbol], action
+		);
+	}
 
-	fitTransform{|dataset, action|
-        this.prSendMsg(\fitTransform,[dataset.asSymbol],action);
-    }
+	fitTransform{|sourceDataset, destDataset, action|
+		this.prSendMsg(\fitTransform,
+			[sourceDataset.asSymbol, destDataset.asSymbol], action
+		);
+	}
 
-    transformPoint{|sourceBuffer, destBuffer, action|
-        this.prSendMsg(\transformPoint,[sourceBuffer.asUGenInput, destBuffer.asUGenInput],action);
-    }
+	transformPoint{|sourceBuffer, destBuffer, action|
+		this.prSendMsg(\transformPoint,
+			[sourceBuffer.asUGenInput, destBuffer.asUGenInput], action
+		);
+	}
 }

release-packaging/HelpSource/Classes/FluidNormalize.schelp

@@ -4,7 +4,7 @@ categories:: FluidManipulation
 related:: Classes/FluidStandardize, Classes/FluidDataSet
 
 DESCRIPTION::
-Normalize the entries of a link::Classes/FluidDataSet::, or normalize a data point according to the learned bounrds of a data set. On the server.
+Normalize the entries of a link::Classes/FluidDataSet::, or normalize a data point according to the learned bounds of a data set. On the server.
 
 See http://www.faqs.org/faqs/ai-faq/neural-nets/part2/section-16.html
 
@@ -25,21 +25,24 @@ Maximum output value, default 1
 INSTANCEMETHODS::
 
 METHOD:: fit
-Normalize a link::Classes/FluidDataSet:: strong::in-place::
+Compute the normalization factors from a link::Classes/FluidDataSet:: for later.
 ARGUMENT:: dataset
 The link::Classes/FluidDataSet:: to normalize
 ARGUMENT:: action
 A function to run when processing is complete
 
-METHOD:: fitTransform
-Normalize a link::Classes/FluidDataSet:: strong::in-place::
-ARGUMENT:: dataset
+METHOD:: transform
+Normalize a link::Classes/FluidDataSet:: into another link::Classes/FluidDataSet::, using the learned extrema from a previous call to link::Classes/FluidNormalize#fit::
+ARGUMENT:: sourceDataset
 The link::Classes/FluidDataSet:: to normalize
+ARGUMENT:: destDataset
+The link::Classes/FluidDataSet:: to populate with normalized data
 ARGUMENT:: action
 A function to run when processing is complete
 
-METHOD:: transform
-Normalize a link::Classes/FluidDataSet:: non-destructively into another link::Classes/FluidDataSet::
+
+METHOD:: fitTransform
+Normalize a link::Classes/FluidDataSet::
 ARGUMENT:: sourceDataset
 The link::Classes/FluidDataSet:: to normalize
 ARGUMENT:: destDataset
@@ -47,8 +50,9 @@ The link::Classes/FluidDataSet:: to populate with normalized data
 ARGUMENT:: action
 A function to run when processing is complete
 
+
 METHOD:: transformPoint
-Normalize a new data point, using the learned extrema from a previous link::Classes/FluidNormalize#fit::ting
+Normalize a new data point, using the learned extrema from a previous call to link::Classes/FluidNormalize#fit::
 ARGUMENT:: sourceBuffer
 A link::Classes/Buffer:: with the new data point
 ARGUMENT:: destBuffer
@@ -56,26 +60,6 @@ A link::Classes/Buffer:: to contain the normalized value
 ARGUMENT:: action
 A function to run when processing is complete
 
-METHOD:: cols
-Retreive the dimensionality of the data set we have fitted on
-ARGUMENT:: action
-A function to run when the server responds, taking the dimensions as its argument
-
-METHOD:: read
-Load internal state (dimensionality, mins, maxes) from a JSON file
-ARGUMENT:: filename
-Absolute path to the JSON file
-ARGUMENT:: action
-A function to run when file is loaded
-
-METHOD:: write
-Store the internal state of object on disk as a JSON file. Will not overwrite existing files
-ARGUMENT:: filename
-Absolute path of file to write
-ARGUMENT:: action
-A function to run when file is written
-
-
 EXAMPLES::
 code::
 s.boot;

release-packaging/HelpSource/Classes/FluidStandardize.schelp

@@ -25,7 +25,7 @@ ARGUMENT:: action
 A function to run when processing is complete
 
 METHOD:: transform
-Standrdize a link::Classes/FluidDataSet:: non-destructively into another link::Classes/FluidDataSet::
+Standardize a link::Classes/FluidDataSet::, using the learned statistics from a previous call to link::Classes/FluidStandardize#fit::
 ARGUMENT:: sourceDataset
 The link::Classes/FluidDataSet:: to standardize
 ARGUMENT:: destDataset
@@ -34,14 +34,14 @@ ARGUMENT:: action
 A function to run when processing is complete
 
 METHOD:: fitTransform
-Standrdize a link::Classes/FluidDataSet:: fit and scale a link::Classes/FluidDataSet:: in-place
+Standardize a link::Classes/FluidDataSet:: into another link::Classes/FluidDataSet::
 ARGUMENT:: sourceDataset
 The link::Classes/FluidDataSet:: to standardize
 ARGUMENT:: action
 A function to run when processing is complete
 
 METHOD:: transformPoint
-Standardize a new data point, using the learned statistics from a previous link::Classes/FluidStandardize#fit::ting
+Standardize a new data point, using the learned statistics from a previous call to link::Classes/FluidStandardize#fit::
 ARGUMENT:: sourceBuffer
 A link::Classes/Buffer:: with the new data point
 ARGUMENT:: destBuffer
@@ -49,24 +49,6 @@ A link::Classes/Buffer:: to contain the standardize value
 ARGUMENT:: action
 A function to run when processing is complete
 
-METHOD:: cols
-Retreive the dimensionality of the data set we have fitted on
-ARGUMENT:: action
-A function to run when the server responds, taking the dimensions as its argument. Will print to post window by default
-
-METHOD:: read
-Load internal state (dimensionality, means, deviations) from a JSON file
-ARGUMENT:: filename
-Absolute path to the JSON file
-ARGUMENT:: action
-A function to run when file is loaded
-
-METHOD:: write
-Store the internal state of object on disk as a JSON file.
-ARGUMENT:: filename
-Absolute path of file to write
-ARGUMENT:: action
-A function to run when file is written
 
 EXAMPLES::
 code::
@@ -138,4 +120,4 @@ fork{
 ~rawarray.flatten(1).unlace.plot("Unstandardized",Rect(0,0,400,400),minval:0,maxval:[5000,1]).plotMode=\bars;
 ~plot2 = ~stdarray.flatten(1).unlace.plot("Standardized",Rect(410,0,400,400)).plotMode=\bars;
 )
-::
+::