From 2c62ffab4f8fce898364d1a4791fa23e9f178720 Mon Sep 17 00:00:00 2001
From: Pierre Alexandre Tremblay <info@pierrealexandretremblay.com>
Date: Tue, 28 Jul 2020 18:39:15 +0100
Subject: [PATCH 1/4] updated helpfile for MLP regressor

---
 .../HelpSource/Classes/FluidMLPRegressor.schelp          | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/release-packaging/HelpSource/Classes/FluidMLPRegressor.schelp b/release-packaging/HelpSource/Classes/FluidMLPRegressor.schelp
index 512c87a..16e599f 100644
--- a/release-packaging/HelpSource/Classes/FluidMLPRegressor.schelp
+++ b/release-packaging/HelpSource/Classes/FluidMLPRegressor.schelp
@@ -20,10 +20,13 @@ An link::Classes/Array:: that gives the sizes of any hidden layers in the networ
 ARGUMENT:: activation
 The activation function to use for the hidden layer units. Beware of the permitted ranges of each: relu (0->inf), sigmoid (0->1), tanh (-1,1).
 
-ARGUMENT:: finalActivation
+ARGUMENT:: outputActivation
 The activation function to use for the final layer units. Beware of the permitted ranges of each: relu (0->inf), sigmoid (0->1), tanh (-1,1).
 
-ARGUMENT:: outputLayer
+ARGUMENT:: inputTap
+The layer whose input is used to predict and predictPoint. It is 0 counting, where the default of 0 is the input layer, and 1 would be the first hidden layer, and so on.
+
+ARGUMENT:: outputTap
 The layer whose output to return. It is negative 0 counting, where the default of 0 is the output layer, and 1 would be the last hidden layer, and so on.
 
 ARGUMENT:: maxIter
@@ -103,7 +106,7 @@ code::
 ~test = FluidDataSet(s,\mlp_regressor_dest);
 ~output = FluidDataSet(s,\mlp_regress_out);
 ~tmpbuf = Buffer.alloc(s,1);
-~regressor = FluidMLPRegressor(s,[2], FluidMLPRegressor.tanh, FluidMLPRegressor.tanh, 0, 1000,0.1,0.1,1,0);
+~regressor = FluidMLPRegressor(s,[2], FluidMLPRegressor.tanh, FluidMLPRegressor.tanh, 0, 0, 1000,0.1,0.1,1,0);
 )
 
 //Make source, target and test data

From efa97e4e6622f3221bcf70a3c530360c1c66fb0e Mon Sep 17 00:00:00 2001
From: Pierre Alexandre Tremblay <info@pierrealexandretremblay.com>
Date: Wed, 29 Jul 2020 15:19:49 +0100
Subject: [PATCH 2/4] new interface for MLPregress

---
 release-packaging/Classes/FluidMLP.sc                     | 6 +++---
 .../HelpSource/Classes/FluidMLPRegressor.schelp           | 8 ++++----
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/release-packaging/Classes/FluidMLP.sc b/release-packaging/Classes/FluidMLP.sc
index 635a591..a981e5b 100644
--- a/release-packaging/Classes/FluidMLP.sc
+++ b/release-packaging/Classes/FluidMLP.sc
@@ -5,7 +5,7 @@ FluidMLPRegressor : FluidRTDataClient {
 	const <relu = 2;
 	const <tanh = 3;
 
-	*new {|server, hidden = #[3,3] , activation = 0, outputActivation = 0, inputTap = 0, outputTap = 0,maxIter = 1000, learnRate = 0.0001, momentum = 0.9, batchSize = 50, validation = 0.2|
+	*new {|server, hidden = #[3,3] , activation = 2, outputActivation = 0, tapIn = 0, tapOut = -1,maxIter = 1000, learnRate = 0.0001, momentum = 0.9, batchSize = 50, validation = 0.2|
 		var hiddenCtrlLabels;
 		hidden = [hidden.size]++hidden;
 
@@ -16,8 +16,8 @@ FluidMLPRegressor : FluidRTDataClient {
 			[
 			\activation,activation,
 			\outputActivation, outputActivation,
-			\inputTap, inputTap,
-			\outputTap, outputTap,
+			\tapIn, tapIn,
+			\tapOut, tapOut,
 			\maxIter, maxIter,
 			\learnRate,learnRate,
 			\momentum, momentum,
diff --git a/release-packaging/HelpSource/Classes/FluidMLPRegressor.schelp b/release-packaging/HelpSource/Classes/FluidMLPRegressor.schelp
index 16e599f..aa96892 100644
--- a/release-packaging/HelpSource/Classes/FluidMLPRegressor.schelp
+++ b/release-packaging/HelpSource/Classes/FluidMLPRegressor.schelp
@@ -23,11 +23,11 @@ The activation function to use for the hidden layer units. Beware of the permitt
 ARGUMENT:: outputActivation
 The activation function to use for the final layer units. Beware of the permitted ranges of each: relu (0->inf), sigmoid (0->1), tanh (-1,1).
 
-ARGUMENT:: inputTap
+ARGUMENT:: tapIn
 The layer whose input is used to predict and predictPoint. It is 0 counting, where the default of 0 is the input layer, and 1 would be the first hidden layer, and so on.
 
-ARGUMENT:: outputTap
-The layer whose output to return. It is negative 0 counting, where the default of 0 is the output layer, and 1 would be the last hidden layer, and so on.
+ARGUMENT:: tapOut
+The layer whose output to return. It is counting from 0 as the input layer, and 1 would be the first hidden layer, and so on. The default of -1 is the last layer.
 
 ARGUMENT:: maxIter
 The maximum number of iterations to use in training.
@@ -106,7 +106,7 @@ code::
 ~test = FluidDataSet(s,\mlp_regressor_dest);
 ~output = FluidDataSet(s,\mlp_regress_out);
 ~tmpbuf = Buffer.alloc(s,1);
-~regressor = FluidMLPRegressor(s,[2], FluidMLPRegressor.tanh, FluidMLPRegressor.tanh, 0, 0, 1000,0.1,0.1,1,0);
+~regressor = FluidMLPRegressor(s,[2], FluidMLPRegressor.tanh, FluidMLPRegressor.tanh, maxIter: 1000, learnRate: 0.1, momentum: 0.1, batchSize: 1, validation: 0);
 )
 
 //Make source, target and test data

From 2747e5b2a2e59ddf8e2b4d0a3745e10716f7b743 Mon Sep 17 00:00:00 2001
From: Pierre Alexandre Tremblay <info@pierrealexandretremblay.com>
Date: Tue, 4 Aug 2020 09:40:17 +0100
Subject: [PATCH 3/4] correct order of activations in helpfile

---
 .../HelpSource/Classes/FluidMLPClassifier.schelp              | 2 +-
 release-packaging/HelpSource/Classes/FluidMLPRegressor.schelp | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/release-packaging/HelpSource/Classes/FluidMLPClassifier.schelp b/release-packaging/HelpSource/Classes/FluidMLPClassifier.schelp
index ebd9f2a..a406b71 100644
--- a/release-packaging/HelpSource/Classes/FluidMLPClassifier.schelp
+++ b/release-packaging/HelpSource/Classes/FluidMLPClassifier.schelp
@@ -34,7 +34,7 @@ The training batch size.
 ARGUMENT:: validation
 The fraction of the DataSet size to hold back during training to validate the network against.
 
-METHOD:: identity, relu, sigmoid, tanh
+METHOD:: identity, sigmoid, relu, tanh
 A set of convinience constants for the available activation functions.
 
 INSTANCEMETHODS::
diff --git a/release-packaging/HelpSource/Classes/FluidMLPRegressor.schelp b/release-packaging/HelpSource/Classes/FluidMLPRegressor.schelp
index aa96892..cb9a498 100644
--- a/release-packaging/HelpSource/Classes/FluidMLPRegressor.schelp
+++ b/release-packaging/HelpSource/Classes/FluidMLPRegressor.schelp
@@ -27,7 +27,7 @@ ARGUMENT:: tapIn
 The layer whose input is used to predict and predictPoint. It is 0 counting, where the default of 0 is the input layer, and 1 would be the first hidden layer, and so on.
 
 ARGUMENT:: tapOut
-The layer whose output to return. It is counting from 0 as the input layer, and 1 would be the first hidden layer, and so on. The default of -1 is the last layer.
+The layer whose output to return. It is counting from 0 as the input layer, and 1 would be the first hidden layer, and so on. The default of -1 is the last layer of the whole network.
 
 ARGUMENT:: maxIter
 The maximum number of iterations to use in training.
@@ -44,7 +44,7 @@ The training batch size.
 ARGUMENT:: validation
 The fraction of the DataSet size to hold back during training to validate the network against.
 
-METHOD:: identity, relu, sigmoid, tanh
+METHOD:: identity, sigmoid, relu, tanh
 A set of convinience constants for the available activation functions.
 
 INSTANCEMETHODS::

From dcf3b96cfebeec664679a53cc47bfd6edb2d1a12 Mon Sep 17 00:00:00 2001
From: Pierre Alexandre Tremblay <info@pierrealexandretremblay.com>
Date: Tue, 4 Aug 2020 09:40:40 +0100
Subject: [PATCH 4/4] correct slicecorpus helpfile missing argument

---
 release-packaging/HelpSource/Classes/FluidSliceCorpus.schelp | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/release-packaging/HelpSource/Classes/FluidSliceCorpus.schelp b/release-packaging/HelpSource/Classes/FluidSliceCorpus.schelp
index 4c1783c..2abeec4 100644
--- a/release-packaging/HelpSource/Classes/FluidSliceCorpus.schelp
+++ b/release-packaging/HelpSource/Classes/FluidSliceCorpus.schelp
@@ -73,6 +73,10 @@ An link::Classes/IdentityDictionary:: that details labels and start-end position
 ARGUMENT:: action
 A function that runs on complettion, will be passed the link::Classes/IdentityDictionary:: from link::#index:: as an argument.
 
+ARGUMENT:: tasks
+ANCHOR::ntasks::
+The number of parallel processing tasks to run on the server. Default 4. This should probably never be greater than the number of available CPU cores.
+
 METHOD:: index
 A link::Classes/IdentityDictionary:: containing information about the position of each discovered slice, using labels based on those passed into link::#play:: (see link::#labelling::). This dictionary copies all other entries from the source dictionary on a per-key basis (so you can store arbitary stuff in there should you wish, and it will remain oassciated with its original source chunk).