Struct RemoteResource

pub struct RemoteResource {
    pub url: String,
    pub cache_subdir: String,
}

Remote resource that will be downloaded and cached locally on demand

Fields

url: String

Remote path/url for the resource

cache_subdir: String

Local subdirectory of the cache root where this resource is saved

Implementations

impl RemoteResource

pub fn new(url: &str, cache_subdir: &str) -> RemoteResource

Creates a new RemoteResource from an URL and a custom local path. Note that this does not download the resource (only declares the remote and local locations)

Arguments

• url - &str Location of the remote resource
• cache_subdir - &str Local subdirectory of the cache root to save the resource to

Returns

• RemoteResource RemoteResource object

Example

use rust_bert::resources::RemoteResource;
let config_resource = RemoteResource::new("http://config_json_location", "configs");

pub fn from_pretrained(name_url_tuple: (&str, &str)) -> RemoteResource

Creates a new RemoteResource from an URL and local name. Will define a local path pointing to ~/.cache/.rustbert/model_name. Note that this does not download the resource (only declares the remote and local locations)

Arguments

• name_url_tuple - (&str, &str) Location of the name of model and remote resource

Returns

• RemoteResource RemoteResource object

Example

use rust_bert::resources::RemoteResource;
let model_resource = RemoteResource::from_pretrained((
    "distilbert-sst2",
    "https://huggingface.co/distilbert-base-uncased-finetuned-sst-2-english/resolve/main/rust_model.ot",
));

Trait Implementations

impl Clone for RemoteResource

fn clone(&self) -> RemoteResource

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RemoteResource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for RemoteResource

fn eq(&self, other: &RemoteResource) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ResourceProvider for RemoteResource

fn get_local_path(&self) -> Result<PathBuf, RustBertError>

Gets the local path for a remote resource.

The remote resource is downloaded and cached. Then the path to the local cache is returned.

Returns

• PathBuf pointing to the resource file

Example

use rust_bert::resources::{LocalResource, ResourceProvider};
use std::path::PathBuf;
let config_resource = LocalResource {
    local_path: PathBuf::from("path/to/config.json"),
};
let config_path = config_resource.get_local_path();

fn get_resource(&self) -> Result<Resource<'_>, RustBertError>

Gets a wrapper around the local path for a remote resource.

Returns

• Resource wrapping a PathBuf pointing to the resource file

Example

use rust_bert::resources::{RemoteResource, ResourceProvider};
let config_resource = RemoteResource::new("http://config_json_location", "configs");
let config_path = config_resource.get_resource();

impl Eq for RemoteResource

impl StructuralPartialEq for RemoteResource