UNPKG

1.32 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/zeros" />
18import { Tensor } from '../tensor';
19import { DataType, Rank, ShapeMap } from '../types';
20/**
21 * Creates a `tf.Tensor` with all elements set to 0.
22 *
23 * ```js
24 * tf.zeros([2, 2]).print();
25 * ```
26 *
27 * @param shape An array of integers defining the output tensor shape.
28 * @param dtype The type of an element in the resulting tensor. Can
29 * be 'float32', 'int32' or 'bool'. Defaults to 'float'.
30 *
31 * @doc {heading: 'Tensors', subheading: 'Creation'}
32 */
33export declare function zeros<R extends Rank>(shape: ShapeMap[R], dtype?: DataType): Tensor<R>;