pub struct DataForge { /* private fields */ }Expand description
Blocking dataset discovery and archive client.
Implementations§
Source§impl DataForge
impl DataForge
Sourcepub fn new(provider: DatasetProvider) -> Result<Self>
pub fn new(provider: DatasetProvider) -> Result<Self>
Build a new client for the selected provider.
Sourcepub fn with_user_agent(
provider: DatasetProvider,
user_agent: &str,
) -> Result<Self>
pub fn with_user_agent( provider: DatasetProvider, user_agent: &str, ) -> Result<Self>
Build a new client with a custom User-Agent.
Sourcepub fn with_token(self, token: impl Into<String>) -> Self
pub fn with_token(self, token: impl Into<String>) -> Self
Attach a provider token. Hugging Face uses Authorization: Bearer <token>.
Sourcepub fn with_page_size(self, page_size: usize) -> Self
pub fn with_page_size(self, page_size: usize) -> Self
Set the API page size used for list requests.
Sourcepub fn provider(&self) -> DatasetProvider
pub fn provider(&self) -> DatasetProvider
Return the provider this client targets.
Sourcepub fn discover(&self, target: &DatasetTarget) -> Result<Vec<DatasetSummary>>
pub fn discover(&self, target: &DatasetTarget) -> Result<Vec<DatasetSummary>>
Discover datasets for a normalized target.
Sourcepub fn inspect(&self, dataset_id: &str) -> Result<DatasetDetails>
pub fn inspect(&self, dataset_id: &str) -> Result<DatasetDetails>
Fetch full details and file URLs for one dataset id.
Sourcepub fn archive_target(
&self,
target: &DatasetTarget,
options: &ArchiveOptions,
) -> Result<ArchiveSummary>
pub fn archive_target( &self, target: &DatasetTarget, options: &ArchiveOptions, ) -> Result<ArchiveSummary>
Discover and archive datasets for a target.
Sourcepub fn archive_datasets(
&self,
datasets: &[DatasetSummary],
options: &ArchiveOptions,
) -> Result<ArchiveSummary>
pub fn archive_datasets( &self, datasets: &[DatasetSummary], options: &ArchiveOptions, ) -> Result<ArchiveSummary>
Archive discovered dataset summaries with bounded concurrent file downloads.
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for DataForge
impl !UnwindSafe for DataForge
impl Freeze for DataForge
impl Send for DataForge
impl Sync for DataForge
impl Unpin for DataForge
impl UnsafeUnpin for DataForge
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