huggingface_hub の API リファレンス

huggingface_hub (huggingface/huggingface_hub) の公開 API 225 件 —— クラス 87、関数 109、メソッド 29。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

種別	件数
クラス	87
関数	109
メソッド	29

API 一覧

classsrc.huggingface_hub._buckets.BucketInfo

Contains information about a bucket on the Hub.

classsrc.huggingface_hub._buckets.BucketUrl

Describes a bucket URL on the Hub.

classsrc.huggingface_hub._buckets.FilterMatcher

Matches file paths against include/exclude patterns.

methodsrc.huggingface_hub._buckets.FilterMatcher.matches(path:str) -> bool

Check if a path should be included based on the filter rules.

classsrc.huggingface_hub._buckets.SyncOperation

Represents a sync operation to be performed.

classsrc.huggingface_hub._buckets.SyncPlan

Represents a complete sync plan.

classsrc.huggingface_hub._hot_reload.sse_client.Event

Representation of an event from the event stream.

classsrc.huggingface_hub._hot_reload.sse_client.SSEClient

Implementation of a SSE client.

classsrc.huggingface_hub._jobs_api.JobAccelerator

Contains information about a Job accelerator (GPU).

classsrc.huggingface_hub._jobs_api.JobDurations

Timing breakdown for a Job, computed server-side.

classsrc.huggingface_hub._jobs_api.JobHardwareInfo

Contains information about available Job hardware.

classsrc.huggingface_hub._jobs_api.JobInfo

Contains information about a Job.

classsrc.huggingface_hub._jobs_api.JobInitiator

Contains information about what triggered a Job.

classsrc.huggingface_hub._jobs_api.JobStage

Enumeration of possible stage of a Job on the Hub.

classsrc.huggingface_hub._jobs_api.ScheduledJobInfo

Contains information about a Job.

funcsrc.huggingface_hub._login.auth_list() -> None

List all stored access tokens.

funcsrc.huggingface_hub._login.auth_switch(token_name:str, add_to_git_credential:bool=False) -> None

Switch to a different access token.

func

src.huggingface_hub._login.login(token:str | None=None, *add_to_git_credential:bool=False, *skip_if_logged_in:bool=True) -> None

funcsrc.huggingface_hub._login.logout(token_name:str | None=None) -> None

Logout the machine from the Hub.

classsrc.huggingface_hub._oauth.OAuthInfo

Information about the OAuth login.

classsrc.huggingface_hub._oauth.OAuthUserInfo

Information about a user logged in with OAuth.

funcsrc.huggingface_hub._oauth.oauth_login(request:fastapi.Request) -> RedirectResponse

Endpoint that redirects to HF OAuth page.

funcsrc.huggingface_hub._oauth.oauth_logout(request:fastapi.Request) -> RedirectResponse

Endpoint that logs out the user (e.g.

funcsrc.huggingface_hub._oauth.oauth_redirect_callback(request:fastapi.Request) -> RedirectResponse

Endpoint that handles the OAuth callback.

classsrc.huggingface_hub._oidc.Provider

CI providers that can mint an OIDC id token natively.

classsrc.huggingface_hub._sandbox.FileEntry

A file or directory inside a sandbox.

classsrc.huggingface_hub._sandbox.Sandbox

An isolated cloud machine running on Hugging Face Jobs.

methodsrc.huggingface_hub._sandbox.Sandbox.processes() -> List[SandboxProcess]

List the background processes of this sandbox.

funcsrc.huggingface_hub._sandbox_cache.pool_cache_path(pool_id:str) -> Path

Path of the cache file for `pool_id` (no I/O).

classsrc.huggingface_hub._space_api.SpaceSearchResult

A single result from the Spaces semantic search API.

classsrc.huggingface_hub._space_api.SpaceSecret

Contains information about a secret of a Space.

classsrc.huggingface_hub._space_api.SpaceStage

Enumeration of possible stage of a Space on the Hub.

classsrc.huggingface_hub._space_api.Volume

Describes a volume to mount in a Space or Job container.

funcsrc.huggingface_hub.cli._city_game.run_city_game(repos:list[RepoStorageInfo]) -> None

Launch the interactive city explorer.

funcsrc.huggingface_hub.cli._cli_utils.parse_volumes(volumes:list[str] | None) -> 'list[Volume] | None'

Parse volume specs from CLI arguments.

funcsrc.huggingface_hub.cli._file_listing.format_date(dt:datetime | None, human_readable:bool=False) -> str

Format a datetime to a readable date string.

funcsrc.huggingface_hub.cli._file_listing.format_size(size:int | float, human_readable:bool=False) -> str

Format a size in bytes.

func

src.huggingface_hub.cli._file_listing.list_repo_files_cmd(repo_id:str, repo_type:str, human_readable:bool, as_tree:bool, recursive:bool, revision:str | None, token:str | None) -> None

List files in a repo on the Hub.

classsrc.huggingface_hub.cli._framework.Argument

Declare a positional CLI argument, e.g.

classsrc.huggingface_hub.cli._framework.Option

Declare a CLI option, e.g.

classsrc.huggingface_hub.cli._output.Output

Output sink for the `hf` CLI.

method

src.huggingface_hub.cli._output.Output.confirm(message:str, *default:bool=False, *yes:bool=False, *confirm_param:str='--yes') -> None

Ask for confirmation.

methodsrc.huggingface_hub.cli._output.Output.error(message:str) -> None

Print an error to stderr (all modes).

methodsrc.huggingface_hub.cli._output.Output.hint(message:str) -> None

Print a helpful hint to stderr (human: gray, json/agent: plain text).

methodsrc.huggingface_hub.cli._output.Output.log(message:str) -> None

Print a text message to stderr (human: gray, json/agent: plain text).

methodsrc.huggingface_hub.cli._output.Output.result(message:str, **data:Any) -> None

Print a success summary to stdout.

methodsrc.huggingface_hub.cli._output.Output.set_no_truncate(no_truncate:bool) -> None

Toggle off cell truncation for human table output.

method

src.huggingface_hub.cli._output.Output.table(items:Sequence[dict[str, Any]], *headers:list[str] | None=None, *id_key:str | None=None, *alignments:dict[str, str] | None=None) -> None

Print tabular data to stdout.

methodsrc.huggingface_hub.cli._output.Output.text(msg:str | None=None, *human:str | None=None, *agent:str | None=None) -> None

Print a free-form text message to stdout.

methodsrc.huggingface_hub.cli._output.Output.warning(message:str) -> None

Print a non-fatal warning to stderr (all modes).

funcsrc.huggingface_hub.cli._skills.add_skill(skill_name:str, destination_root:Path, force:bool=False) -> Path

Resolve a marketplace skill by name and install it.

funcsrc.huggingface_hub.cli.auth.auth_list_cmd() -> None

List all stored access tokens.

func

src.huggingface_hub.cli.auth.auth_logout(token_name:Annotated[str | None, Option(help='Name of token to logout')]=None) -> None

Logout from a specific token.

funcsrc.huggingface_hub.cli.auth.auth_token() -> None

Print the current access token to stdout.

func

src.huggingface_hub.cli.buckets.info(bucket_id:Annotated[str, Argument(help='Bucket ID: namespace/bucket_name or hf://buckets/namespace/bucket_name')], token:TokenOpt=None) -> None

Get info about a bucket.

func

src.huggingface_hub.cli.cache.summarize_deletions(selected_by_repo:Mapping[CachedRepoInfo, frozenset[CachedRevisionInfo]]) -> CacheDeletionCounts

Summarize deletions across repositories.

func

src.huggingface_hub.cli.discussions.discussion_diff(repo_id:RepoIdArg, num:DiscussionNumArg, repo_type:RepoTypeOpt=RepoType.model, token:TokenOpt=None) -> None

Show the diff of a pull request.

func

src.huggingface_hub.cli.extensions.extension_exec(ctx:click.Context, name:Annotated[str, Argument(help='Extension name (with or without `hf-` prefix).')]) -> None

Execute an installed extension.

funcsrc.huggingface_hub.cli.extensions.extension_list() -> None

List installed extension commands.

func

src.huggingface_hub.cli.extensions.extension_remove(name:Annotated[str, Argument(help='Extension name to remove (with or without `hf-` prefix).')]) -> None

Remove an installed extension.

func

src.huggingface_hub.cli.inference_endpoints.describe(name:NameArg, namespace:NamespaceOpt=None, token:TokenOpt=None) -> None

Get information about an existing endpoint.

funcsrc.huggingface_hub.cli.inference_endpoints.list_catalog(token:TokenOpt=None) -> None

List available Catalog models.

func

src.huggingface_hub.cli.inference_endpoints.pause(name:NameArg, namespace:NamespaceOpt=None, token:TokenOpt=None) -> None

Pause an Inference Endpoint.

func

src.huggingface_hub.cli.inference_endpoints.scale_to_zero(name:NameArg, namespace:NamespaceOpt=None, token:TokenOpt=None) -> None

Scale an Inference Endpoint to zero.

funcsrc.huggingface_hub.cli.jobs.jobs_cancel(job_id:JobIdArg, namespace:NamespaceOpt=None, token:TokenOpt=None) -> None

Cancel a Job

funcsrc.huggingface_hub.cli.jobs.jobs_hardware() -> None

List available hardware options for Jobs

func

src.huggingface_hub.cli.jobs.jobs_ssh(job_id:JobIdArg, identity_file:SshIdentityFileOpt=None, dry_run:SshDryRunOpt=False, namespace:NamespaceOpt=None, token:TokenOpt=None) -> None

SSH into a running Job.

func

src.huggingface_hub.cli.jobs.scheduled_delete(scheduled_job_id:ScheduledJobIdArg, namespace:NamespaceOpt=None, token:TokenOpt=None) -> None

Delete a scheduled Job.

func

src.huggingface_hub.cli.jobs.scheduled_resume(scheduled_job_id:ScheduledJobIdArg, namespace:NamespaceOpt=None, token:TokenOpt=None) -> None

Resume (unpause) a scheduled Job.

func

src.huggingface_hub.cli.jobs.scheduled_suspend(scheduled_job_id:ScheduledJobIdArg, namespace:NamespaceOpt=None, token:TokenOpt=None) -> None

Suspend (pause) a scheduled Job.

funcsrc.huggingface_hub.cli.lfs.read_msg() -> dict | None

Read Line delimited JSON from stdin.

funcsrc.huggingface_hub.cli.lfs.write_msg(msg:dict)

Write out the message in Line delimited JSON.

func

src.huggingface_hub.cli.papers.papers_info(paper_id:Annotated[str, Argument(help="The arXiv paper ID (e.g. '2502.08025').")], token:TokenOpt=None) -> None

Get info about a paper on the Hub.

func

src.huggingface_hub.cli.papers.papers_read(paper_id:Annotated[str, Argument(help="The arXiv paper ID (e.g. '2502.08025').")], token:TokenOpt=None) -> None

Read a paper as markdown.

func

src.huggingface_hub.cli.papers.papers_search(query:Annotated[str, Argument(help='Search query string.')], limit:LimitOpt=20, token:TokenOpt=None) -> None

Search papers on the Hub.

func

src.huggingface_hub.cli.repos.tag_list(repo_id:RepoIdArg, token:TokenOpt=None, repo_type:RepoTypeOpt=RepoType.model) -> None

List tags for a repo.

funcsrc.huggingface_hub.cli.skills.skills_list(token:TokenOpt=None) -> None

List available skills from the Hugging Face marketplace.

funcsrc.huggingface_hub.cli.skills.skills_preview() -> None

Print the generated `hf-cli` SKILL.md to stdout.

func

src.huggingface_hub.cli.spaces.secrets_ls(space_id:Annotated[str, Argument(help='The space ID (e.g. `username/repo-name`).')], token:TokenOpt=None) -> None

List secrets for a Space.

funcsrc.huggingface_hub.cli.spaces.spaces_hardware(token:TokenOpt=None) -> None

List available hardware options for Spaces.

func

src.huggingface_hub.cli.spaces.spaces_pause(space_id:Annotated[str, Argument(help='The space ID (e.g. `username/repo-name`).')], token:TokenOpt=None) -> None

Pause a Space.

funcsrc.huggingface_hub.cli.spaces.spaces_templates(token:TokenOpt=None) -> None

List the available Space templates.

func

src.huggingface_hub.cli.spaces.variables_ls(space_id:Annotated[str, Argument(help='The space ID (e.g. `username/repo-name`).')], token:TokenOpt=None) -> None

List environment variables for a Space.

func

src.huggingface_hub.cli.spaces.volumes_ls(space_id:Annotated[str, Argument(help='The space ID (e.g. `username/repo-name`).')], token:TokenOpt=None) -> None

List volumes mounted in a Space.

func

src.huggingface_hub.cli.spaces.volumes_set(space_id:Annotated[str, Argument(help='The space ID (e.g. `username/repo-name`).')], volume:VolumesOpt=None, token:TokenOpt=None) -> None

Set (replace) volumes for a Space.

funcsrc.huggingface_hub.cli.system.env() -> None

Print information about the environment.

funcsrc.huggingface_hub.cli.system.update() -> None

Update the `hf` CLI to the latest version.

funcsrc.huggingface_hub.cli.system.version() -> None

Print information about the hf version.

func

src.huggingface_hub.cli.webhooks.webhooks_disable(webhook_id:Annotated[str, Argument(help='The ID of the webhook to disable.')], token:TokenOpt=None) -> None

Disable an active webhook.

func

src.huggingface_hub.cli.webhooks.webhooks_enable(webhook_id:Annotated[str, Argument(help='The ID of the webhook to enable.')], token:TokenOpt=None) -> None

Enable a disabled webhook.

func

src.huggingface_hub.cli.webhooks.webhooks_info(webhook_id:Annotated[str, Argument(help='The ID of the webhook.')], token:TokenOpt=None) -> None

Show full details for a single webhook.

funcsrc.huggingface_hub.cli.webhooks.webhooks_ls(token:TokenOpt=None) -> None

List all webhooks for the current user.

classsrc.huggingface_hub.community.Discussion

A Discussion or Pull Request on the Hub.

methodsrc.huggingface_hub.community.Discussion.url() -> str

Returns the URL of the discussion on the Hub.

classsrc.huggingface_hub.community.DiscussionComment

A comment in a Discussion / Pull Request.

methodsrc.huggingface_hub.community.DiscussionComment.edit_history() -> list[dict]

The edit history of the comment

methodsrc.huggingface_hub.community.DiscussionComment.last_edited_at() -> datetime

The last edit time, as a `datetime` object.

methodsrc.huggingface_hub.community.DiscussionComment.last_edited_by() -> str

The last edit time, as a `datetime` object.

methodsrc.huggingface_hub.community.DiscussionComment.rendered() -> str

The rendered comment, as a HTML string

classsrc.huggingface_hub.community.DiscussionCommit

A commit in a Pull Request.

classsrc.huggingface_hub.community.DiscussionEvent

An event in a Discussion or Pull Request.

classsrc.huggingface_hub.community.DiscussionStatusChange

A change of status in a Discussion / Pull Request.

classsrc.huggingface_hub.community.DiscussionTitleChange

A rename event in a Discussion / Pull Request.

classsrc.huggingface_hub.community.DiscussionWithDetails

Subclass of [`Discussion`].

funcsrc.huggingface_hub.community.deserialize_event(event:dict) -> DiscussionEvent

Instantiates a [`DiscussionEvent`] from a dict

funcsrc.huggingface_hub.constants.is_offline_mode() -> bool

Returns whether we are in offline mode for the Hub.

funcsrc.huggingface_hub.dataclasses.init_with_validate(self, *args, **kwargs) -> None

Run class validators after initialization.

funcsrc.huggingface_hub.dataclasses.type_validator(name:str, value:Any, expected_type:Any) -> None

Validate that 'value' matches 'expected_type'.

funcsrc.huggingface_hub.dataclasses.validate(self:T) -> None

Run class validators on the instance.

classsrc.huggingface_hub.errors.CLIError

CLI error with clean message (no traceback by default).

classsrc.huggingface_hub.errors.CLIExtensionInstallError

Error during CLI extension installation.

classsrc.huggingface_hub.errors.DDUFCorruptedFileError

Exception thrown when the DDUF file is corrupted.

classsrc.huggingface_hub.errors.DDUFError

Base exception for errors related to the DDUF format.

classsrc.huggingface_hub.errors.DDUFExportError

Base exception for errors during DDUF export.

classsrc.huggingface_hub.errors.DDUFInvalidEntryNameError

Exception thrown when the entry name is invalid.

classsrc.huggingface_hub.errors.FileDuplicationError

Raised when duplicating files across repos fails.

classsrc.huggingface_hub.errors.HfUriError

Raised when an `hf://...` URI is malformed.

classsrc.huggingface_hub.errors.LocalTokenNotFoundError

Raised if local token is required but not found.

classsrc.huggingface_hub.errors.NotASafetensorsRepoError

Raised when a repo is not a Safetensors repo i.e.

classsrc.huggingface_hub.errors.StrictDataclassError

Base exception for strict dataclasses.

classsrc.huggingface_hub.errors.TextGenerationError

Generic error raised if text-generation went wrong.

classsrc.huggingface_hub.errors.ValidationError

Server-side validation error.

classsrc.huggingface_hub.inference._client.InferenceClient

Initialize a new Inference Client.

methodsrc.huggingface_hub.inference._client.InferenceClient.get_endpoint_info(*model:str | None=None) -> dict[str, Any]

Get information about the deployed endpoint.

methodsrc.huggingface_hub.inference._client.InferenceClient.health_check(model:str | None=None) -> bool

Check the health of the deployed endpoint.

method

src.huggingface_hub.inference._client.InferenceClient.image_to_text(image:ContentT, *model:str | None=None) -> ImageToTextOutput

Takes an input image and return text.

classsrc.huggingface_hub.inference._common.MimeBytes

A bytes object with a mime type.

classsrc.huggingface_hub.inference._generated._async_client.AsyncInferenceClient

Initialize a new Inference Client.

methodsrc.huggingface_hub.inference._generated._async_client.AsyncInferenceClient.close()

Close the client.

methodsrc.huggingface_hub.inference._generated._async_client.AsyncInferenceClient.health_check(model:str | None=None) -> bool

Check the health of the deployed endpoint.

method

src.huggingface_hub.inference._generated._async_client.AsyncInferenceClient.image_to_text(image:ContentT, *model:str | None=None) -> ImageToTextOutput

Takes an input image and return text.

classsrc.huggingface_hub.inference._generated.types.audio_to_audio.AudioToAudioInput

Inputs for Audio to Audio inference

classsrc.huggingface_hub.inference._generated.types.base.BaseInferenceType

Base class for all inference types.

classsrc.huggingface_hub.inference._generated.types.chat_completion.ChatCompletionInput

Chat Completion Input.

classsrc.huggingface_hub.inference._generated.types.chat_completion.ChatCompletionOutput

Chat Completion Output.

classsrc.huggingface_hub.inference._generated.types.chat_completion.ChatCompletionStreamOutput

Chat Completion Stream Output.

classsrc.huggingface_hub.inference._generated.types.depth_estimation.DepthEstimationInput

Inputs for Depth Estimation inference

classsrc.huggingface_hub.inference._generated.types.feature_extraction.FeatureExtractionInput

Feature Extraction Input.

classsrc.huggingface_hub.inference._generated.types.fill_mask.FillMaskInput

Inputs for Fill Mask inference

classsrc.huggingface_hub.inference._generated.types.image_to_image.ImageToImageInput

Inputs for Image To Image inference

classsrc.huggingface_hub.inference._generated.types.image_to_image.ImageToImageTargetSize

The size in pixels of the output image.

classsrc.huggingface_hub.inference._generated.types.image_to_text.ImageToTextInput

Inputs for Image To Text inference

classsrc.huggingface_hub.inference._generated.types.image_to_video.ImageToVideoInput

Inputs for Image To Video inference

classsrc.huggingface_hub.inference._generated.types.object_detection.ObjectDetectionBoundingBox

The predicted bounding box.

classsrc.huggingface_hub.inference._generated.types.object_detection.ObjectDetectionInput

Inputs for Object Detection inference

classsrc.huggingface_hub.inference._generated.types.summarization.SummarizationInput

Inputs for Summarization inference

classsrc.huggingface_hub.inference._generated.types.text_generation.TextGenerationInput

Text Generation Input.

classsrc.huggingface_hub.inference._generated.types.text_generation.TextGenerationOutput

Text Generation Output.

classsrc.huggingface_hub.inference._generated.types.text_generation.TextGenerationStreamOutput

Text Generation Stream Output.

classsrc.huggingface_hub.inference._generated.types.text_to_audio.TextToAudioInput

Inputs for Text To Audio inference

classsrc.huggingface_hub.inference._generated.types.text_to_image.TextToImageInput

Inputs for Text To Image inference

classsrc.huggingface_hub.inference._generated.types.text_to_speech.TextToSpeechInput

Inputs for Text To Speech inference

classsrc.huggingface_hub.inference._generated.types.text_to_video.TextToVideoInput

Inputs for Text To Video inference

classsrc.huggingface_hub.inference._generated.types.translation.TranslationInput

Inputs for Translation inference

classsrc.huggingface_hub.inference._generated.types.zero_shot_object_detection.ZeroShotObjectDetectionBoundingBox

The predicted bounding box.

funcsrc.huggingface_hub.inference._mcp.cli.run_agent(agent_path:Optional[str]) -> None

Tiny Agent loop.

classsrc.huggingface_hub.inference._providers._common.AutoRouterConversationalTask

Auto-router for conversational tasks.

classsrc.huggingface_hub.inference._providers._common.TaskProviderHelper

Base class for task-specific provider helpers.

func

src.huggingface_hub.inference._providers.get_provider_helper(provider:PROVIDER_OR_POLICY_T | None, task:str, model:str | None) -> TaskProviderHelper

Get provider helper instance by name and task.

classsrc.huggingface_hub.inference._providers.hf_inference.HFInferenceTask

Base class for HF Inference API tasks.

classsrc.huggingface_hub.inference._providers.together.TogetherTask

Base class for Together API tasks.

classsrc.huggingface_hub.repocard_data.CardData

Structure containing metadata from a RepoCard.

methodsrc.huggingface_hub.repocard_data.CardData.get(key:str, default:Any=None) -> Any

Get value for a given metadata key.

methodsrc.huggingface_hub.repocard_data.CardData.pop(key:str, default:Any=None) -> Any

Pop value for a given metadata key.

methodsrc.huggingface_hub.repocard_data.CardData.to_dict()

Converts CardData to a dict.

classsrc.huggingface_hub.serialization._dduf.DDUFEntry

Object representing a file entry in a DDUF file.

methodsrc.huggingface_hub.serialization._dduf.DDUFEntry.as_mmap() -> Generator[bytes, None, None]

Open the file as a memory-mapped file.

methodsrc.huggingface_hub.serialization._dduf.DDUFEntry.read_text(encoding:str='utf-8') -> str

Read the file as text.

func

src.huggingface_hub.serialization._dduf.export_folder_as_dduf(dduf_path:str | os.PathLike, folder_path:str | os.PathLike) -> None

Export a folder as a DDUF file.

funcsrc.huggingface_hub.utils._auth.get_token() -> str | None

Get token if user is logged in.

funcsrc.huggingface_hub.utils._chunk_utils.chunk_iterable(iterable:Iterable[T], chunk_size:int) -> Iterable[Iterable[T]]

Iterates over an iterator chunk by chunk.

classsrc.huggingface_hub.utils._detect_agent.HarnessInfo

A single harness entry.

funcsrc.huggingface_hub.utils._experimental.experimental(fn:Callable) -> Callable

Decorator to flag a feature as experimental.

func

src.huggingface_hub.utils._fixes.WeakFileLock(lock_file:str | Path, *timeout:float | None=None) -> Generator[BaseFileLock, None, None]

A filelock with some custom logic.

funcsrc.huggingface_hub.utils._http.async_hf_request_event_hook(request:httpx.Request) -> None

Async version of `hf_request_event_hook`.

funcsrc.huggingface_hub.utils._http.fix_hf_endpoint_in_url(url:str, endpoint:str | None) -> str

Replace the default endpoint in a URL by a custom one.

funcsrc.huggingface_hub.utils._oauth_device.refresh_access_token(refresh_token:str) -> OAuthTokenResponse

Exchange a refresh token for a new access token.

funcsrc.huggingface_hub.utils._runtime.is_google_colab() -> bool

Return `True` if code is executed in a Google colab.

classsrc.huggingface_hub.utils._safetensors.SafetensorsRepoMetadata

Metadata for a Safetensors repo.

classsrc.huggingface_hub.utils._safetensors.TensorInfo

Information about a tensor.

func

src.huggingface_hub.utils._subprocess.run_subprocess(command:str | list[str], folder:str | Path | None=None, check=True, **kwargs) -> subprocess.CompletedProcess

Method to run subprocesses.

classsrc.huggingface_hub.utils._terminal.ANSI

Helper for en.wikipedia.org/wiki/ANSI_escape_code

funcsrc.huggingface_hub.utils._terminal.select_choice(prompt:str, choices:list[str]) -> int

Single-choice interactive prompt.

funcsrc.huggingface_hub.utils._typing.is_jsonable(obj:Any, _visited:set[int] | None=None) -> bool

Check if an object is JSON serializable.

funcsrc.huggingface_hub.utils._typing.is_simple_optional_type(type_:type) -> bool

Check if a type is optional, i.e.

funcsrc.huggingface_hub.utils._typing.unwrap_simple_optional_type(optional_type:type) -> type

Unwraps a simple optional type, i.e.

funcsrc.huggingface_hub.utils._validators.validate_repo_id(repo_id:str | None) -> None

Validate `repo_id` is valid.

classsrc.huggingface_hub.utils._xet_progress_reporting.XetUploadProgressReporter

Reports on progress for Xet uploads.

funcsrc.huggingface_hub.utils.logging.disable_propagation() -> None

Disable propagation of the library log outputs.

funcsrc.huggingface_hub.utils.logging.enable_propagation() -> None

Enable propagation of the library log outputs.

funcsrc.huggingface_hub.utils.logging.get_logger(name:str | None=None) -> logging.Logger

Returns a logger with the specified name.

funcsrc.huggingface_hub.utils.logging.set_verbosity(verbosity:int) -> None

Sets the level for the HuggingFace Hub's root logger.

classsrc.huggingface_hub.utils.tqdm.silent_tqdm

Fake tqdm object that does nothing.

funcutils._legacy_check_future_compatible_signatures.format_generated_code(code:str) -> str

Format some code with ruff.

funcutils.check_all_variable.check_static_all(update:bool) -> NoReturn

Check if __all__ is aligned with _SUBMOD_ATTRS or update it.

funcutils.check_all_variable.parse_all_definition(content:str) -> list[str]

Extract the current __all__ contents from file content.

classutils.check_task_parameters.AddImports

Transformer that adds import statements to the module.

methodutils.check_task_parameters.AddImports.leave_Module(original_node:cst.Module, updated_node:cst.Module) -> cst.Module

Insert the import statements into the module.

methodutils.check_task_parameters.ModulesCollector.visit_ImportFrom(node:cst.ImportFrom)

Map imported types to their modules.

classutils.check_task_parameters.UpdateParameters

Updates a method's parameters, types, and docstrings.

funcutils.generate_async_inference_client.generate_async_client_code(code:str) -> str

Generate AsyncInferenceClient source code.

funcutils.generate_inference_types.check_inference_types(update:bool) -> NoReturn

Check and update inference types.

funcutils.generate_inference_types.fix_legacy_annotation(content:str) -> str

Fix legacy type annotations (e.g., `List` -> `list`).

func

utils.generate_inference_types.generate_reference_package(dataclasses:dict[str, list[str]], language:Literal['en', 'ko']) -> str

Generate the reference package content.

funcutils.helpers.format_source_code(code:str) -> str

Format the generated source code using Ruff.

funcutils.release_notes.fetch_prs.extract_pr_number(commit_message:str) -> int | None

Extract PR number from a squash-merge commit message.

funcutils.release_notes.fetch_prs.fetch_doc_diffs(pr) -> list[dict]

Extract diffs for .md files under docs/ from a PR.

funcutils.release_notes.fetch_prs.fetch_pr_details(repo, pr_number:int) -> dict

Fetch full details for a PR, including doc diffs.

funcutils.release_notes.fetch_prs.get_commits_since_tag(repo, tag_name:str) -> list

Get all commits between a tag and HEAD on main.

funcutils.release_notes.fetch_prs.get_github_client() -> Github

Get authenticated GitHub client.

funcutils.release_notes.fetch_prs.save_manifest(pr_numbers:list[int], output_dir:Path) -> None

Save manifest with all PR numbers.

funcutils.release_notes.fetch_prs.save_pr_json(pr_data:dict, output_dir:Path) -> None

Save PR data to a JSON file.

funcutils.release_notes.generate_release_notes.bump_version(tag:str, bump_type:str='patch') -> str

Bump a semver tag by major, minor, or patch.

funcutils.release_notes.generate_release_notes.check_opencode_model(model:str) -> None

Verify that ``model`` is listed by ``opencode models``.

funcutils.release_notes.generate_release_notes.cli()

CLI entry point.

funcutils.release_notes.generate_release_notes.main(since_tag:str, bump_type:str='patch', max_iterations:int=3) -> int

Run the full release notes generation pipeline.

func

utils.release_notes.generate_release_notes.run_opencode_skill(skill_name:str, version:str, missing_prs:list[int] | None=None, extra_prs:list[int] | None=None) -> bool

Run an OpenCode skill non-interactively.

funcutils.release_notes.generate_release_notes.setup_directories() -> None

Create output directories.

funcutils.release_notes.generate_slack_message.cli()

CLI entry point.

func

utils.release_notes.generate_slack_message.main(version:str, rc_version:str, input_file:Path | None=None, output_file:Path | None=None) -> int

Generate a Slack announcement message.

funcutils.release_notes.generate_slack_message.run_opencode_skill(version:str, input_file:Path, output_file:Path) -> bool

Run the hf-release-notes:slack OpenCode skill.

funcutils.release_notes.validate_notes.extract_pr_references(markdown_content:str) -> set[int]

Extract all PR numbers referenced in the markdown.

funcutils.release_notes.validate_notes.find_release_notes_file(version:str | None=None) -> Path | None

Find the release notes file for a version.

funcutils.release_notes.validate_notes.load_manifest() -> list[int]

Load PR numbers from manifest.json.

funcutils.release_notes.validate_notes.main()

Main entry point.

この情報について

掲載しているシグネチャは huggingface/huggingface_hub の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る