einx.softmax

Contents

einx.softmax#

einx.softmax(description, tensor, *, backend=None, **parameters)[source]#

Compute the softmax of values in the given tensor.

The elementary operation has the signature [...] -> [...] and computes the softmax over all input values.

If there is no output expression, it is chosen to be the same as the input expression. For example, the following operations compute the same output:

y = einx.softmax("a [b]", x)
y = einx.softmax("a [b] -> a [b]", x)
Parameters:
  • description (str) – Description string for the operation in einx notation.

  • tensor (Tensor) – Input tensor or tensor factory matching the description string.

  • backend (Union[Backend, str, None]) – Backend to use for all operations. If None, uses the default backend for the given setting. Defaults to None.

  • graph – Whether to return the compiled code representation of this operation instead of computing the result. Defaults to False.

  • **parameters (Union[_Buffer, _SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[bool | int | float | complex | str | bytes]]) – Additional parameters that specify dimension sizes, e.g. a=4.

Return type:

Tensor

Returns:

The result of the operation if graph=False, otherwise the compiled code representation of the operation.