types module

Full Documentation for hippynn.serializer.types module. Click here for a summary page.

Plain-data type definitions for graph serialization: node/tensor references and record shapes.

class GraphModuleRecord(graph: list[hippynn.serializer.types.NodeData], input_nodes: tuple[hippynn.serializer.types.NodeReference, ...], output_nodes: tuple[hippynn.serializer.types.NodeReference, ...], forward_output_list: tuple[hippynn.serializer.types.NodeReference, ...], _type: Literal['graph_module_record'] = 'graph_module_record')[source]

Bases: object

forward_output_list: tuple[NodeReference, ...]

graph: list[NodeData]

input_nodes: tuple[NodeReference, ...]

output_nodes: tuple[NodeReference, ...]

class NodeData(identifier: hippynn.serializer.types.NodeIdentifier, cls: hippynn.serializer.types.NodeTypeIdentifier, parents: tuple[hippynn.serializer.types.NodeReference, ...] = (), state: dict[str, Serializable] | None = None)[source]

Bases: object

cls: NodeTypeIdentifier

identifier: NodeIdentifier

parents: tuple[NodeReference, ...] = ()

state: dict[str, Serializable] | None = None

class NodeIdentifier(id: int, name: str | None)[source]

Bases: object

id: int

name: str | None

class NodeListRecord(graph: list[hippynn.serializer.types.NodeData], root_list: list[hippynn.serializer.types.NodeReference], _type: Literal['node_list_record'] = 'node_list_record')[source]

Bases: object

graph: list[NodeData]

root_list: list[NodeReference]

class NodeRecord(graph: list[hippynn.serializer.types.NodeData], root: hippynn.serializer.types.NodeReference, _type: Literal['node_record'] = 'node_record')[source]

Bases: object

graph: list[NodeData]

root: NodeReference

class NodeReference(identifier: hippynn.serializer.types.NodeIdentifier, _type: Literal['node_ref'] = 'node_ref')[source]

Bases: object

identifier: NodeIdentifier

class NodeTypeIdentifier(name: str, namespace: str, package: str | None)[source]

Bases: object

name: str

namespace: str

package: str | None

class SerializationBox(record: SerializationRecord, n_tensor_values: int, tensor_data: list[object] | None = None, protocol_version: int = 0)[source]

Bases: object

n_tensor_values: int

protocol_version: int = 0

record: SerializationRecord

tensor_data: list[object] | None = None

class TaggedIdxType(values: str, _type: Literal['IdxType'] = 'IdxType')[source]

Bases: object

values: str

class TaggedSet(values: list[T], _type: Literal['set'] = 'set')[source]

Bases: Generic

values: list[T]

class TaggedTuple(values: list[T], _type: Literal['tuple'] = 'tuple')[source]

Bases: Generic

values: list[T]

class TensorReference(key: int, _type: Literal['tensor_ref'] = 'tensor_ref')[source]

Bases: object

key: int

type Container = list[T] | TaggedTuple | dict[str, T] | TaggedSet

type ContainerPrimitive = Container[Serializable]

type Scalar = ScalarPrimitive | TensorReference | NodeReference | TaggedIdxType

type ScalarPrimitive = None | bool | int | float | str

type Serializable = Scalar | ContainerPrimitive

type SerializationRecord = NodeRecord | NodeListRecord | GraphModuleRecord

type Tagged = NodeReference | TensorReference | TaggedSet[Serializable] | TaggedTuple[Serializable] | TaggedIdxType