146 lines
16 KiB
JavaScript
Raw Permalink Normal View History

2024-10-15 23:05:53 +03:00
/**
* @license
* Copyright 2018 Google LLC
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE file or at
* https://opensource.org/licenses/MIT.
* =============================================================================
*/
/**
* Testing utilities.
*/
import { memory, Tensor, test_util, util } from '@tensorflow/tfjs-core';
// tslint:disable-next-line: no-imports-from-dist
import { ALL_ENVS, describeWithFlags } from '@tensorflow/tfjs-core/dist/jasmine_util';
import { ValueError } from '../errors';
/**
* Expect values are close between a Tensor or number array.
* @param actual
* @param expected
*/
export function expectTensorsClose(actual, expected, epsilon) {
if (actual == null) {
throw new ValueError('First argument to expectTensorsClose() is not defined.');
}
if (expected == null) {
throw new ValueError('Second argument to expectTensorsClose() is not defined.');
}
if (actual instanceof Tensor && expected instanceof Tensor) {
if (actual.dtype !== expected.dtype) {
throw new Error(`Data types do not match. Actual: '${actual.dtype}'. ` +
`Expected: '${expected.dtype}'`);
}
if (!util.arraysEqual(actual.shape, expected.shape)) {
throw new Error(`Shapes do not match. Actual: [${actual.shape}]. ` +
`Expected: [${expected.shape}].`);
}
}
const actualData = actual instanceof Tensor ? actual.dataSync() : actual;
const expectedData = expected instanceof Tensor ? expected.dataSync() : expected;
test_util.expectArraysClose(actualData, expectedData, epsilon);
}
/**
* Expect values are not close between a Tensor or number array.
* @param t1
* @param t2
*/
export function expectTensorsNotClose(t1, t2, epsilon) {
try {
expectTensorsClose(t1, t2, epsilon);
}
catch (error) {
return;
}
throw new Error('The two values are close at all elements.');
}
/**
* Expect values in array are within a specified range, boundaries inclusive.
* @param actual
* @param expected
*/
export function expectTensorsValuesInRange(actual, low, high) {
if (actual == null) {
throw new ValueError('First argument to expectTensorsClose() is not defined.');
}
test_util.expectValuesInRange(actual.dataSync(), low, high);
}
/**
* Describe tests to be run on CPU and GPU.
* @param testName
* @param tests
*/
export function describeMathCPUAndGPU(testName, tests) {
describeWithFlags(testName, ALL_ENVS, () => {
tests();
});
}
/**
* Describe tests to be run on CPU and GPU WebGL2.
* @param testName
* @param tests
*/
export function describeMathCPUAndWebGL2(testName, tests) {
describeWithFlags(testName, {
predicate: testEnv => (testEnv.flags == null || testEnv.flags['WEBGL_VERSION'] === 2)
}, () => {
tests();
});
}
/**
* Describe tests to be run on CPU only.
* @param testName
* @param tests
*/
export function describeMathCPU(testName, tests) {
describeWithFlags(testName, { predicate: testEnv => testEnv.backendName === 'cpu' }, () => {
tests();
});
}
/**
* Describe tests to be run on GPU only.
* @param testName
* @param tests
*/
export function describeMathGPU(testName, tests) {
describeWithFlags(testName, { predicate: testEnv => testEnv.backendName === 'webgl' }, () => {
tests();
});
}
/**
* Describe tests to be run on WebGL2 GPU only.
* @param testName
* @param tests
*/
export function describeMathWebGL2(testName, tests) {
describeWithFlags(testName, {
predicate: testEnv => testEnv.backendName === 'webgl' &&
(testEnv.flags == null || testEnv.flags['WEBGL_VERSION'] === 2)
}, () => {
tests();
});
}
/**
* Check that a function only generates the expected number of new Tensors.
*
* The test function is called twice, once to prime any regular constants and
* once to ensure that additional copies aren't created/tensors aren't leaked.
*
* @param testFunc A fully curried (zero arg) version of the function to test.
* @param numNewTensors The expected number of new Tensors that should exist.
*/
export function expectNoLeakedTensors(
// tslint:disable-next-line:no-any
testFunc, numNewTensors) {
testFunc();
const numTensorsBefore = memory().numTensors;
testFunc();
const numTensorsAfter = memory().numTensors;
const actualNewTensors = numTensorsAfter - numTensorsBefore;
if (actualNewTensors !== numNewTensors) {
throw new ValueError(`Created an unexpected number of new ` +
`Tensors. Expected: ${numNewTensors}, created : ${actualNewTensors}. ` +
`Please investigate the discrepency and/or use tidy.`);
}
}
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdF91dGlscy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uLy4uL3RmanMtbGF5ZXJzL3NyYy91dGlscy90ZXN0X3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOzs7Ozs7OztHQVFHO0FBRUg7O0dBRUc7QUFFSCxPQUFPLEVBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxTQUFTLEVBQUUsSUFBSSxFQUFDLE1BQU0sdUJBQXVCLENBQUM7QUFDdEUsaURBQWlEO0FBQ2pELE9BQU8sRUFBQyxRQUFRLEVBQUUsaUJBQWlCLEVBQUMsTUFBTSx5Q0FBeUMsQ0FBQztBQUVwRixPQUFPLEVBQUMsVUFBVSxFQUFDLE1BQU0sV0FBVyxDQUFDO0FBRXJDOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsa0JBQWtCLENBQzlCLE1BQXVCLEVBQUUsUUFBeUIsRUFBRSxPQUFnQjtJQUN0RSxJQUFJLE1BQU0sSUFBSSxJQUFJLEVBQUU7UUFDbEIsTUFBTSxJQUFJLFVBQVUsQ0FDaEIsd0RBQXdELENBQUMsQ0FBQztLQUMvRDtJQUNELElBQUksUUFBUSxJQUFJLElBQUksRUFBRTtRQUNwQixNQUFNLElBQUksVUFBVSxDQUNoQix5REFBeUQsQ0FBQyxDQUFDO0tBQ2hFO0lBQ0QsSUFBSSxNQUFNLFlBQVksTUFBTSxJQUFJLFFBQVEsWUFBWSxNQUFNLEVBQUU7UUFDMUQsSUFBSSxNQUFNLENBQUMsS0FBSyxLQUFLLFFBQVEsQ0FBQyxLQUFLLEVBQUU7WUFDbkMsTUFBTSxJQUFJLEtBQUssQ0FDWCxxQ0FBcUMsTUFBTSxDQUFDLEtBQUssS0FBSztnQkFDdEQsY0FBYyxRQUFRLENBQUMsS0FBSyxHQUFHLENBQUMsQ0FBQztTQUN0QztRQUNELElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQyxLQUFLLEVBQUUsUUFBUSxDQUFDLEtBQUssQ0FBQyxFQUFFO1lBQ25ELE1BQU0sSUFBSSxLQUFLLENBQ1gsaUNBQWlDLE1BQU0sQ0FBQyxLQUFLLEtBQUs7Z0JBQ2xELGNBQWMsUUFBUSxDQUFDLEtBQUssSUFBSSxDQUFDLENBQUM7U0FDdkM7S0FDRjtJQUNELE1BQU0sVUFBVSxHQUFHLE1BQU0sWUFBWSxNQUFNLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDO0lBQ3pFLE1BQU0sWUFBWSxHQUNkLFFBQVEsWUFBWSxNQUFNLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDLENBQUMsUUFBUSxDQUFDO0lBQ2hFLFNBQVMsQ0FBQyxpQkFBaUIsQ0FBQyxVQUFVLEVBQUUsWUFBWSxFQUFFLE9BQU8sQ0FBQyxDQUFDO0FBQ2pFLENBQUM7QUFFRDs7OztHQUlHO0FBQ0gsTUFBTSxVQUFVLHFCQUFxQixDQUNuQyxFQUFtQixFQUFFLEVBQW1CLEVBQUUsT0FBZ0I7SUFDNUQsSUFBSTtRQUNGLGtCQUFrQixDQUFDLEVBQUUsRUFBRSxFQUFFLEVBQUUsT0FBTyxDQUFDLENBQUM7S0FDckM7SUFBQyxPQUFPLEtBQUssRUFBRTtRQUNkLE9BQU87S0FDUjtJQUNELE1BQU0sSUFBSSxLQUFLLENBQUMsMkNBQTJDLENBQUMsQ0FBQztBQUM3RCxDQUFDO0FBRUQ7Ozs7R0FJRztBQUNILE1BQU0sVUFBVSwwQkFBMEIsQ0FDdEMsTUFBYyxFQUFFLEdBQVcsRUFBRSxJQUFZO0lBQzNDLElBQUksTUFBTSxJQUFJLElBQUksRUFBRTtRQUNsQixNQUFNLElBQUksVUFBVSxDQUNoQix3REFBd0QsQ0FBQyxDQUFDO0tBQy9EO0lBQ0QsU0FBUyxDQUFDLG1CQUFtQixDQUFDLE1BQU0sQ0FBQyxRQUFRLEVBQUUsRUFBRSxHQUFHLEVBQUUsSUFBSSxDQUFDLENBQUM7QUFDOUQsQ0FBQztBQUVEOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUscUJBQXFCLENBQUMsUUFBZ0IsRUFBRSxLQUFpQjtJQUN2RSxpQkFBaUIsQ0FBQyxRQUFRLEVBQUUsUUFBUSxFQUFFLEdBQUcsRUFBRTtRQUN6QyxLQUFLLEVBQUUsQ0FBQztJQUNWLENBQUMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQztBQUVEOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsd0JBQXdCLENBQUMsUUFBZ0IsRUFBRSxLQUFpQjtJQUMxRSxpQkFBaUIsQ0FDYixRQUFRLEVBQUU7UUFDUixTQUFTLEVBQUUsT0FBTyxDQUFDLEVBQUUsQ0FDakIsQ0FBQyxPQUFPLENBQUMsS0FBSyxJQUFJLElBQUksSUFBSSxPQUFPLENBQUMsS0FBSyxDQUFDLGVBQWUsQ0FBQyxLQUFLLENBQUMsQ0FBQztLQUNwRSxFQUNELEdBQUcsRUFBRTtRQUNILEtBQUssRUFBRSxDQUFDO0lBQ1YsQ0FBQyxDQUFDLENBQUM7QUFDVCxDQUFDO0FBRUQ7Ozs7R0FJRztBQUNILE1BQU0sVUFBVSxlQUFlLENBQUMsUUFBZ0IsRUFBRSxLQUFpQjtJQUNqRSxpQkFBaUIsQ0FDYixRQUFRLEVBQUUsRUFBQyxTQUFTLEVBQUUsT0FBTyxDQUFDLEVBQUUsQ0FBQyxPQUFPLENBQUMsV0FBVyxLQUFLLEtBQUssRUFBQyxFQUFFLEdBQUcsRUFBRTtRQUNwRSxLQUFLLEVBQUUsQ0FBQztJQUNWLENBQUMsQ0FBQyxDQUFDO0FBQ1QsQ0FBQztBQUVEOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsZUFBZSxDQUFDLFFBQWdCLEVBQUUsS0FBaUI7SUFDakUsaUJBQWlCLENBQ2IsUUFBUSxFQUFFLEVBQUMsU0FBUyxFQUFFLE9BQU8sQ0FBQyxFQUFFLENBQUMsT0FBTyxDQUFDLFdBQVcsS0FBSyxPQUFPLEVBQUMsRUFBRSxHQUFHLEVBQUU7UUFDdEUsS0FBSyxFQUFFLENBQUM7SUFDVixDQUFDLENBQUMsQ0FBQztBQUNULENBQUM7QUFFRDs7OztHQUlHO0FBQ0gsTUFBTSxVQUFVLGtCQUFrQixDQUFDLFFBQWdCLEVBQUUsS0FBaUI7SUFDcEUsaUJBQWlCLENBQ2IsUUFBUSxFQUFFO1FBQ1IsU0FBUyxFQUFFLE9BQU8sQ0FBQyxFQUFFLENBQUMsT0FBTyxDQUFDLFdBQVcsS0FBSyxPQUFPO1lBQ2pELENBQUMsT0FBTyxDQUFDLEtBQUssSUFBSSxJQUFJLElBQUksT0FBTyxDQUFDLEtBQUssQ0FBQyxlQUFlLENBQUMsS0FBSyxDQUFDLENBQUM7S0FFcEUsRUFDRCxHQUFHLEVBQUU7UUFDSCxLQUFLLEVBQUUsQ0FBQztJQUNWLENBQUMsQ0FBQyxDQUFDO0FBQ1QsQ0FBQztBQUVEOzs7Ozs7OztHQVFHO0FBQ0gsTUFBTSxVQUFVLHFCQUFxQjtBQUNqQyxrQ0FBa0M7QUFDbEMsUUFBbUIsRUFBRSxhQUFxQjtJQUM1QyxRQUFRLEVBQUUsQ0FBQztJQUNYLE1BQU0sZ0JBQWdCLEdBQUcsTUFBTSxFQUFFLENBQUMsVUFBVSxDQUFDO0lBQzdDLFFBQVEsRUFBRSxDQUFDO0lBQ1gsTUFBTSxlQUFlL