@reicek/neataptic-ts 0.1.25 → 0.1.26

package/src/architecture/network/stats/README.md

@@ -53,96 +53,90 @@ Returns: Mean error and evaluation duration.
 
 ## architecture/network/stats/network.stats.test.utils.ts
 
-### testNetwork
+### createTestResult
 
 ```ts
-testNetwork(
-  set: TestSample[],
-  cost: CostFunction | undefined,
+createTestResult(
+  cumulativeError: number,
+  sampleCount: number,
+  startTime: number,
 ): TestNetworkResult
 ```
 
-Evaluate a dataset and return average error and elapsed time.
+Build the final test result payload.
 
 Parameters:
-- `this` - Bound network instance.
-- `set` - Evaluation samples.
-- `cost` - Optional cost function override.
+- `cumulativeError` - Cumulative sample error.
+- `sampleCount` - Number of evaluated samples.
+- `startTime` - Evaluation start timestamp.
 
-Returns: Mean error and evaluation duration.
+Returns: Mean error and elapsed duration.
 
-### validateTestSet
+### disableDropoutForTesting
 
 ```ts
-validateTestSet(
+disableDropoutForTesting(
   network: default,
-  testSet: TestSample[],
-): void
+): number
 ```
 
-Validate that the evaluation set exists and each sample matches network dimensions.
+Disable dropout while preserving previous runtime dropout value.
 
 Parameters:
 - `network` - Bound network instance.
-- `testSet` - Evaluation sample set.
 
-### validateTestSetPresence
-
-```ts
-validateTestSetPresence(
-  testSet: TestSample[],
-): void
-```
-
-Validate that the test set is a non-empty array.
-
-Parameters:
-- `testSet` - Evaluation sample set.
+Returns: Previous dropout value.
 
-### validateAllSampleDimensions
+### evaluateSamples
 
 ```ts
-validateAllSampleDimensions(
+evaluateSamples(
   network: default,
   testSet: TestSample[],
-): void
+  costFunction: CostFunction,
+): number
 ```
 
-Validate input and output dimensions for every sample.
+Evaluate all test samples and accumulate total cost.
 
 Parameters:
 - `network` - Bound network instance.
 - `testSet` - Evaluation sample set.
+- `costFunction` - Cost function used for scoring.
 
-### validateSampleInputDimensions
+Returns: Cumulative error across all samples.
+
+### evaluateSingleSample
 
 ```ts
-validateSampleInputDimensions(
+evaluateSingleSample(
   network: default,
   sample: TestSample,
-): void
+  costFunction: CostFunction,
+): number
 ```
 
-Validate one sample input vector size.
+Evaluate a single sample and return its cost.
 
 Parameters:
 - `network` - Bound network instance.
 - `sample` - Evaluation sample.
+- `costFunction` - Cost function used for scoring.
 
-### validateSampleOutputDimensions
+Returns: Error for the sample.
+
+### resetHiddenMasks
 
 ```ts
-validateSampleOutputDimensions(
+resetHiddenMasks(
   network: default,
-  sample: TestSample,
 ): void
 ```
 
-Validate one sample output vector size.
+Force hidden-node masks to active state for deterministic testing.
 
 Parameters:
 - `network` - Bound network instance.
-- `sample` - Evaluation sample.
 
 ### resolveCostFunction
 
@@ -159,102 +153,108 @@ Parameters:
 
 Returns: Cost function used for test evaluation.
 
-### resetHiddenMasks
+### restoreDropout
 
 ```ts
-resetHiddenMasks(
+restoreDropout(
   network: default,
+  previousDropout: number,
 ): void
 ```
 
-Force hidden-node masks to active state for deterministic testing.
+Restore dropout value after test evaluation.
 
 Parameters:
 - `network` - Bound network instance.
+- `previousDropout` - Dropout value to restore.
 
-### disableDropoutForTesting
+### testNetwork
 
 ```ts
-disableDropoutForTesting(
-  network: default,
-): number
+testNetwork(
+  set: TestSample[],
+  cost: CostFunction | undefined,
+): TestNetworkResult
 ```
 
-Disable dropout while preserving previous runtime dropout value.
+Evaluate a dataset and return average error and elapsed time.
 
 Parameters:
-- `network` - Bound network instance.
+- `this` - Bound network instance.
+- `set` - Evaluation samples.
+- `cost` - Optional cost function override.
 
-Returns: Previous dropout value.
+Returns: Mean error and evaluation duration.
 
-### restoreDropout
+### validateAllSampleDimensions
 
 ```ts
-restoreDropout(
+validateAllSampleDimensions(
   network: default,
-  previousDropout: number,
+  testSet: TestSample[],
 ): void
 ```
 
-Restore dropout value after test evaluation.
+Validate input and output dimensions for every sample.
 
 Parameters:
 - `network` - Bound network instance.
-- `previousDropout` - Dropout value to restore.
+- `testSet` - Evaluation sample set.
 
-### evaluateSamples
+### validateSampleInputDimensions
 
 ```ts
-evaluateSamples(
+validateSampleInputDimensions(
   network: default,
-  testSet: TestSample[],
-  costFunction: CostFunction,
-): number
+  sample: TestSample,
+): void
 ```
 
-Evaluate all test samples and accumulate total cost.
+Validate one sample input vector size.
 
 Parameters:
 - `network` - Bound network instance.
-- `testSet` - Evaluation sample set.
-- `costFunction` - Cost function used for scoring.
-
-Returns: Cumulative error across all samples.
+- `sample` - Evaluation sample.
 
-### evaluateSingleSample
+### validateSampleOutputDimensions
 
 ```ts
-evaluateSingleSample(
+validateSampleOutputDimensions(
   network: default,
   sample: TestSample,
-  costFunction: CostFunction,
-): number
+): void
 ```
 
-Evaluate a single sample and return its cost.
+Validate one sample output vector size.
 
 Parameters:
 - `network` - Bound network instance.
 - `sample` - Evaluation sample.
-- `costFunction` - Cost function used for scoring.
-
-Returns: Error for the sample.
 
-### createTestResult
+### validateTestSet
 
 ```ts
-createTestResult(
-  cumulativeError: number,
-  sampleCount: number,
-  startTime: number,
-): TestNetworkResult
+validateTestSet(
+  network: default,
+  testSet: TestSample[],
+): void
 ```
 
-Build the final test result payload.
+Validate that the evaluation set exists and each sample matches network dimensions.
 
 Parameters:
-- `cumulativeError` - Cumulative sample error.
-- `sampleCount` - Number of evaluated samples.
-- `startTime` - Evaluation start timestamp.
+- `network` - Bound network instance.
+- `testSet` - Evaluation sample set.
 
-Returns: Mean error and elapsed duration.
+### validateTestSetPresence
+
+```ts
+validateTestSetPresence(
+  testSet: TestSample[],
+): void
+```
+
+Validate that the test set is a non-empty array.
+
+Parameters:
+- `testSet` - Evaluation sample set.