resonance.api.data.compression¶
resonance.api.data.compression
¶
compress_array(data, *, method='zlib')
¶
Compress a NumPy array to bytes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
ndarray
|
Array to compress. Any dtype and shape. |
required |
method
|
('zlib', 'none')
|
Compression algorithm. The returned method string is round-trippable
with |
"zlib"
|
Returns:
| Type | Description |
|---|---|
tuple[bytes, str]
|
Compressed (or raw) bytes and the method string used. |
Source code in src/resonance/api/data/compression.py
decompress_array(buffer, *, method, dtype, shape)
¶
Decompress bytes back to a NumPy array.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
buffer
|
bytes
|
Compressed or raw bytes produced by |
required |
method
|
str
|
Compression method used during compression. Must be |
required |
dtype
|
str
|
NumPy dtype string (e.g. |
required |
shape
|
tuple[int, ...]
|
Target shape of the output array. Accepts arbitrary N-D shapes. |
required |
Returns:
| Type | Description |
|---|---|
ndarray
|
Reconstructed array with the given dtype and shape. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If |