@tensorflow/tfjs-core
Version:
Hardware-accelerated JavaScript library for machine intelligence
48 lines (47 loc) • 1.74 kB
TypeScript
/**
* @license
* Copyright 2023 Google LLC.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* =============================================================================
*/
/// <amd-module name="@tensorflow/tfjs-core/dist/ops/ensure_shape" />
import { Tensor } from '../tensor';
import { Rank, ShapeMap } from '../types';
/**
* Checks the input tensor mathes the given shape.
*
* Given an input tensor, returns a new tensor with the same values as the
* input tensor with shape `shape`.
*
* The method supports the null value in tensor. It will still check the shapes,
* and null is a placeholder.
*
*
* ```js
* const x = tf.tensor1d([1, 2, 3, 4]);
* const y = tf.tensor1d([1, null, 3, 4]);
* const z = tf.tensor2d([1, 2, 3, 4], [2,2]);
* tf.ensureShape(x, [4]).print();
* tf.ensureShape(y, [4]).print();
* tf.ensureShape(z, [null, 2]).print();
* ```
*
* @param x The input tensor to be ensured.
* @param shape A TensorShape representing the shape of this tensor, an array
* or null.
*
* @doc {heading: 'Tensors', subheading: 'Transformations'}
*/
declare function ensureShape_<R extends Rank>(x: Tensor, shape: ShapeMap[R]): Tensor;
export declare const ensureShape: typeof ensureShape_;
export {};