Skip to content

argmax

Argmax

Bases: TensorOp

Get the argmax from a tensor (supports multi-io).

Parameters:

Name Type Description Default
inputs Union[str, List[str]]

The tensor(s) to gather values from.

required
outputs Union[str, List[str]]

The key(s) under which to save the output.

required
axis int

The axis along which to collect the argmax.

0
mode Union[None, str, Iterable[str]]

What mode(s) to execute this Op in. For example, "train", "eval", "test", or "infer". To execute regardless of mode, pass None. To execute in all modes except for a particular one, you can pass an argument like "!infer" or "!train".

None
ds_id Union[None, str, Iterable[str]]

What dataset id(s) to execute this Op in. To execute regardless of ds_id, pass None. To execute in all ds_ids except for a particular one, you can pass an argument like "!ds1".

None
Source code in fastestimator/fastestimator/op/tensorop/argmax.py
@traceable()
class Argmax(TensorOp):
    """Get the argmax from a tensor (supports multi-io).

    Args:
        inputs: The tensor(s) to gather values from.
        outputs: The key(s) under which to save the output.
        axis: The axis along which to collect the argmax.
        mode: What mode(s) to execute this Op in. For example, "train", "eval", "test", or "infer". To execute
            regardless of mode, pass None. To execute in all modes except for a particular one, you can pass an argument
            like "!infer" or "!train".
        ds_id: What dataset id(s) to execute this Op in. To execute regardless of ds_id, pass None. To execute in all
            ds_ids except for a particular one, you can pass an argument like "!ds1".
    """
    def __init__(self,
                 inputs: Union[str, List[str]],
                 outputs: Union[str, List[str]],
                 axis: int = 0,
                 mode: Union[None, str, Iterable[str]] = None,
                 ds_id: Union[None, str, Iterable[str]] = None):
        super().__init__(inputs=inputs, outputs=outputs, mode=mode, ds_id=ds_id)
        self.axis = axis
        self.in_list, self.out_list = True, True

    def forward(self, data: List[Tensor], state: Dict[str, Any]) -> List[Tensor]:
        return [argmax(tensor=tensor, axis=self.axis) for tensor in data]