UNPKG

1.38 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 * Stacks a list of rank-`R` `tf.Tensor`s into one rank-`(R+1)` `tf.Tensor`.
21 *
22 * ```js
23 * const a = tf.tensor1d([1, 2]);
24 * const b = tf.tensor1d([3, 4]);
25 * const c = tf.tensor1d([5, 6]);
26 * tf.stack([a, b, c]).print();
27 * ```
28 *
29 * @param tensors A list of tensor objects with the same shape and dtype.
30 * @param axis The axis to stack along. Defaults to 0 (the first dim).
31 *
32 * @doc {heading: 'Tensors', subheading: 'Slicing and Joining'}
33 */
34declare function stack_<T extends Tensor>(tensors: Array<T | TensorLike>, axis?: number): Tensor;
35export declare const stack: typeof stack_;
36export {};