UNPKG

1.88 kBJavaScriptView 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 { ENGINE } from '../engine';
18import { Pack } from '../kernel_names';
19import { convertToTensorArray } from '../tensor_util_env';
20import * as util from '../util';
21import { op } from './operation';
22/**
23 * Stacks a list of rank-`R` `tf.Tensor`s into one rank-`(R+1)` `tf.Tensor`.
24 *
25 * ```js
26 * const a = tf.tensor1d([1, 2]);
27 * const b = tf.tensor1d([3, 4]);
28 * const c = tf.tensor1d([5, 6]);
29 * tf.stack([a, b, c]).print();
30 * ```
31 *
32 * @param tensors A list of tensor objects with the same shape and dtype.
33 * @param axis The axis to stack along. Defaults to 0 (the first dim).
34 *
35 * @doc {heading: 'Tensors', subheading: 'Slicing and Joining'}
36 */
37function stack_(tensors, axis = 0) {
38 const $tensors = convertToTensorArray(tensors, 'tensors', 'stack', 'string_or_numeric');
39 util.assert($tensors.length >= 1, () => 'Pass at least one tensor to tf.stack');
40 if ($tensors.length > 0) {
41 util.assert(axis <= $tensors[0].rank, () => 'Axis must be <= rank of the tensor');
42 }
43 const inputs = $tensors;
44 const attrs = { axis };
45 return ENGINE.runKernel(Pack, inputs, attrs);
46}
47export const stack = op({ stack_ });
48//# sourceMappingURL=stack.js.map
\No newline at end of file