tensor

Tensor Utility API

This module provides utility functions for working with tensors.

Functions

Name	Description
matches_spec	Test whether data object matches the desired spec

Machine-readable model

• SpecTypeattribute
• matches_specfunctionTest whether data object matches the desired spec.

attribute

SpecType

Python

helia_edge/utils/tensor.py:13

SpecType = list[npt.ArrayLike] | tuple[npt.ArrayLike] | dict[str, npt.ArrayLike] | npt.ArrayLike

function

matches_spec

Python

Test whether data object matches the desired spec.

helia_edge/utils/tensor.py:16

matches_spec(o: SpecType, spec: SpecType, ignore_batch_dim: bool = False) -> bool

Test whether data object matches the desired spec.

Parameters

Parameters of matches_spec

Name	Type	Default	Description
o	SpecType	Required	Data object.
spec	SpecType	Required	Metadata for describing the the data object.
ignore_batch_dim	bool	False	Ignore first dimension when checking shapes.

Returns

Returns of matches_spec

Value	Type	Description
bool	bool	If matches