ak.to_safetensors#

Defined in awkward.operations.ak_to_safetensors on line 15.

ak.to_safetensors(array, destination, *, storage_options=None, container=None, buffer_key='{form_key}-{attribute}', form_key='node{id}', id_start=0, backend=None, byteorder=ak._util.native_byteorder)#

Parameters:

array – Array-like data (anything ak.to_layout recognizes).
destination (path-like) – Name of the output file, file path, or remote URL passed to fsspec.core.url_to_fs for remote writing.
storage_options (None or dict) – Any additional options to pass to fsspec.core.url_to_fs to open a remote file for writing.
container (dict, optional) – Optional mapping to receive the generated buffer bytes. If None (default), a temporary container is used and discarded after writing.
buffer_key (str, optional) – Format string for naming buffers. May include {form_key} and {attribute} placeholders. Defaults to "{form_key}-{attribute}".
form_key (str, optional) – Format string for node forms when generating buffer keys. Typically includes "{id}". Defaults to "node{id}".
id_start (int, optional) – Starting index for node numbering. Defaults to 0.
backend (str | object, optional) – Backend used to convert array data into buffers. If None, the default backend is used.
byteorder (str, optional) – Byte order for numeric buffers. Defaults to the system’s native byte order.

Returns:

None: This function writes the safetensors file to destination. If

container is provided, it will be populated with the raw buffer bytes.

Serialize an Awkward Array to the safetensors format and write it to destination.

Ref: https://huggingface.co/docs/safetensors/.

This function converts the provided Awkward Array (or array-like object) into raw buffers via ak.to_buffers and stores them in the safetensors format. Buffer names are generated from buffer_key and form_key templates, allowing downstream compatibility or layout reuse. The resulting safetensors file includes metadata containing the Awkward form and array length, which are required for ak.from_safetensors to reconstruct the array.

Example

>>> import awkward as ak
>>> arr = ak.Array([[1, 2, 3], [], [4]])
>>> ak.to_safetensors(arr, "out.safetensors")