UNPKG

1.56 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2020 Google Inc. 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 */
17/// <amd-module name="@tensorflow/tfjs-core/dist/ops/arg_max" />
18import { Tensor } from '../tensor';
19import { TensorLike } from '../types';
20/**
21 * Returns the indices of the maximum values along an `axis`.
22 *
23 * The result has the same shape as `input` with the dimension along `axis`
24 * removed.
25 *
26 * ```js
27 * const x = tf.tensor1d([1, 2, 3]);
28 *
29 * x.argMax().print(); // or tf.argMax(x)
30 * ```
31 *
32 * ```js
33 * const x = tf.tensor2d([1, 2, 4, 3], [2, 2]);
34 *
35 * const axis = 1;
36 * x.argMax(axis).print(); // or tf.argMax(x, axis)
37 * ```
38 *
39 * @param x The input tensor.
40 * @param axis The dimension to reduce. Defaults to 0 (outer-most dimension).
41 *
42 * @doc {heading: 'Operations', subheading: 'Reduction'}
43 */
44declare function argMax_<T extends Tensor>(x: Tensor | TensorLike, axis?: number): T;
45export declare const argMax: typeof argMax_;
46export {};