UNPKG

1.57 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2020 Google LLC. All Rights Reserved.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 * =============================================================================
16 */
17import { Tensor } from '../tensor';
18import { TensorLike } from '../types';
19/**
20 * Calculates the mean and variance of `x`. The mean and variance are
21 * calculated by aggregating the contents of `x` across `axes`. If `x` is
22 * 1-D and `axes = [0]` this is just the mean and variance of a vector.
23 *
24 * @param x The input tensor.
25 * @param axis The dimension(s) along with to compute mean and
26 * variance. By default it reduces all dimensions.
27 * @param keepDims If true, the moments have the same dimensionality as the
28 * input.
29 * @return An object with two keys: `mean` and `variance`.
30 *
31 * @doc {heading: 'Operations', subheading: 'Normalization'}
32 */
33declare function moments_(x: Tensor | TensorLike, axis?: number | number[], keepDims?: boolean): {
34 mean: Tensor;
35 variance: Tensor;
36};
37export declare const moments: typeof moments_;
38export {};