refactor common methods to FluidManipulationClient in help files

nix
Gerard 6 years ago
parent 1d13f8cac0
commit e6600d0738

@ -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.

@ -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::

@ -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::

@ -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.

@ -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)
::
METHOD:: load
Fill the object with the contents of a dictionary, replacing its current contents (note: uses a temporary file under the hood).

@ -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::

Loading…
Cancel
Save