diff --git a/release-packaging/HelpSource/Classes/FluidNormalize.schelp b/release-packaging/HelpSource/Classes/FluidNormalize.schelp new file mode 100644 index 0000000..1848cd3 --- /dev/null +++ b/release-packaging/HelpSource/Classes/FluidNormalize.schelp @@ -0,0 +1,94 @@ +TITLE:: FluidNormalize +summary:: Normalize a FluidDataSet +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. + +See http://www.faqs.org/faqs/ai-faq/neural-nets/part2/section-16.html + +CLASSMETHODS:: + +private:: kr + +METHOD:: new +Create a new instance + +ARGUMENT:: server +The link::Classes/Server:: on which to run + +ARGUMENT:: min +Minimum output value, default 0 + +ARGUMENT:: max +Maximum output value, default 1 + +returns:: new instance + + +INSTANCEMETHODS:: + +METHOD:: fit +Normalize a link::Classes/FluidDataSet:: strong::in-place:: + +ARGUMENT:: dataset +The link::Classes/FluidDataSet:: to normalize + +ARGUMENT:: action +A function to run when processing is complete + +METHOD:: normalize +Normalize a link::Classes/FluidDataSet:: non-destructively into another link::Classes/FluidDataSet:: + +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:: normalizePoint +Normalize a new data point, using the learned extrema from a previous link::Classes/FluidNormalize#fit::ting + +ARGUMENT:: sourceBuffer +A link::Classes/Buffer:: with the new data point + +ARGUMENT:: destBuffer +A link::Classes/Buffer:: to contain the normalized value + +ARGUMENT:: action +A function to run when processing is complete + +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 + +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 + + +EXAMPLES:: + +code:: +(some example code) +:: \ No newline at end of file diff --git a/release-packaging/HelpSource/Classes/FluidStandardize.schelp b/release-packaging/HelpSource/Classes/FluidStandardize.schelp new file mode 100644 index 0000000..5c94be7 --- /dev/null +++ b/release-packaging/HelpSource/Classes/FluidStandardize.schelp @@ -0,0 +1,77 @@ +TITLE:: FluidStandardize +summary:: Standardize a FluidDataSet +categories:: FluidManipulation +related:: Classes/FluidDataSet, Classes/FluidNormalize + +DESCRIPTION:: +Standardize a link::Classes/FluidDataSet::, i.e. rescale using its mean(s) and standard deviation(s) in each dimension. + +See http://www.faqs.org/faqs/ai-faq/neural-nets/part2/section-16.html + +CLASSMETHODS:: + + +INSTANCEMETHODS:: + +METHOD:: fit +Standardize a link::Classes/FluidDataSet:: strong::in-place:: + +ARGUMENT:: dataset +The link::Classes/FluidDataSet:: to standardize + +ARGUMENT:: action +A function to run when processing is complete + +METHOD:: standardize +Standrdize a link::Classes/FluidDataSet:: non-destructively into another link::Classes/FluidDataSet:: + +ARGUMENT:: sourceDataset +The link::Classes/FluidDataSet:: to standardize + +ARGUMENT:: destDataset +The link::Classes/FluidDataSet:: to populate with standardized data + +ARGUMENT:: action +A function to run when processing is complete + +METHOD:: standardizePoint +Standardize a new data point, using the learned statistics from a previous link::Classes/FluidStandardize#fit::ting + +ARGUMENT:: sourceBuffer +A link::Classes/Buffer:: with the new data point + +ARGUMENT:: destBuffer +A link::Classes/Buffer:: to contain the standardize value + +ARGUMENT:: action +A function to run when processing is complete + +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. Will not overwrite existing files + +ARGUMENT:: filename +Absolute path of file to write + +ARGUMENT:: action +A function to run when file is written + +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 + +EXAMPLES:: + +code:: +(some example code) +:: \ No newline at end of file