From cc13acc9523de0df20ef2580fb2548ee326e5573 Mon Sep 17 00:00:00 2001 From: Pierre Alexandre Tremblay Date: Tue, 13 Apr 2021 09:58:36 +0100 Subject: [PATCH] and now, with less typos --- .../HelpSource/Classes/FluidKMeans.schelp | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/release-packaging/HelpSource/Classes/FluidKMeans.schelp b/release-packaging/HelpSource/Classes/FluidKMeans.schelp index 58d895c..1dcf71f 100644 --- a/release-packaging/HelpSource/Classes/FluidKMeans.schelp +++ b/release-packaging/HelpSource/Classes/FluidKMeans.schelp @@ -32,11 +32,11 @@ ARGUMENT:: action A function to run when fitting is complete, taking as its argument an array with the number of data points for each cluster. METHOD:: predict -Given a trained object, return the cluster ID for each data point in a DataSet to a label set. +Given a trained object, return the cluster ID for each data point in a link::Classes/FluidDataSet:: to a link::Classes/FluidLabelSet::. ARGUMENT:: dataSet -a link::Classes/FluidDataSet:: containing the data to predict. +A link::Classes/FluidDataSet:: containing the data to predict. ARGUMENT:: labelSet -a link::Classes/FluidLabelSet:: to retrieve the predicted clusters. +A link::Classes/FluidLabelSet:: to retrieve the predicted clusters. ARGUMENT:: action A function to run when the server responds. @@ -52,12 +52,12 @@ A function to run when the server responds METHOD:: predictPoint Given a trained object, return the cluster ID for a data point in a link::Classes/Buffer:: ARGUMENT:: buffer -a link::Classes/Buffer:: containing a data point. +A link::Classes/Buffer:: containing a data point. ARGUMENT:: action A function to run when the server responds, taking the ID of the cluster as its argument. METHOD:: transform -Given a trained object, return for each item of a provided DataSet its distance to each cluster as an array, often reffered to as the cluster-distance space. +Given a trained object, return for each item of a provided link::Classes/FluidDataSet:: its distance to each cluster as an array, often reffered to as the cluster-distance space. ARGUMENT:: srcDataSet A link::Classes/FluidDataSet:: of data points to transform. ARGUMENT:: dstDataSet @@ -68,7 +68,7 @@ A function to run when complete. METHOD:: fitTransform Run link::Classes/FluidKMeans#*fit:: and link::Classes/FluidKMeans#*transform:: in a single pass: i.e. train the model on the incoming link::Classes/FluidDataSet:: and then return its cluster-distance space in the destination link::Classes/FluidDataSet:: ARGUMENT:: srcDataSet -a link::Classes/FluidDataSet:: containing the data to fit and predict. +A link::Classes/FluidDataSet:: containing the data to fit and transform. ARGUMENT:: dstDataSet A link::Classes/FluidDataSet:: to contain the new cluster-distance space. ARGUMENT:: action @@ -77,9 +77,9 @@ A function to run when complete. METHOD:: transformPoint Given a trained object, return the distance of the provided point to each cluster. Both points are handled as link::Classes/Buffer:: ARGUMENT:: sourceBuffer -a link::Classes/Buffer:: containing a data point to query. +A link::Classes/Buffer:: containing a data point to query. ARGUMENT:: targetBuffer -a link::Classes/Buffer:: containing a the distance of the source point to each cluster. +A link::Classes/Buffer:: containing a the distance of the source point to each cluster. ARGUMENT:: action A function to run when complete.