UNPKG

1.53 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 { Tensor2D } from '../tensor';
18import { DataType } from '../types';
19/**
20 * Create an identity matrix.
21 *
22 * @param numRows Number of rows.
23 * @param numColumns Number of columns. Defaults to `numRows`.
24 * @param batchShape If provided, will add the batch shape to the beginning
25 * of the shape of the returned `tf.Tensor` by repeating the identity
26 * matrix.
27 * @param dtype Data type.
28 * @returns Identity matrix of the specified size and data type, possibly
29 * with batch repetition if `batchShape` is specified.
30 *
31 * @doc {heading: 'Tensors', subheading: 'Creation'}
32 */
33declare function eye_(numRows: number, numColumns?: number, batchShape?: [number] | [number, number] | [number, number, number] | [number, number, number, number], dtype?: DataType): Tensor2D;
34export declare const eye: typeof eye_;
35export {};