Module index

Expand description

Persistent model references and explicit ownership of prepared/source stores.

Modules§

catalog 🔒
disk 🔒: Registered filesystem stores preserve physical layouts and external ownership.
events 🔒: Observations from one model operation, independent of terminal rendering.
gc 🔒
hub 🔒: Metadata-only HF discovery. Payload downloads use the existing HF/Xet client.
local 🔒
packing 🔒
records 🔒
reference 🔒: Catalog lookup accepts aliases and source URIs without dropping source identity.
resolve 🔒: A single resolver registers explicit sources and reuses pinned index entries.
selector 🔒: Parse locator syntax once, then map its structured fields through the index.
store 🔒

ArtifactDetails: Location, ownership, and reference count of a catalog artifact.
ArtifactLease: Keeps owned files reachable while a reader, mmap, or GPU operation uses them. The caller must retain this handle until all derived views are finished.
DiskStore: A named, externally owned filesystem store registered in this index.
GcReport: Garbage collection candidates and artifacts skipped because they are leased.
ModelDetails: Model summary with preparation requirements and artifact ownership details.
ModelEntry: Catalog identity, source lineage, and selected artifacts for one model.
ModelIndex: Persistent model references and artifact ownership under one storage root. Operations lock the catalog as needed; this handle does not retain artifact leases.
ModelSummary: Current availability and storage totals for a registered model.
PackOptions: Requested expert variants and source retention for an indexed model.
Removal: References released by removal; their files have not been collected yet.
ResolveOptions: Optional registration settings shared by prepare and explicit model registration.

ArtifactKind: An artifact’s role in a model’s preparation lifecycle.
DiskLayout: Physical layout used to find an owner/repository within a disk store.
ModelEvent: Progress during remote model inspection. Values are owned so observers can forward events to a channel. The operation’s Result signals completion; these events do not establish success or describe durable index state.
Source: Source identity used to recognize repeat registration and verify local imports.

anchor_selector: Anchor explicit relative paths while preserving parsed aliases and source URIs. Invalid locators return an error instead of becoming filesystem paths.
id 🔒
is_reference: Parse an alias, ID, or source URI without resolving it. Explicit paths return false.
prepared_precisions: List available expert precisions in descending order after loading the manifest. Q4 requires an existing base file. Q2/Q3 also check layout, size, and sample records. A manifest load failure returns an empty list.
resolve_path: Resolve through the index and lease the prepared artifact. Explicit source paths are registered if needed; files remain externally owned.
resolve_runtime: Prepare missing variants through publication, never by mutating a leased view. Indexed models must already have a prepared base. If the options permit it, missing variants are built before returning a lease to the published store. On success, indexed loads disable later repacking and store creation in options. Legacy model/packed stores use their model root to find config and tokenizer.
same_source 🔒
validate_name 🔒
validate_selector: Validate selector syntax without resolving an entry, reading files, or registering.