tensor.argmax

   fn argmax(self: @Tensor<T>, axis: i32, keepdims: Option<bool>, select_last_index: Option<bool>) -> Tensor<i32>;

Returns the index of the maximum value along the specified axis.

Args

  • self(@Tensor<T>) - The input tensor.

  • axis(i32) - The axis along which to compute the argmax.

  • keepdims(Option<bool>) - If true, retains reduced dimensions with length 1. Defaults to true.

  • select_last_index(Option<bool>) - If true, the index of the last occurrence of the maximum value is returned. Defaults to false.

Panics

  • Panics if axis is not in the range of the input tensor's dimensions.

Returns

A new Tensor<T> instance containing the indices of the maximum values along the specified axis.

Examples

Case 1: argmax with default parameters

use core::array::{ArrayTrait, SpanTrait};

use orion::operators::tensor::{TensorTrait, Tensor, U32Tensor};

fn argmax_example() -> Tensor<usize> {
    let tensor = TensorTrait::<u32>::new(
        shape: array![2, 2, 2].span(), data: array![0, 1, 2, 3, 4, 4, 5, 5].span(),
    );

    // We can call `argmax` function as follows.
    return tensor.argmax(axis: 2, keepdims: Option::None(()), select_last_index: Option::None(()));
}
>>> [[[1,1],[0,0]]]

Case 2: argmax with keepdims set to false

use core::array::{ArrayTrait, SpanTrait};

use orion::operators::tensor::{TensorTrait, Tensor, U32Tensor};

fn argmax_example() -> Tensor<usize> {
    let tensor = TensorTrait::<u32>::new(
        shape: array![2, 2, 2].span(), data: array![0, 1, 2, 3, 4, 4, 5, 5].span(),
    );

    // We can call `argmax` function as follows.
    return tensor
        .argmax(axis: 2, keepdims: Option::Some(false), select_last_index: Option::None(()));
}
>>> [[1,1],[0,0]]

Case 3: argmax with select_last_index set to true

use core::array::{ArrayTrait, SpanTrait};

use orion::operators::tensor::{TensorTrait, Tensor, U32Tensor};

fn argmax_example() -> Tensor<usize> {
    let tensor = TensorTrait::<u32>::new(
        shape: array![2, 2, 2].span(), data: array![0, 1, 2, 3, 4, 4, 5, 5].span(),
    );

    // We can call `argmax` function as follows.
    return tensor
        .argmax(axis: 2, keepdims: Option::None(()), select_last_index: Option::Some(true));
}
>>> [[[1,1],[1,1]]]

Last updated