Skip to main content

SafetensorsSource

Struct SafetensorsSource 

Source
pub struct SafetensorsSource { /* private fields */ }
Expand description

ModelSource over a HuggingFace-format directory.

Standard layout:

<dir>/config.json                   (required)
<dir>/generation_config.json        (optional)
<dir>/tokenizer.json                (required by the runtime)
<dir>/tokenizer_config.json         (optional; chat special tokens)
<dir>/model.safetensors             (single-file), or
<dir>/model.safetensors.index.json  (sharded)

For diffusion sub-dirs (unet/, vae/, text_encoder/) use SafetensorsSource::load_weights_only, which tolerates diffusion_pytorch_model.safetensors (or model.safetensors) and no tokenizer/config.

Files are memory-mapped; ModelSource::open_tensor returns zero-copy views into the mapping.

Implementations§

Source§

impl SafetensorsSource

Source

pub fn load(dir: impl AsRef<Path>) -> Result<Self>

Opens a model directory (see type docs for the expected layout).

Source

pub fn load_weights_only( dir: impl AsRef<Path>, architecture: &str, ) -> Result<Self>

Opens a directory purely for weight loading. No config.json or tokenizer.json is required; metadata() returns a placeholder and tokenizer() errors. Accepts diffusion-style diffusion_pytorch_model.safetensors as well as model.safetensors.

Trait Implementations§

Source§

impl ModelSource for SafetensorsSource

Source§

fn metadata(&self) -> &ModelMetadata

Architecture + hyperparameter metadata.
Source§

fn tensor_names(&self) -> Vec<String>

Names of all tensors available in this source.
Source§

fn open_tensor(&self, name: &str) -> Result<TensorReader<'_>>

Opens a tensor by name, returning a lazy reader over the raw bytes.
Source§

fn tokenizer(&self) -> Result<TokenizerSpec>

Tokenizer specification (path to tokenizer.json + added tokens).
Source§

fn sampler_defaults(&self) -> Option<SamplerConfig>

Sampler defaults from generation_config.json, if present.
Source§

fn open_tensor_quant(&self, _name: &str) -> Result<Option<QuantTensor<'_>>>

Raw packed quantized bytes for a tensor, when this source stores it in a quant format that has a device kernel (GGUF Q4_0/Q4_K/Q6_K). None means “no packed representation” — the caller falls back to ModelSource::open_tensor, which dequantizes to float. Sources without packed formats keep this default.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoComptime for T

Source§

fn comptime(self) -> Self

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more