@reicek/neataptic-ts 0.1.24 → 0.1.26

package/src/multithreading/README.md

@@ -311,30 +311,28 @@ ActivationFn(
 
 Shared types for multithreading helpers and test workers.
 
-### SerializedSample
-
 ### SerializableNetwork
 
-### TestWorkerInstance
+### SerializedSample
 
 ### TestWorkerConstructor
 
+### TestWorkerInstance
+
 ## multithreading/multi.utils.ts
 
-### serializeDataSet
+### absoluteActivation
 
 ```ts
-serializeDataSet(
-  dataSet: { input: number[]; output: number[]; }[],
-): number[]
+absoluteActivation(
+  value: number,
+): number
 ```
 
-Serializes a dataset into a flat numeric array.
-
 Parameters:
-- `dataSet` - - Collection of samples with input and output arrays.
+- `value` - - Input value.
 
-Returns: Flat serialized representation [inputCount, outputCount, ...samples].
+Returns: Absolute activation.
 
 ### activateSerializedNetwork
 
@@ -359,25 +357,27 @@ Parameters:
 
 Returns: Activated outputs.
 
-### deserializeDataSet
+### ACTIVATION_FUNCTIONS
+
+Returns: Activation functions ordered for serialization compatibility.
+
+### bentIdentityActivation
 
 ```ts
-deserializeDataSet(
-  serializedSet: number[],
-): SerializedSample[]
+bentIdentityActivation(
+  value: number,
+): number
 ```
 
-Deserializes a dataset from its flat representation.
-
 Parameters:
-- `serializedSet` - - Flat serialized dataset array.
+- `value` - - Input value.
 
-Returns: Array of input/output sample pairs.
+Returns: Bent identity activation.
 
-### logisticActivation
+### bipolarActivation
 
 ```ts
-logisticActivation(
+bipolarActivation(
   value: number,
 ): number
 ```
@@ -385,12 +385,12 @@ logisticActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: Logistic activation.
+Returns: Bipolar activation.
 
-### tanhActivation
+### bipolarSigmoidActivation
 
 ```ts
-tanhActivation(
+bipolarSigmoidActivation(
   value: number,
 ): number
 ```
@@ -398,25 +398,27 @@ tanhActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: Hyperbolic tangent activation.
+Returns: Bipolar sigmoid activation.
 
-### identityActivation
+### deserializeDataSet
 
 ```ts
-identityActivation(
-  value: number,
-): number
+deserializeDataSet(
+  serializedSet: number[],
+): SerializedSample[]
 ```
 
+Deserializes a dataset from its flat representation.
+
 Parameters:
-- `value` - - Input value.
+- `serializedSet` - - Flat serialized dataset array.
 
-Returns: Identity activation.
+Returns: Array of input/output sample pairs.
 
-### stepActivation
+### gaussianActivation
 
 ```ts
-stepActivation(
+gaussianActivation(
   value: number,
 ): number
 ```
@@ -424,12 +426,12 @@ stepActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: Step activation.
+Returns: Gaussian activation.
 
-### reluActivation
+### hardTanhActivation
 
 ```ts
-reluActivation(
+hardTanhActivation(
   value: number,
 ): number
 ```
@@ -437,12 +439,12 @@ reluActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: ReLU activation.
+Returns: Hard tanh activation.
 
-### softsignActivation
+### identityActivation
 
 ```ts
-softsignActivation(
+identityActivation(
   value: number,
 ): number
 ```
@@ -450,12 +452,12 @@ softsignActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: Softsign activation.
+Returns: Identity activation.
 
-### sinusoidActivation
+### inverseActivation
 
 ```ts
-sinusoidActivation(
+inverseActivation(
   value: number,
 ): number
 ```
@@ -463,12 +465,12 @@ sinusoidActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: Sinusoid activation.
+Returns: Inverse activation.
 
-### gaussianActivation
+### logisticActivation
 
 ```ts
-gaussianActivation(
+logisticActivation(
   value: number,
 ): number
 ```
@@ -476,12 +478,12 @@ gaussianActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: Gaussian activation.
+Returns: Logistic activation.
 
-### bentIdentityActivation
+### reluActivation
 
 ```ts
-bentIdentityActivation(
+reluActivation(
   value: number,
 ): number
 ```
@@ -489,12 +491,12 @@ bentIdentityActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: Bent identity activation.
+Returns: ReLU activation.
 
-### bipolarActivation
+### seluActivation
 
 ```ts
-bipolarActivation(
+seluActivation(
   value: number,
 ): number
 ```
@@ -502,25 +504,27 @@ bipolarActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: Bipolar activation.
+Returns: SELU activation.
 
-### bipolarSigmoidActivation
+### serializeDataSet
 
 ```ts
-bipolarSigmoidActivation(
-  value: number,
-): number
+serializeDataSet(
+  dataSet: { input: number[]; output: number[]; }[],
+): number[]
 ```
 
+Serializes a dataset into a flat numeric array.
+
 Parameters:
-- `value` - - Input value.
+- `dataSet` - - Collection of samples with input and output arrays.
 
-Returns: Bipolar sigmoid activation.
+Returns: Flat serialized representation [inputCount, outputCount, ...samples].
 
-### hardTanhActivation
+### sinusoidActivation
 
 ```ts
-hardTanhActivation(
+sinusoidActivation(
   value: number,
 ): number
 ```
@@ -528,12 +532,12 @@ hardTanhActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: Hard tanh activation.
+Returns: Sinusoid activation.
 
-### absoluteActivation
+### softplusActivation
 
 ```ts
-absoluteActivation(
+softplusActivation(
   value: number,
 ): number
 ```
@@ -541,12 +545,12 @@ absoluteActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: Absolute activation.
+Returns: Softplus activation.
 
-### inverseActivation
+### softsignActivation
 
 ```ts
-inverseActivation(
+softsignActivation(
   value: number,
 ): number
 ```
@@ -554,12 +558,12 @@ inverseActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: Inverse activation.
+Returns: Softsign activation.
 
-### seluActivation
+### stepActivation
 
 ```ts
-seluActivation(
+stepActivation(
   value: number,
 ): number
 ```
@@ -567,12 +571,12 @@ seluActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: SELU activation.
+Returns: Step activation.
 
-### softplusActivation
+### tanhActivation
 
 ```ts
-softplusActivation(
+tanhActivation(
   value: number,
 ): number
 ```
@@ -580,7 +584,7 @@ softplusActivation(
 Parameters:
 - `value` - - Input value.
 
-Returns: Softplus activation.
+Returns: Hyperbolic tangent activation.
 
 ### testSerializedSet
 
@@ -606,7 +610,3 @@ Parameters:
 - `activationFunctions` - - Activation functions to apply.
 
 Returns: Average cost or NaN when invalid input.
-
-### ACTIVATION_FUNCTIONS
-
-Returns: Activation functions ordered for serialization compatibility.

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

@@ -2,6 +2,14 @@
 
 ## multithreading/workers/browser/testworker.ts
 
+### CostFunction
+
+Interface for cost function used in worker evaluation.
+
+### SerializableNetwork
+
+Interface for serializable network used in worker evaluation.
+
 ### TestWorker
 
 TestWorker class for handling network evaluations in a browser environment using Web Workers.
@@ -41,11 +49,3 @@ terminate(): void
 ```
 
 Terminates the worker process and revokes the object URL.
-
-### SerializableNetwork
-
-Interface for serializable network used in worker evaluation.
-
-### CostFunction
-
-Interface for cost function used in worker evaluation.

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

@@ -14,6 +14,14 @@ Interface for messages sent to the worker process.
 
 ## multithreading/workers/node/testworker.ts
 
+### CostFunction
+
+Interface for cost function used in worker evaluation.
+
+### SerializableNetwork
+
+Interface for serializable network used in worker evaluation.
+
 ### TestWorker
 
 TestWorker class for handling network evaluations in a Node.js environment using Worker Threads.
@@ -78,11 +86,3 @@ Example:
 const worker = new TestWorker([0, 1, 2], { name: 'mse' });
 // ...use worker.evaluate(...) as needed
 worker.terminate();
-
-### SerializableNetwork
-
-Interface for serializable network used in worker evaluation.
-
-### CostFunction
-
-Interface for cost function used in worker evaluation.