@reicek/neataptic-ts 0.1.21 → 0.1.23

package/src/multithreading/README.md

@@ -26,24 +26,14 @@ emphasis on efficient evaluation and mutation of neural networks in parallel env
 
 Absolute activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### activateSerializedNetwork
 
-`(inputValues: number[], activationValues: number[], stateValues: number[], serializedNetwork: number[], activationFunctions: import("C:/NeatapticTS/src/multithreading/types").ActivationFn[]) => number[]`
+`(inputValues: number[], activationValues: number[], stateValues: number[], serializedNetwork: number[], activationFunctions: import("src/multithreading/types").ActivationFn[]) => number[]`
 
 Activates a serialized network.
 
-Parameters:
-- `` - - The input values.
-- `` - - The activations array.
-- `` - - The states array.
-- `` - - The serialized network data.
-- `` - - The activation functions.
-
 Returns: The output values.
 
 #### activations
@@ -56,9 +46,6 @@ A list of compiled activation functions in a specific order.
 
 Bent Identity activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### bipolar
@@ -67,9 +54,6 @@ Returns: The activated value.
 
 Bipolar activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### bipolarSigmoid
@@ -78,20 +62,14 @@ Returns: The activated value.
 
 Bipolar Sigmoid activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### deserializeDataSet
 
-`(serializedSet: number[]) => import("C:/NeatapticTS/src/multithreading/types").SerializedSample[]`
+`(serializedSet: number[]) => import("src/multithreading/types").SerializedSample[]`
 
 Deserializes a dataset from a flat array.
 
-Parameters:
-- `` - - The serialized dataset.
-
 Returns: The deserialized dataset as an array of input-output pairs.
 
 #### gaussian
@@ -100,14 +78,11 @@ Returns: The deserialized dataset as an array of input-output pairs.
 
 Gaussian activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### getBrowserTestWorker
 
-`() => Promise<import("C:/NeatapticTS/src/multithreading/types").TestWorkerConstructor>`
+`() => Promise<import("src/multithreading/types").TestWorkerConstructor>`
 
 Gets the browser test worker.
 
@@ -115,7 +90,7 @@ Returns: The browser test worker.
 
 #### getNodeTestWorker
 
-`() => Promise<import("C:/NeatapticTS/src/multithreading/types").TestWorkerConstructor>`
+`() => Promise<import("src/multithreading/types").TestWorkerConstructor>`
 
 Gets the node test worker.
 
@@ -127,9 +102,6 @@ Returns: The node test worker.
 
 Hard Tanh activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### identity
@@ -138,9 +110,6 @@ Returns: The activated value.
 
 Identity activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### inverse
@@ -149,9 +118,6 @@ Returns: The activated value.
 
 Inverse activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### logistic
@@ -160,9 +126,6 @@ Returns: The activated value.
 
 Logistic activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### relu
@@ -171,9 +134,6 @@ Returns: The activated value.
 
 Rectified Linear Unit (ReLU) activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### selu
@@ -182,9 +142,6 @@ Returns: The activated value.
 
 Scaled Exponential Linear Unit (SELU) activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### serializeDataSet
@@ -193,9 +150,6 @@ Returns: The activated value.
 
 Serializes a dataset into a flat array.
 
-Parameters:
-- `` - - The dataset to serialize.
-
 Returns: The serialized dataset.
 
 #### sinusoid
@@ -204,9 +158,6 @@ Returns: The serialized dataset.
 
 Sinusoid activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### softplus
@@ -215,9 +166,6 @@ Returns: The activated value.
 
 Softplus activation function. - Added
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### softsign
@@ -226,9 +174,6 @@ Returns: The activated value.
 
 Softsign activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### step
@@ -237,9 +182,6 @@ Returns: The activated value.
 
 Step activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### tanh
@@ -248,25 +190,14 @@ Returns: The activated value.
 
 Hyperbolic tangent activation function.
 
-Parameters:
-- `` - - The input value.
-
 Returns: The activated value.
 
 #### testSerializedSet
 
-`(serializedSampleSet: import("C:/NeatapticTS/src/multithreading/types").SerializedSample[], cost: (expected: number[], actual: number[]) => number, activationValues: number[], stateValues: number[], serializedNetwork: number[], activationFunctions: import("C:/NeatapticTS/src/multithreading/types").ActivationFn[]) => number`
+`(serializedSampleSet: import("src/multithreading/types").SerializedSample[], cost: (expected: number[], actual: number[]) => number, activationValues: number[], stateValues: number[], serializedNetwork: number[], activationFunctions: import("src/multithreading/types").ActivationFn[]) => number`
 
 Tests a serialized dataset using a cost function.
 
-Parameters:
-- `` - - The serialized dataset as an array of input-output pairs.
-- `` - - The cost function.
-- `` - - The activations array.
-- `` - - The states array.
-- `` - - The serialized network data.
-- `` - - The activation functions.
-
 Returns: The average error.
 
 #### workers
@@ -306,7 +237,7 @@ Returns: Absolute activation.
 
 ### activateSerializedNetwork
 
-`(inputValues: number[], activationValues: number[], stateValues: number[], serializedNetwork: number[], activationFunctions: import("C:/NeatapticTS/src/multithreading/types").ActivationFn[]) => number[]`
+`(inputValues: number[], activationValues: number[], stateValues: number[], serializedNetwork: number[], activationFunctions: import("src/multithreading/types").ActivationFn[]) => number[]`
 
 Activates a serialized network and produces outputs.
 
@@ -350,7 +281,7 @@ Returns: Bipolar sigmoid activation.
 
 ### deserializeDataSet
 
-`(serializedSet: number[]) => import("C:/NeatapticTS/src/multithreading/types").SerializedSample[]`
+`(serializedSet: number[]) => import("src/multithreading/types").SerializedSample[]`
 
 Deserializes a dataset from its flat representation.
 
@@ -480,7 +411,7 @@ Returns: Hyperbolic tangent activation.
 
 ### testSerializedSet
 
-`(serializedSampleSet: import("C:/NeatapticTS/src/multithreading/types").SerializedSample[], costFunction: (expected: number[], actual: number[]) => number, activationValues: number[], stateValues: number[], serializedNetwork: number[], activationFunctions: import("C:/NeatapticTS/src/multithreading/types").ActivationFn[]) => number`
+`(serializedSampleSet: import("src/multithreading/types").SerializedSample[], costFunction: (expected: number[], actual: number[]) => number, activationValues: number[], stateValues: number[], serializedNetwork: number[], activationFunctions: import("src/multithreading/types").ActivationFn[]) => number`
 
 Tests a serialized dataset using a cost function.
 

package/src/multithreading/workers/README.md

@@ -12,7 +12,7 @@ Utility class for managing workers in both Node.js and browser environments.
 
 #### getBrowserTestWorker
 
-`() => Promise<typeof import("C:/NeatapticTS/src/multithreading/workers/browser/testworker").TestWorker>`
+`() => Promise<typeof import("src/multithreading/workers/browser/testworker").TestWorker>`
 
 Loads the browser test worker dynamically.
 
@@ -20,7 +20,7 @@ Returns: A promise that resolves to the browser TestWorker class.
 
 #### getNodeTestWorker
 
-`() => Promise<typeof import("C:/NeatapticTS/src/multithreading/workers/node/testworker").TestWorker>`
+`() => Promise<typeof import("src/multithreading/workers/node/testworker").TestWorker>`
 
 Loads the Node.js test worker dynamically.
 

package/src/multithreading/workers/browser/README.md

@@ -24,9 +24,6 @@ computationally expensive tasks, such as network evaluation, to separate threads
 
 Creates a string representation of the worker's blob.
 
-Parameters:
-- `` - - The cost function to be used by the worker.
-
 Returns: The blob string.
 
 #### evaluate
@@ -35,9 +32,6 @@ Returns: The blob string.
 
 Evaluates a network using the worker process.
 
-Parameters:
-- `` - - The network to evaluate.
-
 Returns: A promise that resolves to the evaluation result.
 
 #### terminate

package/src/multithreading/workers/node/README.md

@@ -45,9 +45,6 @@ Evaluates a neural network using the worker process.
 The network is serialized and sent to the worker for evaluation. The worker
 sends back the evaluation result, which is returned as a promise.
 
-Parameters:
-- `` - - The neural network to evaluate. It must implement a `serialize` method.
-
 Returns: A promise that resolves to the evaluation result.
 
 #### terminate