Nx
Nx v0.5.1

View Source Nx.Backend behaviour (Nx v0.5.1)

The behaviour for tensor backends.

Each backend is module that defines a struct and implements the callbacks defined in this module. The callbacks are mostly implementations of the functions in the Nx module with the tensor output shape given as first argument.

Nx backends come in two flavors: opaque backends, of which you should not access its data directly except through the functions in the Nx module, and public ones, of which its data can be directly accessed and traversed. The former typically have the Backend suffix.

Nx ships with the following backends:

  • Nx.BinaryBackend - an opaque backend written in pure Elixir that stores the data in Elixir's binaries. This is the default backend used by the Nx module. The backend itself (and its data) is private and must not be accessed directly.

  • Nx.TemplateBackend - an opaque backend written that works as a template in APIs to declare the type, shape, and names of tensors to be expected in the future.

  • Nx.Defn.Expr - a public backend used by defn to build expression trees that are traversed by custom compilers.

This module also includes functions that are meant to be shared across backends.

Link to this section Summary

Types

axes()
axis()
backend_options()
shape()
t()
tensor()

Callbacks

abs(out, tensor)
acos(out, tensor)
acosh(out, tensor)
add(out, tensor, tensor)
all(out, tensor, keyword)
all_close(out, tensor, tensor, keyword)
any(out, tensor, keyword)
argmax(out, tensor, keyword)
argmin(out, tensor, keyword)
argsort(out, tensor, keyword)
as_type(out, tensor)
asin(out, tensor)
asinh(out, tensor)
atan2(out, tensor, tensor)
atan(out, tensor)
atanh(out, tensor)
backend_copy(tensor, module, backend_options)
backend_deallocate(tensor)
backend_transfer(tensor, module, backend_options)
bitcast(out, tensor)
bitwise_and(out, tensor, tensor)
bitwise_not(out, tensor)
bitwise_or(out, tensor, tensor)
bitwise_xor(out, tensor, tensor)
broadcast(out, tensor, shape, axes)
cbrt(out, tensor)
ceil(out, tensor)
cholesky(out, tensor)
clip(out, tensor, min, max)
concatenate(out, tensor, axis)
conjugate(out, tensor)
constant(out, arg2, backend_options)
conv(out, tensor, kernel, keyword)
cos(out, tensor)
cosh(out, tensor)
count_leading_zeros(out, tensor)
cumulative_max(out, t, keyword)
cumulative_min(out, t, keyword)
cumulative_product(out, t, keyword)
cumulative_sum(out, t, keyword)
determinant(out, t)
divide(out, tensor, tensor)
dot(out, tensor, axes, axes, tensor, axes, axes)
eigh({}, tensor, keyword)
equal(out, tensor, tensor)
erf(out, tensor)
erf_inv(out, tensor)
erfc(out, tensor)
exp(out, tensor)
expm1(out, tensor)
eye(tensor, backend_options)
fft(out, tensor, keyword)
floor(out, tensor)
from_binary(out, binary, backend_options)
gather(out, input, indices)
greater(out, tensor, tensor)
greater_equal(out, tensor, tensor)
ifft(out, tensor, keyword)
imag(out, tensor)
indexed_add(out, target, indices, updates)
indexed_put(out, target, indices, updates)
init(keyword)
inspect(tensor, t)
iota(tensor, arg2, backend_options)
is_infinity(out, tensor)
is_nan(out, tensor)
left_shift(out, tensor, tensor)
less(out, tensor, tensor)
less_equal(out, tensor, tensor)
log1p(out, tensor)
log(out, tensor)
logical_and(out, tensor, tensor)
logical_not(out, t)
logical_or(out, tensor, tensor)
logical_xor(out, tensor, tensor)
lu({}, tensor, keyword)
map(out, tensor, keyword, function)
max(out, tensor, tensor)
min(out, tensor, tensor)
multiply(out, tensor, tensor)
negate(out, tensor)
not_equal(out, tensor, tensor)
optional(atom, list, function)

Invoked for execution of optional callbacks with a default implementation.

pad(out, tensor, pad_value, padding_config)
phase(out, t)
population_count(out, tensor)
pow(out, tensor, tensor)
product(out, tensor, keyword)
put_slice(out, tensor, tensor, list)
qr({}, tensor, keyword)
quotient(out, tensor, tensor)
random_normal(tensor, mu, sigma, backend_options)
random_uniform(tensor, tensor, tensor, backend_options)
real(out, tensor)
reduce(out, tensor, acc, keyword, function)
reduce_max(out, tensor, keyword)
reduce_min(out, tensor, keyword)
remainder(out, tensor, tensor)
reshape(out, tensor)
reverse(out, tensor, axes)
right_shift(out, tensor, tensor)
round(out, tensor)
rsqrt(out, tensor)
select(out, tensor, tensor, tensor)
sigmoid(out, tensor)
sign(out, tensor)
sin(out, tensor)
sinh(out, tensor)
slice(out, tensor, list, list, list)
solve(out, a, b)
sort(out, tensor, keyword)
sqrt(out, tensor)
squeeze(out, tensor, axes)
subtract(out, tensor, tensor)
sum(out, tensor, keyword)
svd({}, tensor, keyword)
take(out, input, indices, axis)
take_along_axis(out, input, indices, axis)
tan(out, tensor)
tanh(out, tensor)
to_batched(out, tensor, keyword)
to_binary(tensor, limit)
top_k(out, tensor, keyword)
transpose(out, tensor, axes)
triangular_solve(out, a, b, keyword)
window_max(out, tensor, shape, keyword)
window_min(out, tensor, shape, keyword)
window_product(out, tensor, shape, keyword)
window_reduce(out, tensor, acc, shape, keyword, function)
window_scatter_max(out, tensor, tensor, tensor, shape, keyword)
window_scatter_min(out, tensor, tensor, tensor, shape, keyword)
window_sum(out, tensor, shape, keyword)

Functions

inspect(map, binary, inspect_opts)

Inspects the given tensor given by binary.

Link to this section Types

Link to this type

axes()

View Source 
@type axes() :: Nx.Tensor.axes()
Link to this type

axis()

View Source 
@type axis() :: Nx.Tensor.axis()
Link to this type

backend_options()

View Source 
@type backend_options() :: term()
Link to this type

shape()

View Source 
@type shape() :: Nx.Tensor.shape()
Link to this type

t()

View Source 
@type t() :: %{__struct__: atom()}
Link to this type

tensor()

View Source 
@type tensor() :: Nx.Tensor.t()

Link to this section Callbacks

Link to this callback

abs(out, tensor)

View Source 
@callback abs(out :: tensor(), tensor()) :: tensor()
Link to this callback

acos(out, tensor)

View Source 
@callback acos(out :: tensor(), tensor()) :: tensor()
Link to this callback

acosh(out, tensor)

View Source 
@callback acosh(out :: tensor(), tensor()) :: tensor()
Link to this callback

add(out, tensor, tensor)

View Source 
@callback add(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

all(out, tensor, keyword)

View Source 
@callback all(out :: tensor(), tensor(), keyword()) :: tensor()
Link to this callback

all_close(out, tensor, tensor, keyword)

View Source (optional) 
@callback all_close(out :: tensor(), tensor(), tensor(), keyword()) :: tensor()
Link to this callback

any(out, tensor, keyword)

View Source 
@callback any(out :: tensor(), tensor(), keyword()) :: tensor()
Link to this callback

argmax(out, tensor, keyword)

View Source 
@callback argmax(out :: tensor(), tensor(), keyword()) :: tensor()
Link to this callback

argmin(out, tensor, keyword)

View Source 
@callback argmin(out :: tensor(), tensor(), keyword()) :: tensor()
Link to this callback

argsort(out, tensor, keyword)

View Source 
@callback argsort(out :: tensor(), tensor(), keyword()) :: tensor()
Link to this callback

as_type(out, tensor)

View Source 
@callback as_type(out :: tensor(), tensor()) :: tensor()
Link to this callback

asin(out, tensor)

View Source 
@callback asin(out :: tensor(), tensor()) :: tensor()
Link to this callback

asinh(out, tensor)

View Source 
@callback asinh(out :: tensor(), tensor()) :: tensor()
Link to this callback

atan2(out, tensor, tensor)

View Source 
@callback atan2(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

atan(out, tensor)

View Source 
@callback atan(out :: tensor(), tensor()) :: tensor()
Link to this callback

atanh(out, tensor)

View Source 
@callback atanh(out :: tensor(), tensor()) :: tensor()
Link to this callback

backend_copy(tensor, module, backend_options)

View Source 
@callback backend_copy(tensor(), module(), backend_options()) :: tensor()
Link to this callback

backend_deallocate(tensor)

View Source 
@callback backend_deallocate(tensor()) :: :ok | :already_deallocated
Link to this callback

backend_transfer(tensor, module, backend_options)

View Source 
@callback backend_transfer(tensor(), module(), backend_options()) :: tensor()
Link to this callback

bitcast(out, tensor)

View Source 
@callback bitcast(out :: tensor(), tensor()) :: tensor()
Link to this callback

bitwise_and(out, tensor, tensor)

View Source 
@callback bitwise_and(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

bitwise_not(out, tensor)

View Source 
@callback bitwise_not(out :: tensor(), tensor()) :: tensor()
Link to this callback

bitwise_or(out, tensor, tensor)

View Source 
@callback bitwise_or(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

bitwise_xor(out, tensor, tensor)

View Source 
@callback bitwise_xor(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

broadcast(out, tensor, shape, axes)

View Source 
@callback broadcast(out :: tensor(), tensor(), shape(), axes()) :: tensor()
Link to this callback

cbrt(out, tensor)

View Source 
@callback cbrt(out :: tensor(), tensor()) :: tensor()
Link to this callback

ceil(out, tensor)

View Source 
@callback ceil(out :: tensor(), tensor()) :: tensor()
Link to this callback

cholesky(out, tensor)

View Source 
@callback cholesky(out :: tensor(), tensor()) :: tensor()
Link to this callback

clip(out, tensor, min, max)

View Source 
@callback clip(out :: tensor(), tensor(), min :: tensor(), max :: tensor()) :: tensor()
Link to this callback

concatenate(out, tensor, axis)

View Source 
@callback concatenate(out :: tensor(), tensor(), axis()) :: tensor()
Link to this callback

conjugate(out, tensor)

View Source 
@callback conjugate(out :: tensor(), tensor()) :: tensor()
Link to this callback

constant(out, arg2, backend_options)

View Source 
@callback constant(out :: tensor(), number() | Complex.t(), backend_options()) :: tensor()
Link to this callback

conv(out, tensor, kernel, keyword)

View Source 
@callback conv(out :: tensor(), tensor(), kernel :: tensor(), keyword()) :: tensor()
Link to this callback

cos(out, tensor)

View Source 
@callback cos(out :: tensor(), tensor()) :: tensor()
Link to this callback

cosh(out, tensor)

View Source 
@callback cosh(out :: tensor(), tensor()) :: tensor()
Link to this callback

count_leading_zeros(out, tensor)

View Source 
@callback count_leading_zeros(out :: tensor(), tensor()) :: tensor()
Link to this callback

cumulative_max(out, t, keyword)

View Source (optional) 
@callback cumulative_max(out :: tensor(), t :: tensor(), keyword()) :: tensor()
Link to this callback

cumulative_min(out, t, keyword)

View Source (optional) 
@callback cumulative_min(out :: tensor(), t :: tensor(), keyword()) :: tensor()
Link to this callback

cumulative_product(out, t, keyword)

View Source (optional) 
@callback cumulative_product(out :: tensor(), t :: tensor(), keyword()) :: tensor()
Link to this callback

cumulative_sum(out, t, keyword)

View Source (optional) 
@callback cumulative_sum(out :: tensor(), t :: tensor(), keyword()) :: tensor()
Link to this callback

determinant(out, t)

View Source (optional) 
@callback determinant(out :: tensor(), t :: tensor()) :: tensor()
Link to this callback

divide(out, tensor, tensor)

View Source 
@callback divide(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

dot(out, tensor, axes, axes, tensor, axes, axes)

View Source 
@callback dot(out :: tensor(), tensor(), axes(), axes(), tensor(), axes(), axes()) ::
  tensor()
Link to this callback

eigh({}, tensor, keyword)

View Source 
@callback eigh({eigenvals :: tensor(), eigenvecs :: tensor()}, tensor(), keyword()) ::
  tensor()
Link to this callback

equal(out, tensor, tensor)

View Source 
@callback equal(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

erf(out, tensor)

View Source 
@callback erf(out :: tensor(), tensor()) :: tensor()
Link to this callback

erf_inv(out, tensor)

View Source 
@callback erf_inv(out :: tensor(), tensor()) :: tensor()
Link to this callback

erfc(out, tensor)

View Source 
@callback erfc(out :: tensor(), tensor()) :: tensor()
Link to this callback

exp(out, tensor)

View Source 
@callback exp(out :: tensor(), tensor()) :: tensor()
Link to this callback

expm1(out, tensor)

View Source 
@callback expm1(out :: tensor(), tensor()) :: tensor()
Link to this callback

eye(tensor, backend_options)

View Source 
@callback eye(tensor(), backend_options()) :: tensor()
Link to this callback

fft(out, tensor, keyword)

View Source 
@callback fft(out :: tensor(), tensor(), keyword()) :: tensor()
Link to this callback

floor(out, tensor)

View Source 
@callback floor(out :: tensor(), tensor()) :: tensor()
Link to this callback

from_binary(out, binary, backend_options)

View Source 
@callback from_binary(out :: tensor(), binary(), backend_options()) :: tensor()
Link to this callback

gather(out, input, indices)

View Source 
@callback gather(out :: tensor(), input :: tensor(), indices :: tensor()) :: tensor()
Link to this callback

greater(out, tensor, tensor)

View Source 
@callback greater(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

greater_equal(out, tensor, tensor)

View Source 
@callback greater_equal(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

ifft(out, tensor, keyword)

View Source 
@callback ifft(out :: tensor(), tensor(), keyword()) :: tensor()
Link to this callback

imag(out, tensor)

View Source 
@callback imag(out :: tensor(), tensor()) :: tensor()
Link to this callback

indexed_add(out, target, indices, updates)

View Source 
@callback indexed_add(
  out :: tensor(),
  target :: tensor(),
  indices :: tensor(),
  updates :: tensor()
) ::
  tensor()
Link to this callback

indexed_put(out, target, indices, updates)

View Source 
@callback indexed_put(
  out :: tensor(),
  target :: tensor(),
  indices :: tensor(),
  updates :: tensor()
) ::
  tensor()
Link to this callback

init(keyword)

View Source 
@callback init(keyword()) :: backend_options()
Link to this callback

inspect(tensor, t)

View Source 
@callback inspect(tensor(), Inspect.Opts.t()) :: tensor()
Link to this callback

iota(tensor, arg2, backend_options)

View Source 
@callback iota(tensor(), axis() | nil, backend_options()) :: tensor()
Link to this callback

is_infinity(out, tensor)

View Source 
@callback is_infinity(out :: tensor(), tensor()) :: tensor()
Link to this callback

is_nan(out, tensor)

View Source 
@callback is_nan(out :: tensor(), tensor()) :: tensor()
Link to this callback

left_shift(out, tensor, tensor)

View Source 
@callback left_shift(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

less(out, tensor, tensor)

View Source 
@callback less(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

less_equal(out, tensor, tensor)

View Source 
@callback less_equal(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

log1p(out, tensor)

View Source 
@callback log1p(out :: tensor(), tensor()) :: tensor()
Link to this callback

log(out, tensor)

View Source 
@callback log(out :: tensor(), tensor()) :: tensor()
Link to this callback

logical_and(out, tensor, tensor)

View Source 
@callback logical_and(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

logical_not(out, t)

View Source (optional) 
@callback logical_not(out :: tensor(), t :: tensor()) :: tensor()
Link to this callback

logical_or(out, tensor, tensor)

View Source 
@callback logical_or(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

logical_xor(out, tensor, tensor)

View Source 
@callback logical_xor(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

lu({}, tensor, keyword)

View Source 
@callback lu({p :: tensor(), l :: tensor(), u :: tensor()}, tensor(), keyword()) ::
  tensor()
Link to this callback

map(out, tensor, keyword, function)

View Source 
@callback map(out :: tensor(), tensor(), keyword(), (... -> any())) :: tensor()
Link to this callback

max(out, tensor, tensor)

View Source 
@callback max(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

min(out, tensor, tensor)

View Source 
@callback min(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

multiply(out, tensor, tensor)

View Source 
@callback multiply(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

negate(out, tensor)

View Source 
@callback negate(out :: tensor(), tensor()) :: tensor()
Link to this callback

not_equal(out, tensor, tensor)

View Source 
@callback not_equal(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

optional(atom, list, function)

View Source (optional) 
@callback optional(atom(), [term()], (... -> any())) :: tensor()

Invoked for execution of optional callbacks with a default implementation.

First we will attempt to call the optional callback itself (one of the many callbacks defined below), then we attempt to call this callback (which is also optional), then we fallback to the default iomplementation.

Link to this callback

pad(out, tensor, pad_value, padding_config)

View Source 
@callback pad(out :: tensor(), tensor(), pad_value :: tensor(), padding_config :: list()) ::
  tensor()
Link to this callback

phase(out, t)

View Source (optional) 
@callback phase(out :: tensor(), t :: tensor()) :: tensor()
Link to this callback

population_count(out, tensor)

View Source 
@callback population_count(out :: tensor(), tensor()) :: tensor()
Link to this callback

pow(out, tensor, tensor)

View Source 
@callback pow(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

product(out, tensor, keyword)

View Source 
@callback product(out :: tensor(), tensor(), keyword()) :: tensor()
Link to this callback

put_slice(out, tensor, tensor, list)

View Source 
@callback put_slice(out :: tensor(), tensor(), tensor(), list()) :: tensor()
Link to this callback

qr({}, tensor, keyword)

View Source 
@callback qr({q :: tensor(), r :: tensor()}, tensor(), keyword()) :: tensor()
Link to this callback

quotient(out, tensor, tensor)

View Source 
@callback quotient(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

random_normal(tensor, mu, sigma, backend_options)

View Source 
@callback random_normal(tensor(), mu :: tensor(), sigma :: tensor(), backend_options()) ::
  tensor()
Link to this callback

random_uniform(tensor, tensor, tensor, backend_options)

View Source 
@callback random_uniform(tensor(), tensor(), tensor(), backend_options()) :: tensor()
Link to this callback

real(out, tensor)

View Source 
@callback real(out :: tensor(), tensor()) :: tensor()
Link to this callback

reduce(out, tensor, acc, keyword, function)

View Source 
@callback reduce(out :: tensor(), tensor(), acc :: tensor(), keyword(), (... -> any())) ::
  tensor()
Link to this callback

reduce_max(out, tensor, keyword)

View Source 
@callback reduce_max(out :: tensor(), tensor(), keyword()) :: tensor()
Link to this callback

reduce_min(out, tensor, keyword)

View Source 
@callback reduce_min(out :: tensor(), tensor(), keyword()) :: tensor()
Link to this callback

remainder(out, tensor, tensor)

View Source 
@callback remainder(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

reshape(out, tensor)

View Source 
@callback reshape(out :: tensor(), tensor()) :: tensor()
Link to this callback

reverse(out, tensor, axes)

View Source 
@callback reverse(out :: tensor(), tensor(), axes()) :: tensor()
Link to this callback

right_shift(out, tensor, tensor)

View Source 
@callback right_shift(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

round(out, tensor)

View Source 
@callback round(out :: tensor(), tensor()) :: tensor()
Link to this callback

rsqrt(out, tensor)

View Source 
@callback rsqrt(out :: tensor(), tensor()) :: tensor()
Link to this callback

select(out, tensor, tensor, tensor)

View Source 
@callback select(out :: tensor(), tensor(), tensor(), tensor()) :: tensor()
Link to this callback

sigmoid(out, tensor)

View Source 
@callback sigmoid(out :: tensor(), tensor()) :: tensor()
Link to this callback

sign(out, tensor)

View Source 
@callback sign(out :: tensor(), tensor()) :: tensor()
Link to this callback

sin(out, tensor)

View Source 
@callback sin(out :: tensor(), tensor()) :: tensor()
Link to this callback

sinh(out, tensor)

View Source 
@callback sinh(out :: tensor(), tensor()) :: tensor()
Link to this callback

slice(out, tensor, list, list, list)

View Source 
@callback slice(out :: tensor(), tensor(), list(), list(), list()) :: tensor()
Link to this callback

solve(out, a, b)

View Source (optional) 
@callback solve(out :: tensor(), a :: tensor(), b :: tensor()) :: tensor()
Link to this callback

sort(out, tensor, keyword)

View Source 
@callback sort(out :: tensor(), tensor(), keyword()) :: tensor()
Link to this callback

sqrt(out, tensor)

View Source 
@callback sqrt(out :: tensor(), tensor()) :: tensor()
Link to this callback

squeeze(out, tensor, axes)

View Source 
@callback squeeze(out :: tensor(), tensor(), axes()) :: tensor()
Link to this callback

subtract(out, tensor, tensor)

View Source 
@callback subtract(out :: tensor(), tensor(), tensor()) :: tensor()
Link to this callback

sum(out, tensor, keyword)

View Source 
@callback sum(out :: tensor(), tensor(), keyword()) :: tensor()
Link to this callback

svd({}, tensor, keyword)

View Source (optional) 
@callback svd({u :: tensor(), s :: tensor(), v :: tensor()}, tensor(), keyword()) ::
  tensor()
Link to this callback

take(out, input, indices, axis)

View Source 
@callback take(out :: tensor(), input :: tensor(), indices :: tensor(), axis()) ::
  tensor()
Link to this callback

take_along_axis(out, input, indices, axis)

View Source 
@callback take_along_axis(out :: tensor(), input :: tensor(), indices :: tensor(), axis()) ::
  tensor()
Link to this callback

tan(out, tensor)

View Source 
@callback tan(out :: tensor(), tensor()) :: tensor()
Link to this callback

tanh(out, tensor)

View Source 
@callback tanh(out :: tensor(), tensor()) :: tensor()
Link to this callback

to_batched(out, tensor, keyword)

View Source 
@callback to_batched(out :: tensor(), tensor(), keyword()) :: [tensor()]
Link to this callback

to_binary(tensor, limit)

View Source 
@callback to_binary(tensor(), limit :: non_neg_integer()) :: binary()
Link to this callback

top_k(out, tensor, keyword)

View Source (optional) 
@callback top_k(out :: tensor(), tensor(), keyword()) :: tensor()
Link to this callback

transpose(out, tensor, axes)

View Source 
@callback transpose(out :: tensor(), tensor(), axes()) :: tensor()
Link to this callback

triangular_solve(out, a, b, keyword)

View Source 
@callback triangular_solve(out :: tensor(), a :: tensor(), b :: tensor(), keyword()) ::
  tensor()
Link to this callback

window_max(out, tensor, shape, keyword)

View Source 
@callback window_max(out :: tensor(), tensor(), shape(), keyword()) :: tensor()
Link to this callback

window_min(out, tensor, shape, keyword)

View Source 
@callback window_min(out :: tensor(), tensor(), shape(), keyword()) :: tensor()
Link to this callback

window_product(out, tensor, shape, keyword)

View Source 
@callback window_product(out :: tensor(), tensor(), shape(), keyword()) :: tensor()
Link to this callback

window_reduce(out, tensor, acc, shape, keyword, function)

View Source 
@callback window_reduce(
  out :: tensor(),
  tensor(),
  acc :: tensor(),
  shape(),
  keyword(),
  (... -> any())
) ::
  tensor()
Link to this callback

window_scatter_max(out, tensor, tensor, tensor, shape, keyword)

View Source 
@callback window_scatter_max(
  out :: tensor(),
  tensor(),
  tensor(),
  tensor(),
  shape(),
  keyword()
) :: tensor()
Link to this callback

window_scatter_min(out, tensor, tensor, tensor, shape, keyword)

View Source 
@callback window_scatter_min(
  out :: tensor(),
  tensor(),
  tensor(),
  tensor(),
  shape(),
  keyword()
) :: tensor()
Link to this callback

window_sum(out, tensor, shape, keyword)

View Source 
@callback window_sum(out :: tensor(), tensor(), shape(), keyword()) :: tensor()

Link to this section Functions

Link to this function

inspect(map, binary, inspect_opts)

View Source

Inspects the given tensor given by binary.

Note the binary may have fewer elements than the tensor size but, in such cases, it must strictly have more elements than inspect_opts.limit