safetensors: Low level control over safetensors files

In safetensors: Safetensors File Format

Low level control over safetensors files

Description

Low level control over safetensors files

Low level control over safetensors files

Details

Allows opening a connection to a safetensors file and query the tensor names, metadata, etc. Opening a connection only reads the file metadata into memory. This allows for more fined grained control over reading.

Public fields

con

the connection object with the file

metadata

an R list containing the metadata header in the file

framework

the framework used to return the tensors

args

additional arguments for tensor creation

max_offset

the largest offset boundary that was visited. Mainly used in torch to find the end of the safetensors file.

Methods

Public methods

• safetensors$new()

• safetensors$keys()

• safetensors$get_tensor()

• safetensors$clone()

---

Method new()

Opens the connection with the file

Usage

safetensors$new(path, ..., framework)

Arguments

path

Path to the file to load

...

(any)
Additional, framework dependent, arguments to pass to use when creating the tensor. For torch, this is the device, for pjrt the client.

framework

Framework to load the data into. Currently supports "torch" and "pjrt"

---

Method keys()

Get the keys (tensor names) in the file

Usage

safetensors$keys()

---

Method get_tensor()

Get a tensor from its name

Usage

safetensors$get_tensor(name)

Arguments

name

Name of the tensor to load

---

Method clone()

The objects of this class are cloneable with this method.

Usage

safetensors$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

if (rlang::is_installed("torch") && torch::torch_is_installed()) {
tensors <- list(x = torch::torch_randn(10, 10))
temp <- tempfile()
safe_save_file(tensors, temp)
f <- safetensors$new(temp, framework = "torch")
f$get_tensor("x")
}

safetensors documentation built on Aug. 18, 2025, 5:29 p.m.