Struct ModelsCat

pub struct ModelsCat { /* private fields */ }

A struct representing a models management system for downloading, pulling, and managing files from a hub.

This struct provides functionalities such as:

• Pulling an entire repository with or without progress tracking.
• Downloading specific files with or without progress tracking.
• Listing hub files and local cached files.
• Removing files or clearing the entire cache.

Implementations

impl ModelsCat

pub fn new(repo: Repo) -> Self

Creates a new ModelsCat instance with default endpoint.

Examples found in repository

examples/pull.rs (line 5)

fn main() {
    let cat = ModelsCat::new(Repo::new_model("BAAI/bge-small-zh-v1.5"));
    cat.download_with_progress("model.safetensors", ProgressBarWrapper::default())
        .unwrap();
}

pub fn new_with_endpoint(repo: Repo, endpoint: String) -> Self

Creates a new ModelsCat instance with a custom endpoint.

pub fn repo(&self) -> &Repo

Retrieves the repository configuration.

pub fn endpoint(&self) -> &str

Retrieves the endpoint URL.

pub fn pull(&self) -> Result<(), OpsError>

Pulls the entire repository without progress tracking.

pub fn pull_with_progress( &self, progress: impl Progress, ) -> Result<(), OpsError>

Pulls the entire repository with progress tracking.

pub fn download(&self, filename: &str) -> Result<(), OpsError>

Downloads a specific file from the hub without progress tracking. The filename including extension and parent directory, such as models.gguf or gguf/models.gguf.

pub fn download_with_progress( &self, filename: &str, progress: impl Progress, ) -> Result<(), OpsError>

Downloads a specific file from the hub with progress tracking. The filename including extension and parent directory, such as models.gguf or gguf/models.gguf.

Examples found in repository

examples/pull.rs (line 6)

fn main() {
    let cat = ModelsCat::new(Repo::new_model("BAAI/bge-small-zh-v1.5"));
    cat.download_with_progress("model.safetensors", ProgressBarWrapper::default())
        .unwrap();
}

pub fn list_hub_files(&self) -> Result<Vec<String>, OpsError>

List files in the remote repo

pub fn list_local_files(&self) -> Result<Vec<String>, OpsError>

List files in the local repo

pub fn remove_all(&self) -> Result<(), OpsError>

Remove all files in the repo

pub fn remove(&self, filename: &str) -> Result<(), OpsError>

Remove a file in the repo