Safetensors documentation

Flax API

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Flax API

safetensors.flax.load_file

< >

( filename: typing.Union[str, os.PathLike] ) β†’ Dict[str, jnp.DeviceArray]

Parameters

  • filename (str, or os.PathLike)) — The name of the file which contains the tensors
  • device (Dict[str, any], optional, defaults to cpu) — The device where the tensors need to be located after load. available options are all regular flax device locations

Returns

Dict[str, jnp.DeviceArray]

dictionary that contains name as key, value as jnp.DeviceArray

Loads a safetensors file into flax format.

Example:

from safetensors.flax import load_file

file_path = "./my_folder/bert.safetensors"
loaded = load_file(file_path)

safetensors.flax.load

< >

( data: bytes ) β†’ Dict[str, jnp.DeviceArray]

Parameters

  • data (bytes) — The content of a safetensors file

Returns

Dict[str, jnp.DeviceArray]

dictionary that contains name as key, value as jnp.DeviceArray on cpu

Loads a safetensors file into flax format from pure bytes.

Example:

from safetensors.flax import load

file_path = "./my_folder/bert.safetensors"
with open(file_path, "rb") as f:
    data = f.read()

loaded = load(data)

safetensors.flax.save_file

< >

( tensors: typing.Dict[str, jaxlib.xla_extension.DeviceArrayBase] filename: typing.Union[str, os.PathLike] metadata: typing.Union[typing.Dict[str, str], NoneType] = None ) β†’ None

Parameters

  • tensors (Dict[str, jnp.DeviceArray]) — The incoming tensors. Tensors need to be contiguous and dense.
  • filename (str, or os.PathLike)) — The filename we’re saving into.
  • metadata (Dict[str, str], optional, defaults to None) — Optional text only metadata you might want to save in your header. For instance it can be useful to specify more about the underlying tensors. This is purely informative and does not affect tensor loading.

Returns

None

Saves a dictionnary of tensors into raw bytes in safetensors format.

Example:

from safetensors.flax import save_file
from jax import numpy as jnp

tensors = {"embedding": jnp.zeros((512, 1024)), "attention": jnp.zeros((256, 256))}
save(tensors, "model.safetensors")

safetensors.flax.save

< >

( tensors: typing.Dict[str, jaxlib.xla_extension.DeviceArrayBase] metadata: typing.Union[typing.Dict[str, str], NoneType] = None ) β†’ bytes

Parameters

  • tensors (Dict[str, jnp.DeviceArray]) — The incoming tensors. Tensors need to be contiguous and dense.
  • metadata (Dict[str, str], optional, defaults to None) — Optional text only metadata you might want to save in your header. For instance it can be useful to specify more about the underlying tensors. This is purely informative and does not affect tensor loading.

Returns

bytes

The raw bytes representing the format

Saves a dictionnary of tensors into raw bytes in safetensors format.

Example:

from safetensors.flax import save
from jax import numpy as jnp

tensors = {"embedding": jnp.zeros((512, 1024)), "attention": jnp.zeros((256, 256))}
byte_data = save(tensors)