UNPKG

1.82 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 */
17/// <amd-module name="@tensorflow/tfjs-core/dist/ops/truncated_normal" />
18import { Tensor } from '../tensor';
19import { Rank, ShapeMap } from '../types';
20/**
21 * Creates a `tf.Tensor` with values sampled from a truncated normal
22 * distribution.
23 *
24 * ```js
25 * tf.truncatedNormal([2, 2]).print();
26 * ```
27 *
28 * The generated values follow a normal distribution with specified mean and
29 * standard deviation, except that values whose magnitude is more than 2
30 * standard deviations from the mean are dropped and re-picked.
31 *
32 * @param shape An array of integers defining the output tensor shape.
33 * @param mean The mean of the normal distribution.
34 * @param stdDev The standard deviation of the normal distribution.
35 * @param dtype The data type of the output tensor.
36 * @param seed The seed for the random number generator.
37 *
38 * @doc {heading: 'Tensors', subheading: 'Creation'}
39 */
40declare function truncatedNormal_<R extends Rank>(shape: ShapeMap[R], mean?: number, stdDev?: number, dtype?: 'float32' | 'int32', seed?: number): Tensor<R>;
41export declare const truncatedNormal: typeof truncatedNormal_;
42export {};