Skip to content

Commit 693bd0b

Browse files
committed
Update tests and documentation
Update tests and documentation to reflect recent change from `Autoencoder.includesAnomalies` to `Autoencoder.likelyIncludesAnomalies` as the method makes no API guarantee to detect anomalies with 100% accuracy
1 parent cd0ad75 commit 693bd0b

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -362,8 +362,8 @@ const data = net.denoise(noisyData);
362362
Test for anomalies in data samples:
363363

364364
```javascript
365-
const shouldBeFalse = net.includesAnomalies([0, 1, 1]);
366-
const shouldBeTrue = net.includesAnomalies([0, 1, 0]);
365+
const shouldBeFalse = net.likelyIncludesAnomalies([0, 1, 1]);
366+
const shouldBeTrue = net.likelyIncludesAnomalies([0, 1, 0]);
367367
```
368368

369369
### Training Options

src/autoencoder-gpu.test.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,12 @@ test('encode and decode a data sample', async () => {
6565
test('test a data sample for anomalies', async () => {
6666
expect(result.error).toBeLessThanOrEqual(errorThresh);
6767

68-
function includesAnomalies(...args: number[]) {
68+
function likelyIncludesAnomalies(...args: number[]) {
6969
expect(xornet.likelyIncludesAnomalies(args, 0.5)).toBe(false);
7070
}
7171

72-
includesAnomalies(0, 0, 0);
73-
includesAnomalies(0, 1, 1);
74-
includesAnomalies(1, 0, 1);
75-
includesAnomalies(1, 1, 0);
72+
likelyIncludesAnomalies(0, 0, 0);
73+
likelyIncludesAnomalies(0, 1, 1);
74+
likelyIncludesAnomalies(1, 0, 1);
75+
likelyIncludesAnomalies(1, 1, 0);
7676
});

src/autoencoder.test.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,12 @@ test('encode and decode a data sample', async () => {
6565
test('test a data sample for anomalies', async () => {
6666
expect(result.error).toBeLessThanOrEqual(errorThresh);
6767

68-
function includesAnomalies(...args: number[]) {
68+
function likelyIncludesAnomalies(...args: number[]) {
6969
expect(xornet.likelyIncludesAnomalies(args, 0.5)).toBe(false);
7070
}
7171

72-
includesAnomalies(0, 0, 0);
73-
includesAnomalies(0, 1, 1);
74-
includesAnomalies(1, 0, 1);
75-
includesAnomalies(1, 1, 0);
72+
likelyIncludesAnomalies(0, 0, 0);
73+
likelyIncludesAnomalies(0, 1, 1);
74+
likelyIncludesAnomalies(1, 0, 1);
75+
likelyIncludesAnomalies(1, 1, 0);
7676
});

0 commit comments

Comments
 (0)