# HfHub v0.2.0 - Table of Contents ## Pages - Documentation - [README](readme.md) - [HfHub Roadmap](roadmap.md) - Changelog - [Changelog](changelog.md) - License - [LICENSE](license.md) ## Modules - [HfHub](HfHub.md): Elixir client for HuggingFace Hub. - [HfHub.AccessRequests](HfHub.AccessRequests.md): Access request management for gated repositories. - [HfHub.AccessRequests.AccessRequest](HfHub.AccessRequests.AccessRequest.md): Represents an access request for a gated repository. - [HfHub.Cards](HfHub.Cards.md): Model and Dataset card parsing and creation. - [HfHub.Cards.DatasetCard](HfHub.Cards.DatasetCard.md): Represents a Dataset Card from a HuggingFace Hub repository. - [HfHub.Cards.DatasetCardData](HfHub.Cards.DatasetCardData.md): Structured metadata for Dataset Cards. - [HfHub.Cards.EvalResult](HfHub.Cards.EvalResult.md): Represents an evaluation result from a Model Card. - [HfHub.Cards.ModelCard](HfHub.Cards.ModelCard.md): Represents a Model Card from a HuggingFace Hub repository. - [HfHub.Cards.ModelCardData](HfHub.Cards.ModelCardData.md): Structured metadata for Model Cards. - [HfHub.Collections](HfHub.Collections.md): Collections API for organizing models, datasets, and spaces on HuggingFace Hub. - [HfHub.Collections.Collection](HfHub.Collections.Collection.md): Represents a collection on HuggingFace Hub. - [HfHub.Collections.CollectionItem](HfHub.Collections.CollectionItem.md): Represents an item within a collection. - [HfHub.Commit](HfHub.Commit.md): Commit operations for uploading files to HuggingFace Hub. - [HfHub.Commit.CommitInfo](HfHub.Commit.CommitInfo.md): Information about a completed commit. - [HfHub.Commit.LfsUpload](HfHub.Commit.LfsUpload.md): Git LFS upload protocol implementation. - [HfHub.Commit.Operation](HfHub.Commit.Operation.md): Commit operation types for file manipulation. - [HfHub.Commit.Operation.Add](HfHub.Commit.Operation.Add.md): Operation to add or update a file. - [HfHub.Commit.Operation.Copy](HfHub.Commit.Operation.Copy.md): Operation to copy an existing LFS file. - [HfHub.Commit.Operation.Delete](HfHub.Commit.Operation.Delete.md): Operation to delete a file or folder. - [HfHub.Constants](HfHub.Constants.md): Constants for HuggingFace Hub operations. - [HfHub.Discussions](HfHub.Discussions.md): Discussions and Pull Requests API for HuggingFace Hub. - [HfHub.Discussions.Comment](HfHub.Discussions.Comment.md): Represents a comment on a discussion or pull request. - [HfHub.Discussions.Discussion](HfHub.Discussions.Discussion.md): Represents a discussion or pull request summary. - [HfHub.Discussions.DiscussionDetails](HfHub.Discussions.DiscussionDetails.md): Detailed information about a discussion or pull request. - [HfHub.Discussions.StatusChange](HfHub.Discussions.StatusChange.md): Represents a status change event in a discussion's history. - [HfHub.Discussions.TitleChange](HfHub.Discussions.TitleChange.md): Represents a title change event in a discussion's history. - [HfHub.Errors](HfHub.Errors.md): Custom error types for HuggingFace Hub operations. - [HfHub.Git](HfHub.Git.md): Git operations for HuggingFace Hub repositories. - [HfHub.Git.BranchInfo](HfHub.Git.BranchInfo.md): Information about a Git branch in a HuggingFace repository. - [HfHub.Git.CommitInfo](HfHub.Git.CommitInfo.md): Information about a Git commit in a HuggingFace repository. - [HfHub.Git.GitRefs](HfHub.Git.GitRefs.md): Collection of Git refs (branches, tags, converts, pull requests) in a repository. - [HfHub.Git.TagInfo](HfHub.Git.TagInfo.md): Information about a Git tag in a HuggingFace repository. - [HfHub.Hub](HfHub.Hub.md): Bumblebee-compatible Hub interface for HuggingFace. - [HfHub.InferenceEndpoints](HfHub.InferenceEndpoints.md): Inference Endpoints API for dedicated model hosting. - [HfHub.InferenceEndpoints.ComputeConfig](HfHub.InferenceEndpoints.ComputeConfig.md): Compute configuration for an inference endpoint. - [HfHub.InferenceEndpoints.Endpoint](HfHub.InferenceEndpoints.Endpoint.md): Inference Endpoint information. - [HfHub.InferenceEndpoints.ModelConfig](HfHub.InferenceEndpoints.ModelConfig.md): Model configuration for an inference endpoint. - [HfHub.InferenceEndpoints.ProviderConfig](HfHub.InferenceEndpoints.ProviderConfig.md): Cloud provider configuration for an inference endpoint. - [HfHub.InferenceEndpoints.ScalingConfig](HfHub.InferenceEndpoints.ScalingConfig.md): Scaling configuration for an inference endpoint. - [HfHub.LFS](HfHub.LFS.md): LFS (Large File Storage) utilities for HuggingFace Hub. - [HfHub.LFS.UploadInfo](HfHub.LFS.UploadInfo.md): Information required to determine upload method for a file. - [HfHub.Organizations](HfHub.Organizations.md): Organization profile API. - [HfHub.Repo](HfHub.Repo.md): Repository management operations for HuggingFace Hub. - [HfHub.Repo.RepoUrl](HfHub.Repo.RepoUrl.md): Repository URL returned from create/move operations. - [HfHub.RepoFiles](HfHub.RepoFiles.md): Repository file listing with ETag information. - [HfHub.Repository](HfHub.Repository.md): Repository reference types and helpers for HuggingFace Hub. - [HfHub.Spaces](HfHub.Spaces.md): Space management API for HuggingFace Spaces. - [HfHub.Spaces.SpaceRuntime](HfHub.Spaces.SpaceRuntime.md): Runtime information for a HuggingFace Space. - [HfHub.Spaces.SpaceVariable](HfHub.Spaces.SpaceVariable.md): A Space environment variable. - [HfHub.Users](HfHub.Users.md): User profile and activity API. - [HfHub.Users.Organization](HfHub.Users.Organization.md): Represents a HuggingFace Hub organization profile. - [HfHub.Users.User](HfHub.Users.User.md): Represents a HuggingFace Hub user profile. - [HfHub.Webhooks](HfHub.Webhooks.md): Webhooks API for event notifications on HuggingFace Hub. - [HfHub.Webhooks.WatchedItem](HfHub.Webhooks.WatchedItem.md): Represents a watched item in a webhook configuration. - [HfHub.Webhooks.WebhookInfo](HfHub.Webhooks.WebhookInfo.md): Represents a webhook configuration on HuggingFace Hub. - Core API - [HfHub.Api](HfHub.Api.md): HuggingFace Hub API client. - [HfHub.Auth](HfHub.Auth.md): Authentication and authorization for HuggingFace Hub. - [HfHub.Cache](HfHub.Cache.md): Cache management for downloaded files. - [HfHub.DatasetFiles](HfHub.DatasetFiles.md): Resolve dataset file paths by config and split. - [HfHub.Download](HfHub.Download.md): File download functionality for HuggingFace Hub. - [HfHub.Extract](HfHub.Extract.md): Archive detection and extraction utilities. - [HfHub.FS](HfHub.FS.md): Filesystem utilities for HuggingFace cache management. - Internal - [HfHub.Cache.Server](HfHub.Cache.Server.md): GenServer for managing cache state and operations. - [HfHub.Config](HfHub.Config.md): Configuration utilities for HfHub. - [HfHub.HTTP](HfHub.HTTP.md): HTTP client for HuggingFace Hub API. - Exceptions - [HfHub.Errors.BadRequest](HfHub.Errors.BadRequest.md): Raised for HTTP 400 Bad Request errors. - [HfHub.Errors.CacheNotFound](HfHub.Errors.CacheNotFound.md): Exception raised when the HuggingFace cache directory is not found. - [HfHub.Errors.CorruptedCache](HfHub.Errors.CorruptedCache.md): Exception for unexpected structure in the HuggingFace cache. - [HfHub.Errors.DDUFCorruptedFile](HfHub.Errors.DDUFCorruptedFile.md): Exception thrown when the DDUF file is corrupted. - [HfHub.Errors.DDUFError](HfHub.Errors.DDUFError.md): Base exception for errors related to the DDUF format. - [HfHub.Errors.DDUFExport](HfHub.Errors.DDUFExport.md): Exception for errors during DDUF export. - [HfHub.Errors.DDUFInvalidEntryName](HfHub.Errors.DDUFInvalidEntryName.md): Exception thrown when the DDUF entry name is invalid. - [HfHub.Errors.DisabledRepo](HfHub.Errors.DisabledRepo.md): Raised when trying to access a repository disabled by its author. - [HfHub.Errors.DryRun](HfHub.Errors.DryRun.md): Error triggered when a dry run cannot be performed. - [HfHub.Errors.EntryNotFound](HfHub.Errors.EntryNotFound.md): Raised when a file or entry is not found in a repository. - [HfHub.Errors.FileMetadata](HfHub.Errors.FileMetadata.md): Error triggered when file metadata cannot be retrieved. - [HfHub.Errors.GatedRepo](HfHub.Errors.GatedRepo.md): Raised when trying to access a gated repository without authorization. - [HfHub.Errors.HFValidation](HfHub.Errors.HFValidation.md): Generic exception thrown by `huggingface_hub` validators. - [HfHub.Errors.HTTPError](HfHub.Errors.HTTPError.md): Base HTTP error with request and response context. - [HfHub.Errors.InferenceEndpointError](HfHub.Errors.InferenceEndpointError.md): Generic exception when dealing with Inference Endpoints. - [HfHub.Errors.InferenceEndpointTimeout](HfHub.Errors.InferenceEndpointTimeout.md): Exception for timeouts while waiting for Inference Endpoint. - [HfHub.Errors.InferenceTimeout](HfHub.Errors.InferenceTimeout.md): Raised when a model is unavailable or the request times out. - [HfHub.Errors.LocalEntryNotFound](HfHub.Errors.LocalEntryNotFound.md): Raised when a file is not found in the local cache. - [HfHub.Errors.LocalTokenNotFound](HfHub.Errors.LocalTokenNotFound.md): Raised when a local token is required but not found. - [HfHub.Errors.NotASafetensorsRepo](HfHub.Errors.NotASafetensorsRepo.md): Raised when a repo lacks safetensors files. - [HfHub.Errors.OfflineMode](HfHub.Errors.OfflineMode.md): Raised when a network request is attempted with HF_HUB_OFFLINE=1. - [HfHub.Errors.RemoteEntryNotFound](HfHub.Errors.RemoteEntryNotFound.md): Raised when a file is not found on the remote Hub. - [HfHub.Errors.RepositoryNotFound](HfHub.Errors.RepositoryNotFound.md): Raised when trying to access an invalid repository or one without access. - [HfHub.Errors.RevisionNotFound](HfHub.Errors.RevisionNotFound.md): Raised when trying to access a valid repository but invalid revision. - [HfHub.Errors.SafetensorsParsing](HfHub.Errors.SafetensorsParsing.md): Raised when failing to parse a safetensors file metadata. - [HfHub.Errors.TextGeneration](HfHub.Errors.TextGeneration.md): Generic error raised if text-generation went wrong. - [HfHub.Errors.TextGenerationIncomplete](HfHub.Errors.TextGenerationIncomplete.md): Raised when text generation is incomplete. - [HfHub.Errors.TextGenerationOverloaded](HfHub.Errors.TextGenerationOverloaded.md): Raised when the text generation server is overloaded. - [HfHub.Errors.TextGenerationValidation](HfHub.Errors.TextGenerationValidation.md): Server-side validation error during text generation. - [HfHub.Errors.XetAuthorization](HfHub.Errors.XetAuthorization.md): Exception when user lacks authorization to use Xet Storage. - [HfHub.Errors.XetDownload](HfHub.Errors.XetDownload.md): Exception when download from Xet Storage fails. - [HfHub.Errors.XetError](HfHub.Errors.XetError.md): Base exception for errors related to Xet Storage. - [HfHub.Errors.XetRefreshToken](HfHub.Errors.XetRefreshToken.md): Exception when the Xet refresh token is invalid.