UNPKG

1.39 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 * Returns a `tf.Tensor` that has expanded rank, by inserting a dimension
21 * into the tensor's shape.
22 *
23 * ```js
24 * const x = tf.tensor1d([1, 2, 3, 4]);
25 * const axis = 1;
26 * x.expandDims(axis).print();
27 * ```
28 *
29 * @param x The input tensor whose dimensions to be expanded.
30 * @param axis The dimension index at which to insert shape of `1`. Defaults
31 * to 0 (the first dimension).
32 *
33 * @doc {heading: 'Tensors', subheading: 'Transformations'}
34 */
35declare function expandDims_<T extends Tensor>(x: Tensor | TensorLike, axis?: number): T;
36export declare const expandDims: typeof expandDims_;
37export {};