Annex

v0.2.1

Annex v0.2.1 Annex.Data behaviour View Source

Annex.Data defines the callbacks and helpers for data structures used by Annex.

An implementer of the Annex.Layer behaviour must return an Annex.Data implementer from the c:data_type/0 callback.

Link to this section Summary

Types

args()
data()
flat_data()
op()
type()

A module that implements the Annex.Data Behaviour.

Functions

apply_op(data, name, args)
apply_op(type, data, name, args)
cast(data, shape)
cast(type, data, shape)

Annex.Data.cast/4 calls cast/3 for an Annex.Data behaviour implementing module.

convert(type, data, target_shape)

Given a type, data, and a target_shape converts the data to the type and target_shape

error(outputs, labels)
flat_data_to_tensor(flat_data, shape)
infer_type(item)
is_flat_data(data)
is_type?(type, data)

Given a type (Data implementing module) and some data returns true or false if the data is of the correct type.

shape(data)
shape(type, data)

Given an Annex.Data type and the data returns the shape of the data.

to_flat_list(data)

Flattens an Annex.Data into a list of floats via Enum.into/2.

to_flat_list(type, data)

Flattens an Annex.Data into a list of floats via the type's callback.

Callbacks

apply_op(data, op, args)
cast(data, arg2)
is_type?(any)
shape(data)
to_flat_list(data)

Link to this section Types

Link to this type

args() View Source 
args() :: [any()]

Link to this type

data() View Source 
data() :: struct() | flat_data() | [flat_data()]

Link to this type

flat_data() View Source 
flat_data() :: [float(), ...]

Link to this type

op() View Source 
op() :: any()

Link to this type

type() View Source 
type() :: module()

A module that implements the Annex.Data Behaviour.

Link to this section Functions

Link to this function

apply_op(data, name, args) View Source 
apply_op(data(), any(), [any()]) :: data()

Link to this function

apply_op(type, data, name, args) View Source 
apply_op(module(), data(), any(), [any()]) :: data()

Link to this function

cast(data, shape) View Source 
cast(Annex.Data.data(), Annex.Shape.t()) :: Annex.Data.data()

Link to this function

cast(type, data, shape) View Source

Annex.Data.cast/4 calls cast/3 for an Annex.Data behaviour implementing module.

Valid shapes are a non-empty tuple of positive integers or any the atom :any. e.g. {2, 3} or {3, :any}

Link to this function

convert(type, data, target_shape) View Source

Given a type, data, and a target_shape converts the data to the type and target_shape

If the data matches the type and the data_shape matches the target_shape the data is returned unaltered.

If either the type or target_shape do not match the data the data is casted using Data.cast/3.

Link to this function

error(outputs, labels) View Source 
error(Annex.Data.data(), Annex.Data.data()) :: Annex.Data.flat_data()

Link to this function

flat_data_to_tensor(flat_data, shape) View Source

Link to this function

infer_type(item) View Source 
infer_type(data()) :: any()

Link to this macro

is_flat_data(data) View Source (macro)

Link to this function

is_type?(type, data) View Source

Given a type (Data implementing module) and some data returns true or false if the data is of the correct type.

Calls is_type?/1 of the type.

Link to this function

shape(data) View Source 
shape(data()) :: Annex.Shape.t()

Link to this function

shape(type, data) View Source 
shape(type(), data()) :: Annex.Shape.t()

Given an Annex.Data type and the data returns the shape of the data.

The shape of data is used to cast between the expected shapes from one Annex.Layer to the next or from one Annex.Sequence to the next.

Link to this function

to_flat_list(data) View Source 
to_flat_list(Annex.Data.data()) :: Annex.Data.flat_data()

Flattens an Annex.Data into a list of floats via Enum.into/2.

Link to this function

to_flat_list(type, data) View Source 
to_flat_list(type(), data()) :: Annex.Data.flat_data()

Flattens an Annex.Data into a list of floats via the type's callback.

Link to this section Callbacks

Link to this callback

apply_op(data, op, args) View Source 
apply_op(data(), op(), args()) :: data()

Link to this callback

cast(data, arg2) View Source 
cast(data(), Annex.Shape.t()) :: data()

Link to this callback

is_type?(any) View Source 
is_type?(any()) :: boolean()

Link to this callback

shape(data) View Source 
shape(data()) :: Annex.Shape.t()

Link to this callback

to_flat_list(data) View Source 
to_flat_list(data()) :: [float()]