Safetensors documentation

PaddlePaddle API

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v0.3.2).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

PaddlePaddle API

safetensors.paddle.load_file

< >

( filename: Union device = 'cpu' ) β†’ Dict[str, paddle.Tensor]

Parameters

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

Returns

Dict[str, paddle.Tensor]

dictionary that contains name as key, value as paddle.Tensor

Loads a safetensors file into paddle format.

Example:

from safetensors.paddle import load_file

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

safetensors.paddle.load

< >

( data: bytes device: str = 'cpu' ) β†’ Dict[str, paddle.Tensor]

Parameters

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

Returns

Dict[str, paddle.Tensor]

dictionary that contains name as key, value as paddle.Tensor on cpu

Loads a safetensors file into paddle format from pure bytes.

Example:

from safetensors.paddle import load

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

loaded = load(data)

safetensors.paddle.save_file

< >

( tensors: Dict filename: Union metadata: Optional = None ) β†’ None

Parameters

  • tensors (Dict[str, paddle.Tensor]) — 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 dictionary of tensors into raw bytes in safetensors format.

Example:

from safetensors.paddle import save_file
import paddle

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

safetensors.paddle.save

< >

( tensors: Dict metadata: Optional = None ) β†’ bytes

Parameters

  • tensors (Dict[str, paddle.Tensor]) — 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 dictionary of tensors into raw bytes in safetensors format.

Example:

from safetensors.paddle import save
import paddle

tensors = {"embedding": paddle.zeros((512, 1024)), "attention": paddle.zeros((256, 256))}
byte_data = save(tensors)
< > Update on GitHub