Safetensors 文档

Numpy API

您正在查看 main 版本,该版本需要从源码安装。如果您想要常规的 pip 安装,请查看最新的稳定版本 (v0.5.0-rc.0)。
Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

Numpy API

safetensors.numpy.load_file

< >

( filename: typing.Union[str, os.PathLike] ) Dict[str, np.ndarray]

参数

  • filename (str, 或 os.PathLike)) — 包含张量的文件名

返回值

Dict[str, np.ndarray]

字典,包含名称作为键,值作为 np.ndarray

将 safetensors 文件加载到 numpy 格式。

示例

from safetensors.numpy import load_file

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

safetensors.numpy.load

< >

( data: bytes ) Dict[str, np.ndarray]

参数

  • data (bytes) — safetensors 文件的内容

返回值

Dict[str, np.ndarray]

字典,包含名称作为键,CPU 上的 np.ndarray 作为值

从纯字节加载 safetensors 文件到 numpy 格式。

示例

from safetensors.numpy import load

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

loaded = load(data)

safetensors.numpy.save_file

< >

( tensor_dict: typing.Dict[str, numpy.ndarray] filename: typing.Union[str, os.PathLike] metadata: typing.Optional[typing.Dict[str, str]] = None ) None

参数

  • tensor_dict (Dict[str, np.ndarray]) — 传入的张量。张量需要是连续且密集的。
  • filename (str, 或 os.PathLike)) — 我们要保存到的文件名。
  • metadata (Dict[str, str], 可选, 默认为 None) — 可选的纯文本元数据,您可能想要保存在标头中。例如,它可以用于更详细地说明底层张量。这纯粹是信息性的,不会影响张量加载。

返回值

None

将张量字典以 safetensors 格式保存为原始字节。

示例

from safetensors.numpy import save_file
import numpy as np

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

safetensors.numpy.save

< >

( tensor_dict: typing.Dict[str, numpy.ndarray] metadata: typing.Optional[typing.Dict[str, str]] = None ) bytes

参数

  • tensor_dict (Dict[str, np.ndarray]) — 传入的张量。张量需要是连续且密集的。
  • metadata (Dict[str, str], 可选, 默认为 None) — 可选的纯文本元数据,您可能想要保存在标头中。例如,它可以用于更详细地说明底层张量。这纯粹是信息性的,不会影响张量加载。

返回值

bytes

表示格式的原始字节

将张量字典以 safetensors 格式保存为原始字节。

示例

from safetensors.numpy import save
import numpy as np

tensors = {"embedding": np.zeros((512, 1024)), "attention": np.zeros((256, 256))}
byte_data = save(tensors)
< > 在 GitHub 上更新