UNPKG

1.75 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2018 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/dropout" />
18import { Tensor } from '../tensor';
19import { TensorLike } from '../types';
20/**
21 * Computes dropout.
22 *
23 * ```js
24 * const x = tf.tensor1d([1, 2, 2, 1]);
25 * const rate = 0.75;
26 * const output = tf.dropout(x, rate);
27 * output.print();
28 * ```
29 *
30 * @param x A floating point Tensor or TensorLike.
31 * @param rate A float in the range [0, 1). The probability that each element
32 * of x is discarded.
33 * @param noiseShape An array of numbers of type int32, representing the
34 * shape for randomly generated keep/drop flags. If the noiseShape has null
35 * value, it will be automatically replaced with the x's relative dimension
36 * size. Optional.
37 * @param seed Used to create random seeds. Optional.
38 * @returns A Tensor of the same shape of x.
39 *
40 * @doc {heading: 'Operations', subheading: 'Dropout'}
41 */
42declare function dropout_(x: Tensor | TensorLike, rate: number, noiseShape?: number[], seed?: number | string): Tensor;
43export declare const dropout: typeof dropout_;
44export {};