pub struct HfHub { /* private fields */ }Expand description
Hugging Face Hub interface
Implementations§
Source§impl HfHub
impl HfHub
Sourcepub fn with_token(self, token: String) -> Self
pub fn with_token(self, token: String) -> Self
Set authentication token
Sourcepub fn with_cache_dir<P: AsRef<Path>>(self, cache_dir: P) -> Self
pub fn with_cache_dir<P: AsRef<Path>>(self, cache_dir: P) -> Self
Set cache directory
Sourcepub fn model_info(&mut self, model_id: &str) -> Result<HfModelInfo>
pub fn model_info(&mut self, model_id: &str) -> Result<HfModelInfo>
Get model information
Sourcepub fn download_model<P: AsRef<Path>>(
&self,
model_id: &str,
cache_dir: Option<P>,
) -> Result<PathBuf>
pub fn download_model<P: AsRef<Path>>( &self, model_id: &str, cache_dir: Option<P>, ) -> Result<PathBuf>
Download model files
Sourcepub fn upload_model<P: AsRef<Path>>(
&self,
model_path: P,
repo_id: &str,
commit_message: Option<&str>,
) -> Result<()>
pub fn upload_model<P: AsRef<Path>>( &self, model_path: P, repo_id: &str, commit_message: Option<&str>, ) -> Result<()>
Upload model to hub
Sourcepub fn get_cached_model_path(&self, model_id: &str) -> PathBuf
pub fn get_cached_model_path(&self, model_id: &str) -> PathBuf
Get cached model path
Trait Implementations§
Auto Trait Implementations§
impl Freeze for HfHub
impl RefUnwindSafe for HfHub
impl Send for HfHub
impl Sync for HfHub
impl Unpin for HfHub
impl UnwindSafe for HfHub
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.