diff --git a/release-packaging/HelpSource/Classes/FluidDataSet.schelp b/release-packaging/HelpSource/Classes/FluidDataSet.schelp index 8a400b2..aab6fc8 100644 --- a/release-packaging/HelpSource/Classes/FluidDataSet.schelp +++ b/release-packaging/HelpSource/Classes/FluidDataSet.schelp @@ -58,24 +58,6 @@ Empty the data set. METHOD:: free Destroy the object on the server. -METHOD:: read -Read a data set from a JSON file on disk, replacing the current contents. -​ -METHOD:: write -Write the data set to disk as a JSON file. - -METHOD:: size -Report the number of items currently in the data set. - -METHOD:: cols -Report the dimensionality of the data set. If action is nil, will default to posting result. - -METHOD:: dump -Get the contents of the dataset as a Dictionary (note: uses a temporary file under the hood); - -METHOD:: load -Fill the dataset with the contents of a dictionary, replacing its current contents (note: uses a temporary file under the hood). - METHOD:: print Post an abbreviated content of the dataset in the window by default, but you can supply a custom action instead. ​​ diff --git a/release-packaging/HelpSource/Classes/FluidKDTree.schelp b/release-packaging/HelpSource/Classes/FluidKDTree.schelp index bf3dd11..628c50b 100644 --- a/release-packaging/HelpSource/Classes/FluidKDTree.schelp +++ b/release-packaging/HelpSource/Classes/FluidKDTree.schelp @@ -52,32 +52,6 @@ The number of neighbours to search ARGUMENT:: action A function that will run when the query returns, whose argument is an array of distances -METHOD:: cols -Get the dimensionality of the data that the tree is indexed against - -ARGUMENT:: action -A function that runs when the query returns, whose argument is the dimensionality - - -METHOD:: read -Set the object's state from a JSON file - -ARGUMENT:: filename -The location of a JSON file on disk - -ARGUMENT:: action -function to run when the data is loaded - - -METHOD:: write -Write the index of the tree to disk. Currently this will not overwrite extant files. - -ARGUMENT:: filename -The path of a JSON file to write - -ARGUMENT:: action -A function to run when writing is complete - EXAMPLES:: diff --git a/release-packaging/HelpSource/Classes/FluidKMeans.schelp b/release-packaging/HelpSource/Classes/FluidKMeans.schelp index bd2384e..83908b4 100644 --- a/release-packaging/HelpSource/Classes/FluidKMeans.schelp +++ b/release-packaging/HelpSource/Classes/FluidKMeans.schelp @@ -61,13 +61,6 @@ a link::Classes/Buffer:: containing a data point ARGUMENT:: action A function to run when the server responds, taking the ID of the cluser as its argument - - -METHOD:: cols -Retreive the dimentionality of the dataset this instance is trained on -ARGUMENT:: action -A function to run when the server responds, taking the dimensionality as its argument - METHOD:: predict Report cluster assignments for previously unseen data ARGUMENT:: dataset @@ -78,22 +71,6 @@ ARGUMENT:: action A function to run when complete, taking an array of the counts for each catgegory as its argument - -METHOD:: write -write learned clusters to disk as a JSON file. Will not overwrite existing files -ARGUMENT:: filename -Absolute path for file -ARGUMENT:: action -A function to run when the file is written - -METHOD:: read -Read a learned clustering of a data set from a JSON file -ARGUMENT:: filename -Absolute path of the JSON file -ARGUMENT:: action -Function to run when the file has been read - - EXAMPLES:: Server.default.options.outDevice = "Built-in Output" code:: diff --git a/release-packaging/HelpSource/Classes/FluidLabelSet.schelp b/release-packaging/HelpSource/Classes/FluidLabelSet.schelp index 353729c..8170ce1 100644 --- a/release-packaging/HelpSource/Classes/FluidLabelSet.schelp +++ b/release-packaging/HelpSource/Classes/FluidLabelSet.schelp @@ -20,7 +20,7 @@ METHOD:: at Retrieve a label set from the cache. ARGUMENT:: server The link::Classes/Server:: on which to create the label set. -ARGUMENT:: id +ARGUMENT:: name symbol or string with the label set's name. @@ -49,23 +49,6 @@ Remove a id-label pair from the label set. METHOD:: clear Empty the label set. -METHOD:: size -Report the number of items in the label set. - -METHOD:: cols -Report the number of labels per point (at the moment only 1 is supported). - -METHOD:: write -Write this label set to disk as a JSON file. - -METHOD:: read -Read a label set from a JSON file on disk, replacing the current contents. - -METHOD:: dump -Get the contents of the label set as a Dictionary (note: uses a temporary file under the hood); - -METHOD:: load -Fill the label set with the contents of a dictionary, replacing its current contents (note: uses a temporary file under the hood). METHOD:: print Post an abbreviated content of the label set in the window by default, but you can supply a custom action instead. diff --git a/release-packaging/HelpSource/Classes/FluidManipulationClient.schelp b/release-packaging/HelpSource/Classes/FluidManipulationClient.schelp index 3e2d69a..5bb3dca 100644 --- a/release-packaging/HelpSource/Classes/FluidManipulationClient.schelp +++ b/release-packaging/HelpSource/Classes/FluidManipulationClient.schelp @@ -11,13 +11,6 @@ CLASSMETHODS:: PRIVATE:: nonBlocking -METHOD:: kr -The kr of the underlying UGem, which will output progress readings once all messages can be asynchronous. - -If, for whatever reason, you create an instance of a client object using code::kr:: in your own synth, make sure to set the instance's link::Classes/FluidManipulationClient#synth:: and link::Classes/FluidManipulationClient#server::, or nothing will work. - -returns:: An instance - METHOD:: new Language-side constructor. Internally, this creates a new synth around an instance of the sub-class being constructed, and maintains a variable pointing to the synth, so that it can be communicated with. @@ -43,9 +36,20 @@ The link::Classes/Server:: that our instance's object is running on returns:: a link::Classes/Server:: +METHOD:: read +Read the object's data from a JSON file on disk, replacing the current contents. +​ +METHOD:: write +Write the object's data to disk as a JSON file. + +METHOD:: size +Report the number of items currently in the object's data. + +METHOD:: cols +Report the dimensionality of the object's data. If action is nil, will default to posting result. -EXAMPLES:: +METHOD:: dump +Get the contents of the object's data as a Dictionary (note: uses a temporary file under the hood); -code:: -(some example code) -:: \ No newline at end of file +METHOD:: load +Fill the object with the contents of a dictionary, replacing its current contents (note: uses a temporary file under the hood). diff --git a/release-packaging/HelpSource/Classes/FluidPCA.schelp b/release-packaging/HelpSource/Classes/FluidPCA.schelp index d21fe7f..987d76f 100644 --- a/release-packaging/HelpSource/Classes/FluidPCA.schelp +++ b/release-packaging/HelpSource/Classes/FluidPCA.schelp @@ -56,25 +56,6 @@ Output data ARGUMENT:: action Run when done -METHOD:: cols -Return the dimensionaliy of the data the model was trained on -ARGUMENT:: action -Run when done, taking the number of columns as an argument. If nil, defaults to posting to window - -METHOD:: read -Read a data set from a JSON file on disk -ARGUMENT:: filename -The absolute path of the JSON file to read -ARGUMENT:: action -A function to run when the file has been read -​ -METHOD:: write -Write the data set to disk as a JSON file. -ARGUMENT:: filename -Absolute path for the new file -ARGUMENT:: action -A function to run when the file has been written - EXAMPLES:: code::