# HfApi クライアント

以下は、Hugging Face Hub の API の Python ラッパーとして機能する `HfApi` クラスのドキュメントです。

`HfApi`のすべてのメソッドは、パッケージのルートから直接アクセスすることもできます。両方のアプローチについては以下に詳しく説明します。

ルートメソッドを使用する方がよりシンプルですが、[HfApi](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi) クラスの方がより柔軟性があります。特に、すべての HTTP 呼び出しで再利用されるトークンを渡すことができます。これは `hf auth login` や [login()](/docs/huggingface_hub/v2.4.0/ja/package_reference/authentication#huggingface_hub.login) と異なり、トークンはマシン上に永続化されません。また、別のエンドポイントを指定したり、カスタムのユーザーエージェントを設定したりすることも可能です。

```python
from huggingface_hub import HfApi, list_models

# Use root method
models = list_models()

# Or configure a HfApi client
hf_api = HfApi(
    endpoint="https://huggingface.co", # Can be a Private Hub endpoint.
    token="hf_xxx", # Token is not persisted on the machine.
)
models = hf_api.list_models()
```

## HfApi[[huggingface_hub.HfApi]]

#### huggingface_hub.HfApi[[huggingface_hub.HfApi]]

```python
huggingface_hub.HfApi(endpoint: str | None = None, token: str | bool | None = None, library_name: str | None = None, library_version: str | None = None, user_agent: dict | str | None = None, headers: dict[str, str] | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2127)

**パラメータ:**

endpoint (`str`, *任意*) : Hub のエンドポイント。デフォルトは です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

library_name (`str`, *任意*) : HTTP リクエストを発行するライブラリの名前です。user-agent ヘッダーに追加されます。例: `"transformers"`。

library_version (`str`, *任意*) : HTTP リクエストを発行しているライブラリのバージョンです。user-agent ヘッダーに追加されます。例: `"4.24.0"`。

user_agent (`str`、`dict`、*任意*) : 辞書または単一の文字列形式のユーザーエージェント情報です。インストールされているパッケージに関する情報で補完されます。

headers (`dict`, *任意*) : 各リクエストに送信する追加のヘッダー。例: `{"X-My-Header": "value"}`。ここで渡されたヘッダーは、デフォルトのヘッダーよりも優先されます。

HTTP経由でHugging Face Hubとやり取りするためのクライアント。

クライアントは、Hub へのすべてのリクエストで使用される高レベルの設定（HF エンドポイント、認証、ユーザーエージェントなど）で初期化されます。`HfApi` クライアントの使用が推奨されますが、必須ではありません。`huggingface_hub` のルートに、そのすべての公開メソッドが直接公開されているためです。

#### accept_access_request[[huggingface_hub.HfApi.accept_access_request]]

```python
accept_access_request(repo_id: str, user: str | None = None, request_id: str | None = None, repo_type: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10873)

**パラメータ:**

repo_id (`str`) : アクセス要求を受け入れるリポジトリのID。

user (`str`, *任意*) : アクセス要求を受け入れるユーザーのユーザー名です。`user`または`request_id`のいずれか1つを指定する必要があります。

request_id (`str`, *任意*) : 承認するアクセスリクエストの ID（`AccessRequest`を参照）。リポジトリがリクエスト送信者のユーザー名を共有しないように設定されている場合に必須です。`user`または`request_id`のいずれか一方のみを指定する必要があります。

repo_type (`str`, *任意*) : アクセス要求を受け入れるリポジトリの種類です。`model`、`dataset`、または`space`のいずれかである必要があります。デフォルトは`model`です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` -- リポジトリがゲート付きでない場合、HTTP 400 が返されます。
- `HfHubHTTPError` -- リポジトリへのアクセス権限が読み取り専用の場合、HTTP 403 が返されます。リポジトリが属する組織で `write` または `admin` のロールを持っていない場合、または `read` トークンを渡した場合に、この状況が発生します。
- `HfHubHTTPError` -- ユーザーが Hub に存在しない場合、HTTP 404 が返されます。
- `HfHubHTTPError` -- ユーザーのアクセスリクエストが見つからない場合、HTTP 404 が返されます。
- `HfHubHTTPError` -- ユーザーのアクセスリクエストが既に承認リストに含まれている場合、HTTP 404 が返されます。

指定されたゲート付きリポジトリに対するユーザーのアクセス要求を受け入れます。

リクエストが承認されると、ユーザーはリポジトリ内の任意のファイルをダウンロードし、コミュニティタブにアクセスできるようになります。承認モードが自動の場合、リクエストを手動で承認する必要はありません。承認済みのリクエストは、[cancel_access_request()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.cancel_access_request)および[reject_access_request()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.reject_access_request)を使用して、いつでもキャンセルまたは拒否できます。

ゲート付きリポジトリの詳細については、https://huggingface.co/docs/hub/models-gated を参照してください。

#### add_collection_item[[huggingface_hub.HfApi.add_collection_item]]

```python
add_collection_item(collection_slug: str, item_id: str, item_type: CollectionItemType_T, note: str | None = None, exists_ok: bool = False, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10411)

**パラメータ:**

collection_slug (`str`) : 更新するコレクションのスラッグ。例: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`。

item_id (`str`) : コレクションに追加するアイテムのID。リポジトリ/スペース/データセットにはrepo_id、論文には論文ID、別のコレクションのスラグ（例: `"moonshotai/kimi-k2"`）またはバケットID（例: `"namespace/bucket-name"`）を使用します。

item_type (`str`) : 追加するアイテムのタイプ。`"model"`、`"dataset"`、`"space"`、`"paper"`、`"collection"`、`"bucket"` のいずれかです。

note (`str`, *任意*) : コレクション内のアイテムに付与するメモ。メモの最大サイズは500文字です。

exists_ok (`bool`, *任意*) : `True`の場合、アイテムが既に存在していてもエラーを発生させません。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` -- リポジトリへのアクセス権限が読み取り専用の場合、HTTP 403 が返されます。リポジトリが属する組織で `write` または `admin` のロールを持っていない場合、または `read` トークンを渡した場合に、この状況が発生します。
- `HfHubHTTPError` -- コレクションに追加しようとしたアイテムがHub上に存在しない場合、HTTP 404 が返されます。
- `HfHubHTTPError` -- コレクションに追加しようとしたアイテムが既にコレクションに存在する場合（かつ exists_ok=False の場合）、HTTP 409

Hub上のコレクションにアイテムを追加します。

戻り値: [Collection](/docs/huggingface_hub/v2.4.0/ja/package_reference/collections#huggingface_hub.Collection)

例:

```py
>>> from huggingface_hub import add_collection_item
>>> collection = add_collection_item(
...     collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab",
...     item_id="pierre-loic/climate-news-articles",
...     item_type="dataset"
... )
>>> collection.items[-1].item_id
"pierre-loic/climate-news-articles"
# ^item got added to the collection on last position

# Add item with a note
>>> add_collection_item(
...     collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab",
...     item_id="datasets/climate_fever",
...     item_type="dataset",
...     note="This dataset adopts the FEVER methodology that consists of 1,535 real-world claims regarding climate-change collected on the internet."
... )
(...)
```

#### add_space_secret[[huggingface_hub.HfApi.add_space_secret]]

```python
add_space_secret(repo_id: str, key: str, value: str, description: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8043)

**パラメータ:**

repo_id (`str`) : 更新するリポジトリの ID。例: `"bigcode/in-the-stack"`。

key (`str`) : シークレットキー。例: `"GITHUB_API_KEY"`

value (`str`) : シークレット値。例: `"your_github_api_key"`。

description (`str`, *任意*) : シークレットの説明。例: `"Github API key to access the Github API"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

Spaceにシークレットを追加または更新します。

Secretsを使用すると、Spaceにシークレットキーやトークンを設定できますが、ハードコードする必要はありません。詳細については、https://huggingface.co/docs/hub/spaces-overview#managing-secretsを参照してください。

#### add_space_variable[[huggingface_hub.HfApi.add_space_variable]]

```python
add_space_variable(repo_id: str, key: str, value: str, description: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8169)

**パラメータ:**

repo_id (`str`) : 更新するリポジトリの ID。例: `"bigcode/in-the-stack"`。

key (`str`) : 変数のキー。例: `"MODEL_REPO_ID"`

value (`str`) : 変数の値。例: `"the_model_repo_id"`。

description (`str`) : 変数の説明。例: `"Model Repo ID of the implemented model"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

Space内の変数を追加または更新します。

変数を使用すると、Space にハードコードせずに環境変数を設定できます。詳細については、https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables を参照してください。

#### auth_check[[huggingface_hub.HfApi.auth_check]]

```python
auth_check(repo_id: str, repo_type: str | None = None, token: bool | str | None = None, write: bool = False)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12047)

**パラメータ:**

repo_id (`str`) : アクセスを確認するリポジトリ。形式は`"user/repo_name"`です。例: `"user/my-cool-model"`。

repo_type (`str`, *任意*) : リポジトリのタイプ。`"model"`、`"dataset"`、または`"space"`のいずれかである必要があります。指定しない場合、デフォルトは`"model"`です。

token (`Union[bool, str, None]`, *任意*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

write (`bool`, *optional*) : `True`の場合、ユーザーがリポジトリに対してコンテンツの書き込み権限を持っているかどうかを確認します。`False`（デフォルト）の場合、読み取りアクセスのみを確認します。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [GatedRepoError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.GatedRepoError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- リポジトリが存在しない、プライベートである、またはユーザーがアクセス権限を持っていない場合に発生します。`repo_id`または`repo_type`が誤っている場合、またはリポジトリがプライベートであるがユーザーが認証されていない場合に発生する可能性があります。

- [GatedRepoError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.GatedRepoError) -- リポジトリが存在するが、ゲート付きであり、ユーザーがアクセス権限を持っていない場合に発生します。

Hugging Face Hub上の特定のリポジトリに、提供されたユーザートークンがアクセスできるかどうかを確認します。

このメソッドは、提供されたトークンで認証されたユーザーが、指定されたリポジトリにアクセスできるかどうかを検証します。リポジトリが見つからない場合、またはユーザーにアクセスに必要な権限がない場合、このメソッドは適切な例外をスローします。

例:

ユーザーがリポジトリにアクセスできるか確認します:

```python
>>> from huggingface_hub import auth_check
>>> from huggingface_hub.utils import GatedRepoError, RepositoryNotFoundError

try:
    auth_check("user/my-cool-model")
except GatedRepoError:
    # Handle gated repository error
    print("You do not have permission to access this gated repository.")
except RepositoryNotFoundError:
    # Handle repository not found error
    print("The repository was not found or you do not have access.")
```

この例では:
- ユーザーがアクセス権限を持っている場合、メソッドは正常に完了します。
- リポジトリがゲート付きであるか存在しない場合、適切な例外がスローされ、ユーザーが
それらを適切に処理するために。

#### batch_bucket_files[[huggingface_hub.HfApi.batch_bucket_files]]

```python
batch_bucket_files(bucket_id: str, add: list[tuple[str | Path | bytes, str]] | None = None, copy: list[tuple[str, str, str, str]] | None = None, delete: list[str] | None = None, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14729)

**パラメータ:**

bucket_id (`str`) : バケットのID（例: `"username/my-bucket"`）。

add (`list` of `tuple`, *optional*) : アップロードするファイル。各要素は`(source, destination)`のタプルで、`source`はローカルファイルへのパス(`str`または`Path`)または生の`bytes`コンテンツ、`destination`はバケット内のパスです。

copy (`list` of `tuple`, *optional*) : xet ハッシュでコピーするファイル。各要素は `(source_repo_type, source_repo_id, xet_hash, destination)` のタプルで、以下を指します: - `source_repo_type` はソースリポジトリのタイプ: `"model"`、`"dataset"`、`"space"`、または `"bucket"`。 - `source_repo_id` はソースリポジトリまたはバケットの ID (例: `"username/my-model"`)。 - `xet_hash` はコピーするファイルの xet ハッシュ。 - `destination` はバケット内の宛先パス。これはサーバーサイドの操作であり、データのダウンロードや再アップロードは行われません。

delete (`list` of `str`, *optional*) : バケットから削除するファイルのパス。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**例外:** `BucketBatchError`

- `BucketBatchError` -- サーバーが一部の操作の失敗を報告した場合に発生します。エラーはすべての操作が送信された後に一度だけ発生するため、バッチ内の他の操作は適用されています。

バケット内のファイルを追加、コピー、および/または削除します。

これはトランザクション非対応の操作です。処理中にエラーが発生した場合、一部のファイルがアップロード、コピー、または削除された一方で、他のファイルがまだ処理されていない可能性があります。

例:
```python
>>> from huggingface_hub import batch_bucket_files

# Upload files
>>> batch_bucket_files(
...     "username/my-bucket",
...     add=[
...         ("./model.safetensors", "models/model.safetensors"),
...         (b'{{"key": "value"}}', "config.json"),
...     ],
... )

# Copy xet files from another bucket or repo (server-side, no data transfer)
>>> batch_bucket_files(
...     "username/my-bucket",
...     copy=[
...         ("bucket", "username/source-bucket", "<xethash_1>", "models/model.safetensors"),
...         ("model", "username/my-model", "<xethash_2>", "models/config.safetensors"),
...     ],
... )

# Delete files
>>> batch_bucket_files("username/my-bucket", delete=["old-model.bin"])

# Upload and delete in one batch
>>> batch_bucket_files(
...     "username/my-bucket",
...     add=[("./new.txt", "new.txt")],
...     delete=["old.txt"],
... )
```

#### bucket_info[[huggingface_hub.HfApi.bucket_info]]

```python
bucket_info(bucket_id: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14058)

**パラメータ:**

bucket_id (`str`) : バケットのID（例: `"username/my-bucket"`）。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [BucketInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.BucketInfo)

バケット情報。

**例外:** `BucketNotFoundError` または ``or``

- `BucketNotFoundError` -- バケットが見つからない場合。存在しないことが原因である可能性があります。
- ``or`` -- `private`に設定されているため、アクセス権限がないためです。

Hub上の特定のバケットに関する情報を取得します。

例:
```python
>>> from huggingface_hub import bucket_info
>>> info = bucket_info(bucket_id="Wauplin/first-bucket")
>>> info.id
'Wauplin/first-bucket'
>>> info.private
False
>>> info.created_at
datetime.datetime(2026, 2, 6, 17, 37, 57, tzinfo=datetime.timezone.utc)
>>> info.size
551879671
>>> info.total_files
12
```

#### cancel_access_request[[huggingface_hub.HfApi.cancel_access_request]]

```python
cancel_access_request(repo_id: str, user: str | None = None, request_id: str | None = None, repo_type: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10823)

**パラメータ:**

repo_id (`str`) : アクセス要求を取り消すリポジトリのID。

user (`str`, *任意*) : アクセス要求のキャンセル対象となるユーザー名。`user`または`request_id`のいずれか一方のみを指定する必要があります。

request_id (`str`, *任意*) : キャンセルするアクセスリクエストの ID（`AccessRequest`を参照）。リポジトリがリクエスト送信者のユーザー名を共有しないように設定されている場合に必須です。`user`または`request_id`のいずれか一方のみを指定する必要があります。

repo_type (`str`, *任意*) : アクセス要求を取り消すリポジトリの種類。`model`、`dataset`、`space` のいずれかである必要があります。デフォルトは `model` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` -- リポジトリがゲート付きでない場合、HTTP 400 が返されます。
- `HfHubHTTPError` -- リポジトリへのアクセス権限が読み取り専用の場合、HTTP 403 が返されます。リポジトリが属する組織で `write` または `admin` のロールを持っていない場合、または `read` トークンを渡した場合に、この状況が発生します。
- `HfHubHTTPError` -- ユーザーが Hub に存在しない場合、HTTP 404 が返されます。
- `HfHubHTTPError` -- ユーザーのアクセスリクエストが見つからない場合、HTTP 404 が返されます。
- `HfHubHTTPError` -- ユーザーのアクセスリクエストが既に保留リストにある場合、HTTP 404 が返されます。

指定されたゲート付きリポジトリに対するユーザーのアクセスリクエストをキャンセルします。

キャンセルされたリクエストは保留リストに戻り、ユーザーはリポジトリへのアクセスを失います。

ゲート付きリポジトリの詳細については、https://huggingface.co/docs/hub/models-gated を参照してください。

#### cancel_job[[huggingface_hub.HfApi.cancel_job]]

```python
cancel_job(job_id: str, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12757)

**パラメータ:**

job_id (`str`) : Job の ID。

namespace (`str`, *任意*) : Job が実行されている名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

Hugging Faceのインフラストラクチャ上で、計算ジョブをキャンセルします。

#### change_discussion_status[[huggingface_hub.HfApi.change_discussion_status]]

```python
change_discussion_status(repo_id: str, discussion_num: int, new_status: Literal['open', 'closed'], token: bool | str | None = None, comment: str | None = None, repo_type: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7756)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

discussion_num (`int`) : Discussion または Pull Request の番号です。正の整数である必要があります。

new_status (`str`) : ディスカッションの新しいステータス。`"open"`または`"closed"`のいずれかです。

comment (`str`, *任意*) : ステータス変更と同時に投稿する任意のコメント。

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [DiscussionStatusChange](/docs/huggingface_hub/v2.4.0/ja/package_reference/community#huggingface_hub.DiscussionStatusChange)

ステータス変更イベント

DiscussionまたはPull Requestを閉じるか、再オープンします。

例:
```python
>>> HfApi().change_discussion_status(
...     repo_id="username/repo_name",
...     discussion_num=34,
...     new_status="closed"
... )
# DiscussionStatusChange(id='deadbeef0000000', type='status-change', ...)

```

> [!TIP]
> 以下のエラーを発生させます：
>
> - HuggingFace APIがエラーを返した場合に[`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) - パラメータの値が無効な場合に[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) - ダウンロード元のリポジトリが見つからない場合に[RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)。存在しないか、`private`に設定されていてアクセス権限がないためです。

#### comment_discussion[[huggingface_hub.HfApi.comment_discussion]]

```python
comment_discussion(repo_id: str, discussion_num: int, comment: str, token: bool | str | None = None, repo_type: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7613)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

discussion_num (`int`) : Discussion または Pull Request の番号です。正の整数である必要があります。

comment (`str`) : 作成するコメントの内容。コメントはMarkdown形式の書式に対応しています。

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [DiscussionComment](/docs/huggingface_hub/v2.4.0/ja/package_reference/community#huggingface_hub.DiscussionComment)

新しく作成されたコメント

指定されたDiscussionに新しいコメントを作成します。

例:
```python

>>> comment = """
... Hello @otheruser!
...
... # This is a title
...
... **This is bold**, *this is italic* and ~this is strikethrough~
... And [this](http://url) is a link
... """

>>> HfApi().comment_discussion(
...     repo_id="username/repo_name",
...     discussion_num=34,
...     comment=comment
... )
# DiscussionComment(id='deadbeef0000000', type='comment', ...)

```

> [!TIP]
> 以下のエラーを発生させます：
>
> - HuggingFace APIがエラーを返した場合に[`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) - パラメータの値が無効な場合に[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) - ダウンロード元のリポジトリが見つからない場合に[RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)。存在しないか、`private`に設定されていてアクセス権限がないためです。

#### copy_files[[huggingface_hub.HfApi.copy_files]]

```python
copy_files(source: str, destination: str, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14410)

**パラメータ:**

source (`str`) : `hf://` URI としてのソースの場所。バケットパス（例: `"hf://buckets/my-bucket/path/to/file"`）またはリポジトリパス（例: `"hf://username/my-model/weights.bin"`、`"hf://datasets/username/my-dataset/data/"`）を指定できます。

destination (`str`) : バケット（例: `"hf://buckets/my-bucket/target/path"`）またはリポジトリ（例: `"hf://username/my-model/target/path"`）を指す `hf://` URI としての保存先。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**例外:** ``ValueError``

- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- ソース/宛先の URI が無効な場合、またはバケットからリポジトリへコピーする場合。

Hub上の異なる場所間でファイルをコピーします。

バケットまたはリポジトリ（モデル、データセット、スペース）から、バケットまたは別のリポジトリにファイルをコピーします。単一のファイルだけでなく、フォルダ全体もサポートされています。

フォルダをコピーする際、ソースパスの末尾に`/`がある場合、rsync 形式のセマンティクスが適用されます。つまり、ソースフォルダ自体をネストせずに、その*中身*をデスティネーションにコピーします。末尾に`/`がない場合、ソースフォルダはデスティネーション内にネストされます（`cp -r`と同様）。

リポジトリからバケットにコピーする際、`.gitattributes`ファイルはgit固有のメタデータでありバケットの文脈では関連がないため、自動的に除外されます。

リポジトリ間のコピーは内部で[CommitOperationCopy](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.CommitOperationCopy)を使用し、宛先リポジトリにコミットを作成します。バケットからリポジトリへのコピーはサポートされていません。

> [!WARNING]
> サーバーサイドのコピーは、同じ[ストレージリージョン](https://huggingface.co/docs/hub/storage-regions)内でのみ機能します。

例:
```python
>>> from huggingface_hub import copy_files

# Copy a single file between buckets
>>> copy_files("hf://buckets/my-bucket/data.bin", "hf://buckets/other-bucket/data.bin")

# Copy a folder into another bucket (nests: backup/models/...)
>>> copy_files("hf://buckets/my-bucket/models", "hf://buckets/other-bucket/backup/")

# Copy folder contents (trailing /): files go directly into backup/
>>> copy_files("hf://buckets/my-bucket/models/", "hf://buckets/other-bucket/backup/")

# Copy a file from a model repo to a bucket
>>> copy_files("hf://username/my-model/model.safetensors", "hf://buckets/my-bucket/")

# Copy an entire dataset to a bucket
>>> copy_files("hf://datasets/username/my-dataset/", "hf://buckets/my-bucket/datasets/")

# Copy files between repositories
>>> copy_files("hf://username/source-model/", "hf://username/dest-model/")

# Copy a file from one repo to another
>>> copy_files("hf://username/source-model/config.json", "hf://username/dest-model/config.json")
```

#### create_branch[[huggingface_hub.HfApi.create_branch]]

```python
create_branch(repo_id: str, branch: str, revision: str | None = None, token: bool | str | None = None, repo_type: str | None = None, exist_ok: bool = False)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6963)

**パラメータ:**

repo_id (`str`) : ブランチが作成されるリポジトリ。例: `"user/my-cool-model"`。

branch (`str`) : 作成するブランチの名前。

revision (`str`, *optional*) : ブランチを作成する元の git リビジョンです。ブランチ名、またはコミットの OID/SHA を16進数文字列として指定できます。デフォルトでは、`"main"` ブランチのヘッドです。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

repo_type (`str`, *任意*) : データセットまたはスペースのブランチを作成する場合は `"dataset"` または `"space"`、モデルにタグを付ける場合は `None` または `"model"` を設定します。デフォルトは `None` です。

exist_ok (`bool`、*任意*、デフォルトは`False`) : `True`の場合、ブランチが既に存在していてもエラーを発生させません。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [BadRequestError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.BadRequestError) または [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- リポジトリが見つからない場合（エラー 404）: repo_id/repo_type が誤っている、プライベートリポジトリだが認証されていない、またはリポジトリが存在しない。
- [BadRequestError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.BadRequestError) -- ブランチの参照が無効な場合。例: `refs/pr/5` または 'refs/foo/bar'。
- [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- リポジトリ上にブランチが既に存在する場合（エラー 409）かつ、`exist_ok` が `False` に設定されている場合。

Hub上のリポジトリで、指定されたリビジョン（デフォルトは`main`）を起点として新しいブランチを作成します。ニーズに合ったリビジョンを見つけるには、[list_repo_refs()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_repo_refs)または[list_repo_commits()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_repo_commits)を使用できます。

#### create_bucket[[huggingface_hub.HfApi.create_bucket]]

```python
create_bucket(bucket_id: str, private: bool | None = None, visibility: Literal['public', 'private'] | None = None, resource_group_id: str | None = None, region: REPO_REGIONS | None = None, exist_ok: bool = False, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13950)

**パラメータ:**

bucket_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とバケット名。名前空間が指定されていない場合、バケットは現在のユーザーの名前空間内に作成されます。

private (`bool`, *任意*) : バケットをプライベートにするかどうか。`None`（デフォルト）の場合、組織のデフォルトがプライベートでない限り、バケットはパブリックになります。`visibility` と同時に指定することはできません。

visibility (`Literal["public", "private"]`, *任意*) : バケットの可視性。`"public"`または`"private"`を指定できます。`None`（デフォルト）の場合、組織のデフォルトがプライベートでない限り、バケットはパブリックになります。

resource_group_id (`str`, *任意*) : バケットを作成するリソースグループ。リソースグループは Enterprise Hub 組織でのみ利用可能であり、組織のどのメンバーがリソースにアクセスできるかを定義できます。リソースグループの ID は、Hub 上のリソースページの URL から確認できます（例: `"66670e5163145ca562cb1988"`）。リソースグループの詳細については、https://huggingface.co/docs/hub/en/security-resource-groups を参照してください。

region (`Literal["us", "eu"]`, *任意*) : バケットを作成するクラウドリージョン。`"us"`または`"eu"`のいずれかです。指定しない場合、デフォルトのリージョンでバケットが作成されます。Teamプラン以上が必要です。

exist_ok (`bool`、*任意*、デフォルトは`False`) : `True`の場合、バケットが既に存在していてもエラーを発生させません。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [BucketUrl](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.BucketUrl)

`endpoint`、`namespace`、`bucket_id`などの属性を含む、新しく作成されたバケットのURL。

Hubにバケットを作成します。

例:
```python
>>> from huggingface_hub import create_bucket

>>> url = create_bucket(bucket_id="my-bucket")
>>> url.bucket_id
'user/my-bucket'
>>> url.url
'https://huggingface.co/buckets/user/my-bucket'
>>> url.uri.to_uri()
'hf://buckets/user/my-bucket'

>>> create_bucket(bucket_id="my-bucket", private=True, exist_ok=True)
BucketUrl(...)

>>> create_bucket(bucket_id="my-bucket", region="us")
BucketUrl(...)
```

#### create_collection[[huggingface_hub.HfApi.create_collection]]

```python
create_collection(title: str, namespace: str | None = None, description: str | None = None, private: bool = False, resource_group_id: str | None = None, exists_ok: bool = False, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10191)

**パラメータ:**

title (`str`) : 作成するコレクションのタイトル。例: `"Recent models"`。

namespace (`str`, *任意*) : 作成するコレクションのネームスペース（ユーザー名または組織名）。デフォルトではオーナー名になります。

description (`str`, *任意*) : 作成するコレクションの説明。説明の最大サイズは150文字です。

private (`bool`, *任意*) : コレクションを非公開にするかどうかを指定します。デフォルトは `False`（つまり、公開コレクション）です。

resource_group_id (`str`, *任意*) : コレクションを、所有する組織のリソースグループに割り当てます。組織が所有するコレクションでのみ有効です。リソースグループ ID は 24 文字の 16 進数文字列です。

exists_ok (`bool`, *任意*) : `True`の場合、コレクションが既に存在していてもエラーを発生させません。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

Hubで新しいCollectionを作成します。

戻り値: [Collection](/docs/huggingface_hub/v2.4.0/ja/package_reference/collections#huggingface_hub.Collection)

例:

```py
>>> from huggingface_hub import create_collection
>>> collection = create_collection(
...     title="ICCV 2023",
...     description="Portfolio of models, papers and demos I presented at ICCV 2023",
... )
>>> collection.slug
"username/iccv-2023-64f9a55bb3115b4f513ec026"
```

#### create_commit[[huggingface_hub.HfApi.create_commit]]

```python
create_commit(repo_id: str, operations: Iterable[CommitOperation], commit_message: str, commit_description: str | None = None, token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, create_pr: bool | None = None, num_threads: int = 5, parent_commit: str | None = None, run_as_future: bool = False, _hot_reload: bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L5016)

**パラメータ:**

repo_id (`str`) : コミットが作成されるリポジトリ。例: `"username/custom_transformers"`

operations (`Iterable` of `~hf_api.CommitOperation`) : コミットに含める操作のイテラブル。以下のいずれかです: - ファイルをアップロードするには `~hf_api.CommitOperationAdd` - ファイルを削除するには `~hf_api.CommitOperationDelete` - ファイルをコピーするには `~hf_api.CommitOperationCopy` 操作オブジェクトは、アップロードに関する情報を含むように変更されます。同じオブジェクトを複数のコミットに再利用しないでください。

commit_message (`str`) : 作成されるコミットのサマリー（最初の行）です。

commit_description (`str`, *任意*) : 作成されるコミットの説明

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

repo_type (`str`, *任意*) : データセット、スペース、またはカーネルのリポジトリにアップロードする場合は `"dataset"`、`"space"`、または `"kernel"` を設定し、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

revision (`str`, *任意*) : コミット元の git リビジョンです。`"main"` ブランチのヘッドがデフォルトです。

create_pr (`boolean`, *任意*) : そのコミットで Pull Request を作成するかどうか。デフォルトは `False` です。`revision` が設定されていない場合、PR は `"main"` ブランチに対して作成されます。`revision` が設定されておりブランチである場合、PR はそのブランチに対して作成されます。`revision` が設定されているがブランチ名でない場合（例: コミット OID）、サーバーから `RevisionNotFoundError` が返されます。

num_threads (`int`, *optional*) : ファイルのアップロードに使用する同時実行スレッド数。デフォルト値は5です。2に設定すると、同時にアップロードされるファイルは最大2つになります。

parent_commit (`str`, *任意*) : 親コミットの OID / SHA を16進数文字列として指定します。略記法（先頭7文字）もサポートされています。指定され、かつ `create_pr` が `False` の場合、`revision` が `parent_commit` を指していないとコミットは失敗します。指定され、かつ `create_pr` が `True` の場合、`parent_commit` からプルリクエストが作成されます。`parent_commit` を指定することで、変更をコミットする前にリポジトリが変更されていないことを保証でき、リポジトリが並行して更新 / コミットされる場合に特に有用です。

run_as_future (`bool`, *任意*) : このメソッドをバックグラウンドで実行するかどうか。バックグラウンドジョブは、メインスレッドをブロックせずにシーケンシャルに実行されます。`run_as_future=True` を渡すと、[Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects) オブジェクトが返されます。デフォルトは `False` です。

**戻り値:** [CommitInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.CommitInfo) または `Future`

新しく作成されたコミットに関する情報（コミットハッシュ、コミットURL、PR URL、コミットメッセージなど）を含む[CommitInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.CommitInfo)のインスタンスを返します。`run_as_future=True`が渡された場合、実行時に結果を含むFutureオブジェクトを返します。

**例外:** ``ValueError`` または [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)

- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- コミットメッセージが空の場合。
- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- 親コミットが有効なコミット OID ではない場合。
- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- 無効なメタデータセクションを含むREADME.mdファイルがコミットされた場合。この場合、ファイルのアップロードを試みる前に、コミットが早期に失敗します。
- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- `create_pr` が `True` であり、かつ revision が `None` でも `"main"` でもない場合。
- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- リポジトリが見つからない場合（エラー 404）: repo_id/repo_type が誤っている、プライベートリポジトリだが認証されていない、またはリポジトリが存在しない。

指定されたリポジトリにコミットを作成し、必要に応じてファイルを削除およびアップロードします。

> [!WARNING]
> `CommitOperation`の入力リストは、コミット処理中に変更されます。同じオブジェクトを複数のコミットに再利用しないでください。

> [!WARNING]
> `create_commit` は、リポジトリがすでに Hub に存在することを前提としています。Client エラー 404 が返された場合は、認証が有効であること、トークンに必要な権限が付与されていること、`repo_id` と `repo_type` が正しく設定されていることを確認してください。リポジトリが存在しない場合は、まず [create_repo()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_repo) を使用して作成してください。

> [!WARNING]
> `create_commit`は、LFSファイルが25,000件、通常ファイルのペイロードが1GBに制限されています。

#### create_discussion[[huggingface_hub.HfApi.create_discussion]]

```python
create_discussion(repo_id: str, title: str, token: bool | str | None = None, description: str | None = None, repo_type: str | None = None, pull_request: bool = False)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7440)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

title (`str`) : ディスカッションのタイトルです。最大200文字、最小3文字で、先頭と末尾の空白は除去されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

description (`str`, *任意*) : Pull Request の任意の説明です。デフォルト値は `"Discussion opened with the huggingface_hub Python library"` です。

pull_request (`bool`, *optional*) : Pull Requestまたはディスカッションを作成するかどうか。`True`の場合、Pull Requestを作成します。`False`の場合、ディスカッションを作成します。デフォルトは`False`です。

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

DiscussionまたはPull Requestを作成します。

プログラムによって作成されたPull Requestsは`"draft"`ステータスになります。

変更を含む Pull Request の作成は、[HfApi.create_commit()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_commit) を一度に実行することでも可能です。

戻り値: [DiscussionWithDetails](/docs/huggingface_hub/v2.4.0/ja/package_reference/community#huggingface_hub.DiscussionWithDetails)

> [!TIP]
> 以下のエラーを発生させます：
>
> - HuggingFace APIがエラーを返した場合に[`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) - パラメータの値が無効な場合に[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) - ダウンロード元のリポジトリが見つからない場合に[RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)。存在しないか、`private`に設定されていてアクセス権限がないためです。

#### create_inference_endpoint[[huggingface_hub.HfApi.create_inference_endpoint]]

```python
create_inference_endpoint(name: str, repository: str, framework: str, accelerator: str, instance_size: str, instance_type: str, region: str, vendor: str, account_id: str | None = None, private_link_account_id: str | None = None, private_link_region: str | None = None, min_replica: int = 1, max_replica: int = 1, scaling_metric: InferenceEndpointScalingMetric | None = None, scaling_threshold: float | None = None, scale_to_zero_timeout: int | None = None, revision: str | None = None, task: str | None = None, custom_image: dict | None = None, container_registry_username: str | None = None, container_registry_password: str | None = None, container_command: list[str] | None = None, container_args: list[str] | None = None, env: dict[str, str] | None = None, secrets: dict[str, str] | None = None, type: InferenceEndpointType | str = <InferenceEndpointType.AUTHENTICATED: 'authenticated'>, domain: str | None = None, path: str | None = None, cache_http_responses: bool | None = None, tags: list[str] | None = None, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9205)

**パラメータ:**

name (`str`) : 新しいInference Endpointの一意の名前。

repository (`str`) : Inference Endpointに関連付けられたモデルリポジトリの名前（例: `"gpt2"`）。

framework (`str`) : モデルに使用される機械学習フレームワーク（例: `"custom"`）。

accelerator (`str`) : 推論に使用されるハードウェアアクセラレータ（例: `"cpu"`）。

instance_size (`str`) : モデルをホストするために使用されるインスタンスのサイズまたはタイプ（例: `"x4"`）。

instance_type (`str`) : Inference Endpoint がデプロイされるクラウドインスタンスのタイプ（例: `"intel-icl"`）。

region (`str`) : Inference Endpoint が作成されるクラウドリージョン（例: `"us-east-1"`）。

vendor (`str`) : Inference Endpoint がホストされるクラウドプロバイダーまたはベンダー（例: `"aws"`）。

account_id (`str`, *省略可能*) : 非推奨であり、無視されます。AWS PrivateLink を設定するには、`private_link_account_id` と `private_link_region` を使用してください。

private_link_account_id (`str`, *任意*) : AWS PrivateLink 経由で Inference Endpoint にアクセスが許可される AWS アカウント ID。`private_link_region` が必要です。

private_link_region (`str`, *任意*) : PrivateLinkのエントリポイントのAWSリージョン(`"us-east-1"`または`"eu-west-1"`)。ここで`private_link_account_id`のVPCエンドポイントが接続されます。コンピュートの`region`および`vendor`とは独立しています。

min_replica (`int`, *任意*) : Inference Endpoint で稼働させ続けるレプリカ（インスタンス）の最小数。ゼロスケーリングを有効にするには、この値を 0 に設定し、`scale_to_zero_timeout` を適切に調整してください。デフォルト値は 1 です。

max_replica (`int`, *optional*) : Inference Endpointをスケーリングする際のレプリカ（インスタンス）の最大数。デフォルト値は1です。

scaling_metric (`str` または `InferenceEndpointScalingMetric `、*任意*) : スケーリング用のメトリック参照です。指定する場合、"pendingRequests" または "hardwareUsage" のいずれかです。デフォルトは None（HF Endpoints サービスがメトリックを指定することを意味します）。

scaling_threshold (`float`, *optional*) : スケールアップをトリガーするために使用されるスケーリングメトリクスの閾値です。スケーリングメトリクスが指定されていない場合は無視されます。デフォルトは None です（HF Endpoints サービスが閾値を指定することを意味します）。

scale_to_zero_timeout (`int`, *optional*) : 非アクティブなエンドポイントがゼロにスケーリングされるまでの分単位での時間。None に設定されている場合、かつ `min_replica` が 0 でない場合は、ゼロへのスケーリングは行われません。デフォルト値は None です。

revision (`str`, *任意*) : Inference Endpoint にデプロイする特定のモデルのリビジョン（例: `"6c0e6080953db56375760c0471a8c5f2929baf11"`）。

task (`str`, *任意*) : モデルをデプロイするタスク（例: `"text-classification"`）。

custom_image (`dict`, *任意*) : 実行するコンテナイメージです。イメージのバリアントをキーとする辞書（例: `{"vLLM": {"url": "vllm/vllm-openai:v0.23.0", "port": 8000}}`、`sGLang`、`tgi`、`tei`、`llamacpp`、`hfServe` など）で、そのまま転送されます。または、カスタムコンテナを記述するフラットな辞書（例: `{"url": ..., "port": ...}`）で、`{"custom": ...}` として送信されます（例を参照）。デフォルトでは、Hugging Face が管理するイメージが使用されます。

container_registry_username (`str`, *任意*) : カスタムコンテナイメージをホストするレジストリで認証に使用するユーザー名。

container_registry_password (`str`, *任意*) : カスタムコンテナイメージをホストするレジストリで認証に使用するパスワード。`container_registry_username`が必要です。指定されていない場合、APIペイロードから省略されます。

container_command (`list[str]`、*任意*) : コンテナのエントリポイントコマンドを上書きします（APIペイロードの`model.command`に対応します）。マネージドエンジンイメージ（vLLM、SGLang など）およびカスタムイメージの両方で動作します。

container_args (`list[str]`、*任意*) : コンテナのエントリポイントに追加される引数です（APIペイロードの `model.args` にマッピングされます）。マネージドエンジンイメージ（vLLM、SGLang など）およびカスタムイメージの両方で動作します。

env (`dict[str, str]`、*任意*) : コンテナ環境に注入する非シークレットの環境変数。

secrets (`dict[str, str]`、*任意*) : コンテナの環境に注入するシークレット値。

type ([`InferenceEndpointType]`, *任意*) : Inference Endpoint のタイプです。`"authenticated"`（デフォルト）、`"public"`、または `"private"` を指定できます。

domain (`str`, *任意*) : Inference Endpoint のデプロイメントに設定するカスタムドメインです。設定されている場合、推論エンドポイントはこのドメインで利用可能になります（例: `"my-new-domain.cool-website.woof"`）。

path (`str`, *任意*) : デプロイされたモデルのカスタムパスです。`/` で始まる必要があります（例: `"/models/google-bert/bert-base-uncased"`）。

cache_http_responses (`bool`, *任意*) : Inference EndpointからのHTTPレスポンスをキャッシュするかどうか。デフォルトは`False`です。

tags (`list[str]`、*任意*) : Inference Endpointに関連付けるタグのリスト。

namespace (`str`, *任意*) : Inference Endpoint が作成される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/ja/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint)

更新されたInference Endpointに関する情報。

新しいInference Endpointを作成します。

`accelerator`、`instance_size`、`instance_type`、`region`、`vendor` の値は相互に依存しています。有効な組み合わせを確認するには、[list_inference_endpoints_hardware()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_inference_endpoints_hardware) を使用してください。

例:
```python
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.create_inference_endpoint(
...     "my-endpoint-name",
...     repository="gpt2",
...     framework="pytorch",
...     task="text-generation",
...     accelerator="cpu",
...     vendor="aws",
...     region="us-east-1",
...     type="authenticated",
...     instance_size="x2",
...     instance_type="intel-icl",
... )
>>> endpoint
InferenceEndpoint(name='my-endpoint-name', status="pending",...)

# Run inference on the endpoint
>>> endpoint.client.text_generation(...)
"..."
```

```python
# Start an Inference Endpoint running Zephyr-7b-beta on TGI
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.create_inference_endpoint(
...     "aws-zephyr-7b-beta-0486",
...     repository="HuggingFaceH4/zephyr-7b-beta",
...     framework="pytorch",
...     task="text-generation",
...     accelerator="gpu",
...     vendor="aws",
...     region="us-east-1",
...     type="authenticated",
...     instance_size="x1",
...     instance_type="nvidia-a10g",
...     env={
...           "MAX_BATCH_PREFILL_TOKENS": "2048",
...           "MAX_INPUT_LENGTH": "1024",
...           "MAX_TOTAL_TOKENS": "1512",
...           "MODEL_ID": "/repository"
...         },
...     custom_image={
...         "healthRoute": "/health",
...         "url": "ghcr.io/huggingface/text-generation-inference:1.1.0",
...     },
...    secrets={"MY_SECRET_KEY": "secret_value"},
...    tags=["dev", "text-generation"],
... )
```

```python
# Start an Inference Endpoint running ProsusAI/finbert while scaling to zero in 15 minutes
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.create_inference_endpoint(
...     "finbert-classifier",
...     repository="ProsusAI/finbert",
...     framework="pytorch",
...     task="text-classification",
...     min_replica=0,
...     scale_to_zero_timeout=15,
...     accelerator="cpu",
...     vendor="aws",
...     region="us-east-1",
...     type="authenticated",
...     instance_size="x2",
...     instance_type="intel-icl",
... )
>>> endpoint.wait(timeout=300)
# Run inference on the endpoint
>>> endpoint.client.text_generation(...)
TextClassificationOutputElement(label='positive', score=0.8983615040779114)
```

#### create_inference_endpoint_from_catalog[[huggingface_hub.HfApi.create_inference_endpoint_from_catalog]]

```python
create_inference_endpoint_from_catalog(repo_id: str | None = None, recipe_id: str | None = None, name: str | None = None, accelerator: Literal['cpu', 'gpu', 'neuron'] | str | None = None, gguf_file: str | None = None, token: bool | str | None = None, namespace: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9502)

**パラメータ:**

repo_id (`str`, *任意*) : Inference Endpoint としてデプロイするカタログ内のモデルの ID。`recipe_id` とは排他的です。

recipe_id (`str`, *任意*) : デプロイするカタログレシピのIDです([InferenceCatalogRecipe](/docs/huggingface_hub/v2.4.0/ja/package_reference/inference_endpoints#huggingface_hub.InferenceCatalogRecipe)を参照)。`repo_id`とは排他です。

name (`str`, *任意*) : 新しい Inference Endpoint の一意の名前です。指定しない場合、ランダムな名前が生成されます。

accelerator (`str`, *任意*) : 推論に使用するハードウェアアクセラレーター。指定可能な値には `"cpu"`、`"gpu"`、`"neuron"` などが含まれます。指定しない場合、サーバーはモデルに適したデフォルトを使用します。`repo_id` と併用する場合のみ有効です。

gguf_file (`str`, *任意*) : 1つの量子化ごとに1つのレシピを持つモデル（例: `"Qwen2.5-Coder-32B-Instruct-Q4_K_M.gguf"`）をデプロイするためのGGUFファイル。`repo_id`との組み合わせでのみ有効です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。

namespace (`str`, *任意*) : Inference Endpoint が作成される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

**戻り値:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/ja/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint)

新しいInference Endpointに関する情報。

Hugging Face Inference Catalogから新しいInference Endpointを作成します。

Inference Catalogの目的は、推論用に最適化され、デフォルト設定がテスト済みのモデルの厳選リストを提供することです。カタログで利用可能なモデルのリストは、https://endpoints.huggingface.co/catalog をご覧ください。

各カタログモデルは、*レシピ*を通じてデプロイされます。レシピとは、そのモデル用にテスト済みのハードウェアとエンジンの組み合わせです。モデルのデフォルトレシピをデプロイするには`repo_id`を渡し、必要に応じて`accelerator`と`gguf_file`で絞り込みます。または、[list_inference_catalog()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_inference_catalog)で一覧表示される特定のレシピをデプロイするには`recipe_id`を渡します。

> [!WARNING]
> `create_inference_endpoint_from_catalog` は実験的な機能です。将来、API が変更される可能性があります。ご提案やご要望がございましたら、フィードバックをお寄せください。

#### create_pull_request[[huggingface_hub.HfApi.create_pull_request]]

```python
create_pull_request(repo_id: str, title: str, token: bool | str | None = None, description: str | None = None, repo_type: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7529)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

title (`str`) : ディスカッションのタイトルです。最大200文字、最小3文字で、先頭と末尾の空白は除去されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

description (`str`, *任意*) : Pull Request の任意の説明です。デフォルト値は `"Discussion opened with the huggingface_hub Python library"` です。

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

Pull Request を作成します。プログラムによって作成された Pull Request は`"draft"`ステータスになります。

変更を含む Pull Request の作成は、[HfApi.create_commit()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_commit) を一度に実行することでも可能です。

これは[HfApi.create_discussion()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_discussion)のラッパーです。

戻り値: [DiscussionWithDetails](/docs/huggingface_hub/v2.4.0/ja/package_reference/community#huggingface_hub.DiscussionWithDetails)

> [!TIP]
> 以下のエラーを発生させます：
>
> - HuggingFace APIがエラーを返した場合に[`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) - パラメータの値が無効な場合に[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) - ダウンロード元のリポジトリが見つからない場合に[RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)。存在しないか、`private`に設定されていてアクセス権限がないためです。

#### create_repo[[huggingface_hub.HfApi.create_repo]]

```python
create_repo(repo_id: str, token: str | bool | None = None, private: bool | None = None, visibility: RepoVisibility_T | None = None, repo_type: str | None = None, exist_ok: bool = False, resource_group_id: str | None = None, region: REPO_REGIONS | None = None, space_sdk: str | None = None, space_hardware: SpaceHardware | None = None, space_sleep_time: int | None = None, space_secrets: list[dict[str, str]] | None = None, space_variables: list[dict[str, str]] | None = None, space_volumes: list[Volume] | None = None, space_template: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4576)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

private (`bool`, *optional*) : リポジトリを非公開にするかどうか。`None`（デフォルト）の場合、組織のデフォルトが非公開でない限り、リポジトリは公開になります。リポジトリが既に存在する場合、この値は無視されます。`visibility` と同時に指定することはできません。

visibility (`Literal["public", "private", "protected"]`, *任意*) : リポジトリの公開設定。`"public"`または`"private"`、またはSpacesの場合は`"protected"`を指定できます。`None`（デフォルト）の場合、組織のデフォルトがprivateでない限り、リポジトリはpublicになります。リポジトリが既に存在する場合、この値は無視されます。

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

exist_ok (`bool`、*任意*、デフォルトは`False`) : `True`の場合、リポジトリが既に存在していてもエラーを発生させません。

resource_group_id (`str`, *任意*) : リポジトリを作成するリソースグループ。リソースグループは Enterprise Hub 組織でのみ利用可能であり、組織のどのメンバーがリソースにアクセスできるかを定義できます。リソースグループの ID は、Hub 上のリソースのページの URL から確認できます（例: `"66670e5163145ca562cb1988"`）。リソースグループの詳細については、https://huggingface.co/docs/hub/en/security-resource-groups を参照してください。

region (`Literal["us", "eu"]`, *任意*) : リポジトリを作成するクラウドリージョン。`"us"`または`"eu"`のいずれかです。指定しない場合、リポジトリはデフォルトのリージョンに作成されます。Teamプラン以上が必要です。

space_sdk (`str`, *任意*) : repo_type が "space" の場合に使用する SDK の選択です。"streamlit"、"gradio"、"docker"、"static" のいずれかです。`"static"` Spaces はすべてのユーザーに無料です。その他の SDK は計算リソース上で実行されます。無料の `cpu-basic` ハードウェアでは、サブスクリプション（ユーザーは PRO、組織は Team または Enterprise）が必要です。一方、有料ハードウェアでは請求（支払い方法と事前購入クレジット）のみが必要です。

space_hardware (`SpaceHardware` または `str`、*省略可*) : repo_type が "space" の場合の Hardware の選択です。完全なリストについては [SpaceHardware](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceHardware) を参照してください。

space_sleep_time (`int`, *optional*) : Space がスリープ状態に入るまで、待機状態を何秒間待つかを指定します。Space がスリープしない場合は `-1` を設定してください（アップグレードされたハードウェアのデフォルト動作です）。無料のハードウェアでは、スリープ時間を設定できません（値は 48 時間の待機に固定されています）。詳細は https://huggingface.co/docs/hub/spaces-gpus#sleep-time を参照してください。

space_secrets (`list[dict[str, str]]`, *任意*) : Space に設定するシークレットキーのリストです。各項目は `{"key": ..., "value": ..., "description": ...}` の形式で、description は任意です。詳細については、https://huggingface.co/docs/hub/spaces-overview#managing-secrets を参照してください。

space_variables (`list[dict[str, str]]`、*任意*) : Space で設定する公開環境変数のリストです。各項目は `{"key": ..., "value": ..., "description": ...}` の形式で、description は任意です。詳細については、https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables を参照してください。

space_volumes (`list[Volume]`, *任意*) : Space の作成時にマウントする [Volume](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.Volume) オブジェクトのリストです。各ボリュームには、`type`（`"bucket"`、`"model"`、`"dataset"`、または `"space"`）、`source`（リポジトリまたはバケットの ID）、`mount_path`（コンテナ内のパス）、および任意の `revision`、`read_only`、`path` フィールドがあります。repo_type が "space" の場合のみ適用されます。

space_template (`str`, *任意*) : 公式テンプレートから新しい Space を作成します。テンプレートのリポジトリ ID（例: `"SpacesExamples/jupyterlab"`）またはその短縮名（例: `"JupyterLab"`）のいずれかを指定できます。利用可能なテンプレートのリストを取得するには [HfApi.list_space_templates()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_space_templates) を使用します。repo_type が "space" の場合のみ適用されます。テンプレートがプライベートでの利用を推奨されており、visibility が明示的に設定されていない場合、Space はプライベートとして作成されます。

**戻り値:** [RepoUrl](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.RepoUrl)

新しく作成されたリポジトリのURL。値は`str`のサブクラスで、`endpoint`、`repo_type`、`repo_id`などの属性を含みます。

HuggingFace Hub に空のリポジトリを作成します。

#### create_scheduled_job[[huggingface_hub.HfApi.create_scheduled_job]]

```python
create_scheduled_job(image: str, command: list[str], schedule: str, suspend: bool | None = None, concurrency: bool | None = None, env: dict[str, Any] | None = None, secrets: dict[str, Any] | None = None, flavor: JobHardware | str | None = None, timeout: int | float | str | None = None, attempts: int | None = None, name: str | None = None, labels: dict[str, str] | None = None, volumes: list[Volume] | None = None, expose: list[int] | None = None, expose_public: list[int] | None = None, resource_group_id: str | None = None, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13072)

**パラメータ:**

image (`str`) : 使用する Docker イメージです。例: `"ubuntu"`、`"python:3.12"`、`"pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"`。Space からのイメージの例: `"hf.co/spaces/lhoestq/duckdb"`。

command (`list[str]`) : 実行するコマンド。例: `["echo", "hello"]`。

schedule (`str`) : "@annually"、"@yearly"、"@monthly"、"@weekly"、"@daily"、"@hourly" のいずれか、または CRON スケジュール式（例: 毎週月曜日の午前9時を指定する '0 9 * * 1'）。

suspend (`bool`, *任意*) : True の場合、スケジュールされた Job が停止（一時停止）されます。デフォルトは False です。

concurrency (`bool`, *任意*) : True の場合、この Job の複数のインスタンスが並行して実行できます。デフォルトは False です。

env (`dict[str, Any]`、*任意*) : Job の環境変数を定義します。

secrets (`dict[str, Any]`、*任意*) : Jobのシークレット環境変数を定義します。

flavor (`str`, *任意*) : ハードウェアの Flavor です。使用可能な値については `JobHardware` を参照してください。デフォルト値は `"cpu-basic"` です。

timeout (`Union[int, float, str]`、*任意*) : ジョブの最大実行時間: int で s (秒、デフォルト)、m (分)、h (時間)、d (日) を指定します。例: `300` または 5 分を指定する場合は `"5m"`。

attempts (`int`, *optional*) : 各実行の最大試行回数（最初の試行を含む）。デフォルト値は1です。

name (`str`, *任意*) : スケジュールされた Job の名前。`name` ラベルとして保存されます。`labels` に `name` キーを同時に渡すことはできません。名前の一意性は必須ではありません。デフォルトでは、イメージとコマンドから派生した名前（短いハッシュサフィックス付き）が使用されます。

labels (`dict[str, str]`, *省略可*) : ジョブに付与するラベル（キーと値のペア）。

volumes (`list[Volume]`、*任意*) : ジョブコンテナにボリュームとしてマウントする Hugging Face Buckets または Repos。各ボリュームは [Volume](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.Volume) で、`type`（`"bucket"`、`"model"`、`"dataset"`、または `"space"`）、`source`（例: `"username/my-bucket"`）、および `mount_path`（例: `"/data"`）を持ちます。

expose (`list[int]`, *optional*) : ジョブのプロキシ経由で公開するコンテナポート。リストに指定された各ポートは、パブリックなジョブドメイン（例: `https://<job_id>--8000.hf.jobs`）からアクセスできます。アクセスには常に、そのジョブのネームスペースへの読み取りアクセス権限を持つ HF トークンが必要です。認証なしでのアクセスには `expose_public` を使用してください。

expose_public (`list[int]`, *optional*) : 認証なしで Jobs プロキシ経由で公開するポート。これらは `expose` に列挙する必要はありません。

resource_group_id (`str`, *任意*) : スケジュールされた Job を作成するリソースグループの ID です。組織内のリソースへのアクセス制御や、コストの帰属・支出上限機能に使用されます。指定しない場合、スケジュールされた Job はリソースグループの外に作成されます。

namespace (`str`, *任意*) : Job が作成される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

Hugging Face のインフラストラクチャ上で、スケジュールされた compute Jobs を作成します。

例:

最初のスケジュールされたJobを作成します:

```python
>>> from huggingface_hub import create_scheduled_job
>>> create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], schedule="@hourly")
```

CRONスケジュール式を使用します:

```python
>>> from huggingface_hub import create_scheduled_job
>>> create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('this runs every 5min')"], schedule="*/5 * * * *")
```

スケジュールされたGPUジョブを作成します:

```python
>>> from huggingface_hub import create_scheduled_job
>>> image = "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"
>>> command = ["python", "-c", "import torch; print(f'This code ran with the following GPU: {torch.cuda.get_device_name()}')"]
>>> create_scheduled_job(image=image, command=command, flavor="a10g-small", schedule="@hourly")
```

#### create_scheduled_uv_job[[huggingface_hub.HfApi.create_scheduled_uv_job]]

```python
create_scheduled_uv_job(script: str, script_args: list[str] | None = None, schedule: str, suspend: bool | None = None, concurrency: bool | None = None, dependencies: list[str] | None = None, python: str | None = None, image: str | None = None, env: dict[str, Any] | None = None, secrets: dict[str, Any] | None = None, flavor: JobHardware | str | None = None, timeout: int | float | str | None = None, attempts: int | None = None, name: str | None = None, labels: dict[str, str] | None = None, volumes: list[Volume] | None = None, expose: list[int] | None = None, expose_public: list[int] | None = None, resource_group_id: str | None = None, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13551)

**パラメータ:**

script (`str`) : UVスクリプトのパスまたはURL、またはコマンド。

script_args (`list[str]`、*任意*) : スクリプトまたはコマンドに渡す引数。

schedule (`str`) : "@annually"、"@yearly"、"@monthly"、"@weekly"、"@daily"、"@hourly" のいずれか、または CRON スケジュール式（例: 毎週月曜日の午前9時を指定する '0 9 * * 1'）。

suspend (`bool`, *任意*) : True の場合、スケジュールされた Job が停止（一時停止）されます。デフォルトは False です。

concurrency (`bool`, *任意*) : True の場合、この Job の複数のインスタンスが並行して実行できます。デフォルトは False です。

dependencies (`list[str]`, *任意*) : UVスクリプトの実行に使用する依存関係。

python (`str`, *任意*) : 特定のPythonバージョンを使用します。デフォルトは3.12です。

image (`str`、*任意*、デフォルト値は "ghcr.io/astral-sh/uv --python3.12-bookworm"): `uv` がインストールされたカスタム Docker イメージを使用します。

env (`dict[str, Any]`、*任意*) : Job の環境変数を定義します。

secrets (`dict[str, Any]`、*任意*) : Jobのシークレット環境変数を定義します。

flavor (`str`, *任意*) : ハードウェアの Flavor です。使用可能な値については `JobHardware` を参照してください。デフォルト値は `"cpu-basic"` です。

timeout (`Union[int, float, str]`、*任意*) : ジョブの最大実行時間: int で s (秒、デフォルト)、m (分)、h (時間)、d (日) を指定します。例: `300` または 5 分を指定する場合は `"5m"`。

attempts (`int`, *optional*) : 各実行の最大試行回数（最初の試行を含む）。デフォルト値は1です。

name (`str`, *任意*) : スケジュールされた Job の名前。`name` ラベルとして保存されます。`labels` に `name` キーを同時に渡すことはできません。名前の一意性は必須ではありません。デフォルトでは、スクリプトとその引数から派生した名前（短いハッシュサフィックス付き）が使用されます。

labels (`dict[str, str]`, *省略可*) : ジョブに付与するラベル（キーと値のペア）。

volumes (`list[Volume]`、*任意*) : ジョブコンテナにボリュームとしてマウントする Hugging Face Buckets または Repos。各ボリュームは [Volume](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.Volume) で、`type`（`"bucket"`、`"model"`、`"dataset"`、または `"space"`）、`source`（例: `"username/my-bucket"`）、および `mount_path`（例: `"/data"`）を持ちます。

expose (`list[int]`, *optional*) : ジョブのプロキシ経由で公開するコンテナポート。リストに指定された各ポートは、パブリックなジョブドメイン（例: `https://<job_id>--8000.hf.jobs`）からアクセスできます。アクセスには常に、そのジョブのネームスペースへの読み取りアクセス権限を持つ HF トークンが必要です。認証なしでのアクセスには `expose_public` を使用してください。

expose_public (`list[int]`, *optional*) : 認証なしで Jobs プロキシ経由で公開するポート。これらは `expose` に列挙する必要はありません。

resource_group_id (`str`, *任意*) : スケジュールされた Job を作成するリソースグループの ID です。組織内のリソースへのアクセス制御や、コストの帰属・支出上限機能に使用されます。指定しない場合、スケジュールされた Job はリソースグループの外に作成されます。

namespace (`str`, *任意*) : Job が作成される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

Hugging Faceのインフラストラクチャ上でUVスクリプトジョブを実行します。

> [!WARNING]
> `hf jobs uv run` とは異なり、このメソッドでは、UV スクリプトの PEP 723 ヘッダーに含めることのできる任意の `[tool.hf-jobs]` テーブル（[Jobs ガイド](../guides/jobs#ship-the-launch-config-with-the-script)を参照）は無視されます。ここでは、起動設定を明示的に渡す必要があります。

例:

URLからスクリプトをスケジュールする:

```python
>>> from huggingface_hub import create_scheduled_uv_job
>>> script = "https://raw.githubusercontent.com/huggingface/trl/refs/heads/main/trl/scripts/sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small", schedule="@weekly")
```

ローカルスクリプトをスケジュールする:

```python
>>> from huggingface_hub import create_scheduled_uv_job
>>> script = "my_sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small", schedule="@weekly")
```

コマンドをスケジュールします:

```python
>>> from huggingface_hub import create_scheduled_uv_job
>>> script = "lighteval"
>>> script_args= ["endpoint", "inference-providers", "model_name=openai/gpt-oss-20b,provider=auto", "lighteval|gsm8k|0|0"]
>>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["lighteval"], flavor="a10g-small", schedule="@weekly")
```

#### create_tag[[huggingface_hub.HfApi.create_tag]]

```python
create_tag(repo_id: str, tag: str, tag_message: str | None = None, revision: str | None = None, token: bool | str | None = None, repo_type: str | None = None, exist_ok: bool = False)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7095)

**パラメータ:**

repo_id (`str`) : コミットにタグを付けるリポジトリ。例: `"user/my-cool-model"`。

tag (`str`) : 作成するタグの名前。

tag_message (`str`, *任意*) : 作成するタグの説明。

revision (`str`, *optional*) : タグ付けする git リビジョンです。ブランチ名、またはコミットの OID/SHA を16進数文字列として指定できます。略記法（先頭7文字）もサポートされています。デフォルトでは、`"main"` ブランチのヘッドになります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

repo_type (`str`, *任意*) : データセットまたはスペースにタグを付ける場合は `"dataset"` または `"space"`、モデルにタグを付ける場合は `None` または `"model"` を設定します。デフォルトは `None` です。

exist_ok (`bool`、*任意*、デフォルトは`False`) : `True`の場合、タグが既に存在していてもエラーを発生させません。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) または [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- リポジトリが見つからない場合（エラー 404）: repo_id/repo_type が誤っている、プライベートリポジトリだが認証されていない、またはリポジトリが存在しない。
- [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- リポジトリ上でリビジョンが見つからない場合（エラー 404）。
- [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- リポジトリ上にブランチが既に存在する場合（エラー 409）かつ、`exist_ok` が `False` に設定されている場合。

Hub上のリポジトリの特定のコミットにタグを付けます。

#### create_webhook[[huggingface_hub.HfApi.create_webhook]]

```python
create_webhook(url: str | None = None, job_id: str | None = None, watched: list[dict | WebhookWatchedItem], domains: list[constants.WEBHOOK_DOMAIN_T] | None = None, secret: str | None = None, secrets: dict[str, str] | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11176)

**パラメータ:**

url (`str`) : ペイロードを送信するURL。

job_id (`str`) : 環境変数 WEBHOOK_PAYLOAD 内の Webhook ペイロードでトリガーするソース Job の ID。利便性のため、追加の環境変数 WEBHOOK_REPO_ID、WEBHOOK_REPO_TYPE、WEBHOOK_SECRET が利用可能です。

watched (`list[WebhookWatchedItem]`) : Webhook が監視する [WebhookWatchedItem](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.WebhookWatchedItem) のリストです。ユーザー、組織、モデル、データセット、スペース、バケットなどが対象となります。監視対象はプレーンな辞書として指定することもできます。

domains (`list[Literal["repo", "discussion"]]`, optional) : 監視するドメインのリストです。"repo"、"discussion"、またはその両方を指定できます。デフォルトでは両方を監視します。

secret (`str`, 任意) : ペイロードに署名するためのシークレット。

secrets (`dict[str, str]`, optional) : WebhookによってトリガーされるJob用のシークレット環境変数（例: `{"HF_TOKEN": "hf_***"}`）。`job_id`との組み合わせでのみ有効です。ソースJobのシークレットはWebhookにコピーされないため、ここで渡してください。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [WebhookInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.WebhookInfo)

新しく作成されたWebhookに関する情報。

新しいWebhookを作成します。

Webhookは、URLにペイロードを送信するか、Hugging Faceのインフラストラクチャ上でJobを実行するかのいずれかです。この関数は、`url`または`job_id`のいずれか1つを引数として呼び出す必要がありますが、両方を指定することはできません。

例:

URLにペイロードを送信するWebhookを作成します

```python
>>> from huggingface_hub import create_webhook
>>> payload = create_webhook(
...     watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}],
...     url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
...     domains=["repo", "discussion"],
...     secret="my-secret",
... )
>>> print(payload)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    job=None,
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=False,
)
```

Job を実行し、その後、この Job をトリガーする Webhook を作成します

```python
>>> from huggingface_hub import create_webhook, run_job
>>> job = run_job(
...     image="ubuntu",
...     command=["bash", "-c", r"echo An event occurred in $WEBHOOK_REPO_ID: $WEBHOOK_PAYLOAD"],
... )
>>> payload = create_webhook(
...     watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}],
...     job_id=job.id,
...     domains=["repo", "discussion"],
...     secret="my-secret",
... )
>>> print(payload)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    url=None,
    job=JobSpec(
        docker_image='ubuntu',
        space_id=None,
        command=['bash', '-c', 'echo An event occurred in $WEBHOOK_REPO_ID: $WEBHOOK_PAYLOAD'],
        arguments=[],
        environment={},
        secrets=[],
        flavor='cpu-basic',
        timeout=None,
        tags=None,
        arch=None
    ),
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=False,
)
```

#### dataset_info[[huggingface_hub.HfApi.dataset_info]]

```python
dataset_info(repo_id: str, revision: str | None = None, timeout: float | None = None, files_metadata: bool = False, expand: list[ExpandDatasetProperty_T] | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3219)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

revision (`str`, *任意*) : 情報取得元のデータセットリポジトリのリビジョン。

timeout (`float`, *任意*) : Hub へのリクエストにタイムアウトを設定するかどうか。

files_metadata (`bool`, *任意*) : リポジトリ内のファイルのメタデータ（サイズ、LFSメタデータなど）を取得するかどうか。デフォルトは`False`です。

expand (`list[ExpandDatasetProperty_T]`, *optional*) : レスポンスで返すプロパティのリストです。指定した場合、リストに含まれるプロパティのみが返されます。`files_metadata` が渡されている場合は、このパラメーターを使用できません。指定可能な値は `"author"`、`"cardData"`、`"citation"`、`"createdAt"`、`"disabled"`、`"description"`、`"downloads"`、`"downloadsAllTime"`、`"gated"`、`"lastModified"`、`"likes"`、`"mainSize"`、`"paperswithcode_id"`、`"private"`、`"siblings"`、`"sha"`、`"tags"`、`"trendingScore"`、`"usedStorage"`、および `"resourceGroup"` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [hf_api.DatasetInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.DatasetInfo)

データセットリポジトリの情報。

huggingface.co上の特定の1つのデータセットに関する情報を取得します。

Datasetは、許可されたトークンを渡すことでプライベートに設定できます。

> [!TIP]
> 以下のエラーを発生させます：
>
> - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) ダウンロード元のリポジトリが見つからない場合。存在しないか、`private`に設定されておりアクセス権限がない可能性があります。 - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) ダウンロード元のリビジョンが見つからない場合。

#### delete_branch[[huggingface_hub.HfApi.delete_branch]]

```python
delete_branch(repo_id: str, branch: str, token: bool | str | None = None, repo_type: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7043)

**パラメータ:**

repo_id (`str`) : ブランチが削除されるリポジトリ。例: `"user/my-cool-model"`。

branch (`str`) : 削除するブランチの名前。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

repo_type (`str`, *任意*) : データセットまたはスペースのブランチを作成する場合は `"dataset"` または `"space"`、モデルにタグを付ける場合は `None` または `"model"` を設定します。デフォルトは `None` です。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- リポジトリが見つからない場合（エラー 404）: repo_id/repo_type が誤っている、プライベートリポジトリだが認証されていない、またはリポジトリが存在しない。
- [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- 保護されたブランチの削除を試みた場合。例: `main` は削除できません。
- [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- 存在しないブランチの削除を試みた場合。

Hub上のリポジトリからブランチを削除します。

#### delete_bucket[[huggingface_hub.HfApi.delete_bucket]]

```python
delete_bucket(bucket_id: str, missing_ok: bool = False, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14157)

**パラメータ:**

bucket_id (`str`) : バケットのID（例: `"username/my-bucket"`）。

missing_ok (`bool`、*任意*、デフォルトは`False`) : `True`の場合、バケットが存在しない場合にエラーを発生させません。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**例外:** `BucketNotFoundError`

- `BucketNotFoundError` -- バケットが見つからず、`missing_ok`が`False`（デフォルト）に設定されている場合。

Hubからバケットを削除します。

例:
```python
>>> from huggingface_hub import delete_bucket
>>> delete_bucket(bucket_id="Wauplin/first-bucket")
>>> delete_bucket(bucket_id="Wauplin/first-bucket", missing_ok=True)
```

#### delete_collection[[huggingface_hub.HfApi.delete_collection]]

```python
delete_collection(collection_slug: str, missing_ok: bool = False, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10373)

**パラメータ:**

collection_slug (`str`) : 削除するコレクションのスラッグ。例: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`。

missing_ok (`bool`, *任意*) : `True`の場合、コレクションが存在しない場合にエラーを発生させません。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

Hub上のコレクションを削除します。

例:

```py
>>> from huggingface_hub import delete_collection
>>> collection = delete_collection("username/useless-collection-64f9a55bb3115b4f513ec026", missing_ok=True)
```

> [!WARNING]
> これは元に戻せない操作です。削除されたコレクションは復元できません。

#### delete_collection_item[[huggingface_hub.HfApi.delete_collection_item]]

```python
delete_collection_item(collection_slug: str, item_object_id: str, missing_ok: bool = False, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10548)

**パラメータ:**

collection_slug (`str`) : 更新するコレクションのスラッグ。例: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`。

item_object_id (`str`) : コレクション内のアイテムのIDです。これはHub上のアイテムのID（repo_idまたはpaper id）ではありません。[CollectionItem](/docs/huggingface_hub/v2.4.0/ja/package_reference/collections#huggingface_hub.CollectionItem)オブジェクトから取得する必要があります。例: `collection.items[0].item_object_id`。

missing_ok (`bool`, *任意*) : `True`の場合、アイテムが存在しない場合にエラーを発生させません。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

コレクションからアイテムを削除します。

例:

```py
>>> from huggingface_hub import get_collection, delete_collection_item

# Get collection first
>>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")

# Delete item based on its ID
>>> delete_collection_item(
...     collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026",
...     item_object_id=collection.items[-1].item_object_id,
... )
```

#### delete_file[[huggingface_hub.HfApi.delete_file]]

```python
delete_file(path_in_repo: str, repo_id: str, token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, commit_message: str | None = None, commit_description: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6045)

**パラメータ:**

path_in_repo (`str`) : リポジトリ内の相対ファイルパス。例: `"checkpoints/1fec34a/weights.bin"`

repo_id (`str`) : ファイルが削除されるリポジトリ。例: `"username/custom_transformers"`

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

repo_type (`str`, *任意*) : ファイルがデータセットまたはスペースにある場合は `"dataset"` または `"space"`、モデルにある場合は `None` または `"model"` を設定します。デフォルトは `None` です。

revision (`str`, *任意*) : コミット元の git リビジョンです。`"main"` ブランチのヘッドがデフォルトです。

commit_message (`str`, *任意*) : 生成されるコミットのサマリー / タイトル / 最初の行です。デフォルトは `f"Delete {path_in_repo} with huggingface_hub"` です。

commit_description (`str`, *任意*) : 生成されたコミットの説明

create_pr (`boolean`, *任意*) : そのコミットで Pull Request を作成するかどうか。デフォルトは `False` です。`revision` が設定されていない場合、PR は `"main"` ブランチに対して作成されます。`revision` が設定されておりブランチである場合、PR はそのブランチに対して作成されます。`revision` が設定されているがブランチ名でない場合（例: コミット OID）、サーバーから `RevisionNotFoundError` が返されます。

parent_commit (`str`, *任意*) : 親コミットの OID / SHA を16進数文字列として指定します。略記法（先頭7文字）もサポートされています。指定され、かつ `create_pr` が `False` の場合、`revision` が `parent_commit` を指していないとコミットは失敗します。指定され、かつ `create_pr` が `True` の場合、`parent_commit` からプルリクエストが作成されます。`parent_commit` を指定することで、変更をコミットする前にリポジトリが変更されていないことを保証でき、リポジトリが並行して更新 / コミットされる場合に特に有用です。

指定されたリポジトリ内のファイルを削除します。

> [!TIP]
> 以下のエラーを発生させます：
>
> - HuggingFace APIがエラーを返した場合、[`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) - 一部のパラメータ値が無効な場合、[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) - ダウンロード元のリポジトリが見つからない場合、[RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)。存在しないか、`private`に設定されておりアクセス権限がない可能性があります。 - ダウンロード元のリビジョンが見つからない場合、[RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) - ダウンロードするファイルが見つからない場合、[EntryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.EntryNotFoundError)

#### delete_files[[huggingface_hub.HfApi.delete_files]]

```python
delete_files(repo_id: str, delete_patterns: list[str], token: bool | str | None = None, repo_type: str | None = None, revision: str | None = None, commit_message: str | None = None, commit_description: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6135)

**パラメータ:**

repo_id (`str`) : フォルダーが削除されるリポジトリ。例: `"username/custom_transformers"`

delete_patterns (`list[str]`) : 削除するファイルまたはフォルダーのリスト。各文字列は、ファイルパス、フォルダーパス、またはワイルドカードパターンであることができます。パターンは、[こちら](https://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm)にドキュメント化されている標準ワイルドカード（globbing パターン）です。パターンマッチングは [`fnmatch`](https://docs.python.org/3/library/fnmatch.html) に基づいています。なお、`fnmatch` は従来の Unix シェルの globbing と異なり、`*` がパス境界をまたいでマッチします。例: `["file.txt", "folder/", "data/*.parquet"]`

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）です。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を保存されたトークンに渡します。

repo_type (`str`, *任意*) : ファイルを削除するリポジトリの種類。`"model"`、`"dataset"`、または`"space"`を指定できます。デフォルトは`"model"`です。

revision (`str`, *任意*) : コミット元の git リビジョンです。`"main"` ブランチのヘッドがデフォルトです。

commit_message (`str`, *任意*) : 生成されるコミットのサマリー（最初の行）です。デフォルトは`f"Delete files using huggingface_hub"`です。

commit_description (`str`, *任意*) : 生成されるコミットの説明です。

create_pr (`boolean`, *任意*) : そのコミットで Pull Request を作成するかどうか。デフォルトは `False` です。`revision` が設定されていない場合、PR は `"main"` ブランチに対して作成されます。`revision` が設定されておりブランチである場合、PR はそのブランチに対して作成されます。`revision` が設定されているがブランチ名でない場合（例: コミット OID）、サーバーから `RevisionNotFoundError` が返されます。

parent_commit (`str`, *任意*) : 親コミットの OID / SHA を16進数文字列として指定します。略記法（先頭7文字）もサポートされています。指定され、かつ `create_pr` が `False` の場合、`revision` が `parent_commit` を指していないとコミットは失敗します。指定され、かつ `create_pr` が `True` の場合、`parent_commit` からプルリクエストが作成されます。`parent_commit` を指定することで、変更をコミットする前にリポジトリが変更されていないことを保証でき、リポジトリが並行して更新 / コミットされる場合に特に有用です。

Hub上のリポジトリからファイルを削除します。

フォルダパスが指定された場合、そのフォルダ自体と、その中に含まれていたすべてのファイルが削除されます。

#### delete_folder[[huggingface_hub.HfApi.delete_folder]]

```python
delete_folder(path_in_repo: str, repo_id: str, token: bool | str | None = None, repo_type: str | None = None, revision: str | None = None, commit_message: str | None = None, commit_description: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6214)

**パラメータ:**

path_in_repo (`str`) : リポジトリ内の相対フォルダパス。例: `"checkpoints/1fec34a"`

repo_id (`str`) : フォルダーが削除されるリポジトリ。例: `"username/custom_transformers"`

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）です。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を保存されたトークンに渡します。

repo_type (`str`, *任意*) : フォルダーがデータセットまたはスペースにある場合は `"dataset"` または `"space"`、モデルにある場合は `None` または `"model"` を設定します。デフォルトは `None` です。

revision (`str`, *任意*) : コミット元の git リビジョンです。`"main"` ブランチのヘッドがデフォルトです。

commit_message (`str`, *任意*) : 生成されるコミットのサマリー / タイトル / 最初の行です。デフォルトは `f"Delete folder {path_in_repo} with huggingface_hub"` です。

commit_description (`str`, *任意*) : 生成されるコミットの説明です。

create_pr (`boolean`, *任意*) : そのコミットで Pull Request を作成するかどうか。デフォルトは `False` です。`revision` が設定されていない場合、PR は `"main"` ブランチに対して作成されます。`revision` が設定されておりブランチである場合、PR はそのブランチに対して作成されます。`revision` が設定されているがブランチ名でない場合（例: コミット OID）、サーバーから `RevisionNotFoundError` が返されます。

parent_commit (`str`, *任意*) : 親コミットの OID / SHA を16進数文字列として指定します。略記法（先頭7文字）もサポートされています。指定され、かつ `create_pr` が `False` の場合、`revision` が `parent_commit` を指していないとコミットは失敗します。指定され、かつ `create_pr` が `True` の場合、`parent_commit` からプルリクエストが作成されます。`parent_commit` を指定することで、変更をコミットする前にリポジトリが変更されていないことを保証でき、リポジトリが並行して更新 / コミットされる場合に特に有用です。

指定されたリポジトリ内のフォルダーを削除します。

[create_commit()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_commit) メソッドのシンプルなラッパーです。

#### delete_inference_endpoint[[huggingface_hub.HfApi.delete_inference_endpoint]]

```python
delete_inference_endpoint(name: str, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9894)

**パラメータ:**

name (`str`) : 削除する Inference Endpoint の名前。

namespace (`str`, *任意*) : Inference Endpoint が配置されている名前空間です。デフォルトでは、現在のユーザーになります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

Inference Endpointを削除します。

この操作は元に戻せません。Inference Endpoint の課金を避けたい場合は、[pause_inference_endpoint()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.pause_inference_endpoint) で一時停止するか、[scale_to_zero_inference_endpoint()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.scale_to_zero_inference_endpoint) でスケールをゼロにすることをお勧めします。

便宜のため、[InferenceEndpoint.delete()](/docs/huggingface_hub/v2.4.0/ja/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint.delete) を使用して Inference Endpoint を削除することもできます。

#### delete_repo[[huggingface_hub.HfApi.delete_repo]]

```python
delete_repo(repo_id: str, token: str | bool | None = None, repo_type: str | None = None, missing_ok: bool = False)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4788)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。

missing_ok (`bool`、*任意*、デフォルトは`False`) : `True`の場合、リポジトリが存在しない場合にエラーを発生させません。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- 削除対象のリポジトリが見つからず、`missing_ok`がFalse（デフォルト）に設定されている場合。

HuggingFace Hubからリポジトリを削除します。注意: この操作は元に戻せません。

#### delete_scheduled_job[[huggingface_hub.HfApi.delete_scheduled_job]]

```python
delete_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13324)

**パラメータ:**

scheduled_job_id (`str`) : スケジュールされたJobのID。

namespace (`str`, *任意*) : スケジュールされた Job が存在する名前空間です。デフォルトでは、現在のユーザーの名前空間になります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

Hugging Face のインフラストラクチャ上でスケジュールされた compute Job を削除します。

#### delete_space_secret[[huggingface_hub.HfApi.delete_space_secret]]

```python
delete_space_secret(repo_id: str, key: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8083)

**パラメータ:**

repo_id (`str`) : 更新するリポジトリの ID。例: `"bigcode/in-the-stack"`。

key (`str`) : シークレットキー。例: `"GITHUB_API_KEY"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

Spaceからシークレットを削除します。

Secretsを使用すると、Spaceにシークレットキーやトークンを設定できますが、ハードコードする必要はありません。詳細については、https://huggingface.co/docs/hub/spaces-overview#managing-secretsを参照してください。

#### delete_space_variable[[huggingface_hub.HfApi.delete_space_variable]]

```python
delete_space_variable(repo_id: str, key: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8210)

**パラメータ:**

repo_id (`str`) : 更新するリポジトリの ID。例: `"bigcode/in-the-stack"`。

key (`str`) : 変数のキー。例: `"MODEL_REPO_ID"`

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

Spaceから変数を削除します。

変数を使用すると、Space にハードコードせずに環境変数を設定できます。詳細については、https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables を参照してください。

#### delete_space_volumes[[huggingface_hub.HfApi.delete_space_volumes]]

```python
delete_space_volumes(repo_id: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9108)

**パラメータ:**

repo_id (`str`) : 更新する Space の ID。例: `"username/my-space"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**例外:** `BadRequestError`

- `BadRequestError` -- Space にボリュームが接続されていない場合。

Spaceからすべてのボリュームを削除します。

例:
```python
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.delete_space_volumes("username/my-space")
```

#### delete_tag[[huggingface_hub.HfApi.delete_tag]]

```python
delete_tag(repo_id: str, tag: str, token: bool | str | None = None, repo_type: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7169)

**パラメータ:**

repo_id (`str`) : タグが削除されるリポジトリ。例: `"user/my-cool-model"`。

tag (`str`) : 削除するタグの名前。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

repo_type (`str`, *任意*) : データセットまたはスペースにタグを付ける場合は `"dataset"` または `"space"`、モデルにタグを付ける場合は `None` または `"model"` を設定します。デフォルトは `None` です。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- リポジトリが見つからない場合（エラー 404）: repo_id/repo_type が誤っている、プライベートリポジトリだが認証されていない、またはリポジトリが存在しない。
- [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- タグが見つからない場合。

Hub上のリポジトリからタグを削除します。

#### delete_webhook[[huggingface_hub.HfApi.delete_webhook]]

```python
delete_webhook(webhook_id: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11529)

**パラメータ:**

webhook_id (`str`) : 削除する Webhook の一意の識別子。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `None`

Webhookを削除します。

例:
```python
>>> from huggingface_hub import delete_webhook
>>> delete_webhook("654bbbc16f2ec14d77f109cc")
```

#### disable_space_dev_mode[[huggingface_hub.HfApi.disable_space_dev_mode]]

```python
disable_space_dev_mode(repo_id: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8497)

**パラメータ:**

repo_id (`str`) : 開発モードを無効にする Space の ID。例: `"Salesforce/BLIP2"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceRuntime)

Spaceのランタイムに関する情報。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) または [BadRequestError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.BadRequestError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Space が見つからない場合（エラー 404）に発生します。おそらく repo_id が誤っているか、Space がプライベートであるにもかかわらず認証されていないことが原因です。
- [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- 403 Forbidden: Spaceのdevモードを設定できるのは、そのSpaceの所有者のみです。所有していないSpaceを操作したい場合は、Discussionを開いて所有者に依頼するか、そのSpaceを複製してください。
- [BadRequestError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.BadRequestError) --  該当の Space が静的 Space の場合です。静的 Space は常に稼働しており、請求は発生しません。静的 Space を非表示にする場合は、プライベートに設定できます。

Spaceで開発モードを無効にします。

Spaces Dev Mode は、Space コンテナ自体を停止せずにアプリケーションを再起動できるため、アプリケーションのデバッグを容易にし、Spaces での反復開発を高速化します。Dev Mode を有効にするには PRO または Team & Enterprise プランが必要ですが、無効にする操作は常に許可されています（例：サブスクリプションの有効期限が切れた後）。詳細については、https://huggingface.co/docs/hub/spaces-dev-mode を参照してください。

#### disable_webhook[[huggingface_hub.HfApi.disable_webhook]]

```python
disable_webhook(webhook_id: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11476)

**パラメータ:**

webhook_id (`str`) : 無効化対象のWebhookの一意の識別子。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [WebhookInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.WebhookInfo)

無効化されたWebhookに関する情報。

Webhookを無効化します（「無効」にします）。

例:
```python
>>> from huggingface_hub import disable_webhook
>>> disabled_webhook = disable_webhook("654bbbc16f2ec14d77f109cc")
>>> disabled_webhook
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    jon=None,
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=True,
)
```

#### download_bucket_files[[huggingface_hub.HfApi.download_bucket_files]]

```python
download_bucket_files(bucket_id: str, files: list[tuple[str | BucketFile, str | Path]], raise_on_missing_files: bool = False, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L15069)

**パラメータ:**

bucket_id (`str`) : バケットのID（例: `"username/my-bucket"`）。

files (`list[tuple[Union[str, BucketFile], Union[str, Path]]]`) : ダウンロードするファイルを、(ソース, 宛先) のタプルのリストとして指定します。形式の詳細については、上記の説明を参照してください。

raise_on_missing_files (`bool`, *optional*) : `True`の場合、リクエストされたファイルがバケットに存在しないときに`EntryNotFoundError`を発生させます。`False`（デフォルト）の場合、存在しないファイルは警告とともにスキップされます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

バケットからファイルをダウンロードします。

Files input は `(remote file, local file)` のタプルのリストです。`remote file` はバケット内のファイルのパスまたは [BucketFile](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.BucketFile) オブジェクトのいずれかであり、`local file` はローカルファイルシステム上の宛先パスです。[BucketFile](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.BucketFile) オブジェクト（[list_bucket_tree()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_bucket_tree) から取得したもの）を渡す場合、メソッドはメタデータの取得ステップをスキップして、ファイルを直接ダウンロードします。

例:
```python
>>> from huggingface_hub import download_bucket_files

>>> download_bucket_files(
...     bucket_id="username/my-bucket",
...     files=[
...         ("models/model.safetensors", "./local/model.safetensors"),
...         ("config.json", "./local/config.json"),
...     ],
... )
```

```python
>>> from huggingface_hub import download_bucket_files

>>> parquet_files = [file for file in list_bucket_tree(bucket_id="username/my-bucket") if file.path.endswith(".parquet")]
>>> download_bucket_files(
...     bucket_id="username/my-bucket",
...     files=[(file, f"./local/{file.path}") for file in parquet_files],
... )
```

#### duplicate_repo[[huggingface_hub.HfApi.duplicate_repo]]

```python
duplicate_repo(from_id: str, to_id: str | None = None, repo_type: str | None = None, private: bool | None = None, visibility: RepoVisibility_T | None = None, token: bool | str | None = None, exist_ok: bool = False, resource_group_id: str | None = None, space_hardware: SpaceHardware | None = None, space_sleep_time: int | None = None, space_secrets: list[dict[str, str]] | None = None, space_variables: list[dict[str, str]] | None = None, space_volumes: list[Volume] | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8863)

**パラメータ:**

from_id (`str`) : 複製するリポジトリのID。例: `"openai/gdpval"`。

to_id (`str`, *任意*) : 新しいリポジトリの ID。例: `"myorg/my-gdpval"`。指定しない場合、新しいリポジトリは元のリポジトリと同じ名前が付けられますが、アカウントは自分のものになります。

repo_type (`str`, *任意*) : データセットまたはSpaceを複製する場合は`"dataset"`または`"space"`、モデルを複製する場合は`None`または`"model"`に設定します。デフォルトは`None`です。

private (`bool`, *任意*) : 新しいリポジトリをプライベートにするかどうか。デフォルトでは、元のリポジトリと同じプライバシー設定が適用されます。`visibility` と同時に指定することはできません。

visibility (`Literal["public", "private", "protected"]`, *optional*) : 新規リポジトリの公開設定。`"public"`または`"private"`、Spaces の場合は`"protected"`を指定できます。デフォルトでは、元のリポジトリと同じ公開設定が適用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

exist_ok (`bool`、*任意*、デフォルトは`False`) : `True`の場合、リポジトリが既に存在していてもエラーを発生させません。

resource_group_id (`str`, *任意*) : 新しいリポジトリを作成するリソースグループ。リソースグループはエンタープライズ Hub 組織でのみ利用可能であり、組織のどのメンバーがリソースにアクセスできるかを定義できます。リソースグループの ID は、Hub 上のリソースのページの URL から確認できます（例: `"66670e5163145ca562cb1988"`）。リソースグループの詳細については、https://huggingface.co/docs/hub/en/security-resource-groups を参照してください。

space_hardware (`SpaceHardware` または `str`、*省略可能*) : repo_type が "space" の場合の Hardware の選択です。例: `"t4-medium"`。完全なリストについては [SpaceHardware](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceHardware) を参照してください。

space_sleep_time (`int`, *optional*) : Space がスリープ状態に入るまで、待機状態を何秒間待つかを指定します。Space がスリープしない場合は `-1` を設定してください（アップグレードされたハードウェアのデフォルト動作です）。無料のハードウェアでは、スリープ時間を設定できません（値は 48 時間の待機に固定されています）。repo_type が "space" の場合のみ適用されます。詳細は https://huggingface.co/docs/hub/spaces-gpus#sleep-time を参照してください。

space_secrets (`list[dict[str, str]]`, *任意*) : Space に設定するシークレットキーのリストです。各項目は `{"key": ..., "value": ..., "description": ...}` の形式で、description は任意です。repo_type が "space" の場合のみ適用されます。詳細については、https://huggingface.co/docs/hub/spaces-overview#managing-secrets を参照してください。

space_variables (`list[dict[str, str]]`、*任意*) : Space で設定する公開環境変数のリストです。各項目は `{"key": ..., "value": ..., "description": ...}` の形式で、description は任意です。repo_type が "space" の場合のみ適用されます。詳細については、https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables を参照してください。

space_volumes (`list[Volume]`, *任意*) : Space の複製時にマウントする [Volume](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.Volume) オブジェクトのリストです。各ボリュームには、`type`（`"bucket"`、`"model"`、`"dataset"`、または `"space"`）、`source`（リポジトリまたはバケットの ID）、`mount_path`（コンテナ内のパス）、および任意の `revision`、`read_only`、`path` フィールドがあります。repo_type が "space" の場合のみ適用されます。

**戻り値:** [DuplicatedRepoUrl](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.DuplicatedRepoUrl)

新しく作成されたリポジトリへのURL。値は`endpoint`、`repo_type`、`repo_id`、`files_copy_pending`などの属性を含む、[RepoUrl](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.RepoUrl)（および`str`）のサブクラスです。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または `HfHubHTTPError`

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- `from_id` または `to_id` のいずれかが見つからない場合。存在しないか、`private` に設定されていてアクセス権限がないためです。
- `HfHubHTTPError` -- HuggingFace APIがエラーを返した場合

Hub上のリポジトリ（モデル、データセット、またはSpace）を複製します。

これにより、ローカルでのダウンロード/アップロードの往復を必要とせずに、完全な git 履歴と LFS オブジェクトを保持したサーバーサイドのコピーが実行されます。

git の履歴は即座にコピーされますが、このメソッドが返却された後も、LFS/Xet ファイルがバックグラウンドでコピーされ続ける場合があります。その場合、返却値の `files_copy_pending` は `True` となり、コピーが完了するまで新しいリポジトリからこれらのファイルをダウンロードしようとすると失敗する可能性があります。

例:
```python
>>> from huggingface_hub import duplicate_repo

# Duplicate a model to your account
>>> repo_url = duplicate_repo("google/gemma-7b")
>>> repo_url
RepoUrl('https://huggingface.co/nateraw/gemma-7b',...)
>>> repo_url.files_copy_pending
True

# Duplicate a dataset with a custom name
>>> duplicate_repo("openai/gdpval", to_id="myorg/my-gdpval", repo_type="dataset")
RepoUrl('https://huggingface.co/datasets/myorg/my-gdpval',...)

# Duplicate a Space with custom hardware
>>> duplicate_repo("multimodalart/dreambooth-training", repo_type="space", space_hardware="t4-medium")
RepoUrl('https://huggingface.co/spaces/nateraw/dreambooth-training',...)
```

#### edit_discussion_comment[[huggingface_hub.HfApi.edit_discussion_comment]]

```python
edit_discussion_comment(repo_id: str, discussion_num: int, comment_id: str, new_content: str, token: bool | str | None = None, repo_type: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7883)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

discussion_num (`int`) : Discussion または Pull Request の番号です。正の整数である必要があります。

comment_id (`str`) : 編集するコメントのID。

new_content (`str`) : コメントの新しい内容。コメントはMarkdown形式の書式に対応しています。

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [DiscussionComment](/docs/huggingface_hub/v2.4.0/ja/package_reference/community#huggingface_hub.DiscussionComment)

編集されたコメント

Discussion / Pull Request のコメントを編集します。

> [!TIP]
> 以下のエラーを発生させます：
>
> - HuggingFace APIがエラーを返した場合に[`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) - パラメータの値が無効な場合に[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) - ダウンロード元のリポジトリが見つからない場合に[RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)。存在しないか、`private`に設定されていてアクセス権限がないためです。

#### enable_space_dev_mode[[huggingface_hub.HfApi.enable_space_dev_mode]]

```python
enable_space_dev_mode(repo_id: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8458)

**パラメータ:**

repo_id (`str`) : 開発モードを有効にする Space の ID。例: `"Salesforce/BLIP2"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceRuntime)

Spaceのランタイムに関する情報。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) または [BadRequestError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.BadRequestError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Space が見つからない場合（エラー 404）に発生します。おそらく repo_id が誤っているか、Space がプライベートであるにもかかわらず認証されていないことが原因です。
- [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- 403 Forbidden: Spaceのdevモードを設定できるのは、そのSpaceの所有者のみです。所有していないSpaceを操作したい場合は、Discussionを開いて所有者に依頼するか、そのSpaceを複製してください。
- [BadRequestError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.BadRequestError) --  該当の Space が静的 Space の場合です。静的 Space は常に稼働しており、請求は発生しません。静的 Space を非表示にする場合は、プライベートに設定できます。

Spaceで開発モードを有効にします。

Spaces Dev Mode は、Space コンテナ自体を停止せずにアプリケーションを再起動できるため、アプリケーションのデバッグを容易にし、Spaces での反復開発を高速化します。この機能は、PRO または Team & Enterprise プランの一部として利用できます。詳細については、https://huggingface.co/docs/hub/spaces-dev-mode を参照してください。

#### enable_webhook[[huggingface_hub.HfApi.enable_webhook]]

```python
enable_webhook(webhook_id: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11423)

**パラメータ:**

webhook_id (`str`) : 有効化対象のWebhookの一意の識別子。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [WebhookInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.WebhookInfo)

有効化されたWebhookに関する情報。

Webhookを有効化します（「アクティブ」にします）。

例:
```python
>>> from huggingface_hub import enable_webhook
>>> enabled_webhook = enable_webhook("654bbbc16f2ec14d77f109cc")
>>> enabled_webhook
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    job=None,
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=False,
)
```

#### fetch_job_logs[[huggingface_hub.HfApi.fetch_job_logs]]

```python
fetch_job_logs(job_id: str, namespace: str | None = None, follow: bool = False, tail: int | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12327)

**パラメータ:**

job_id (`str`) : Job の ID。

namespace (`str`, *任意*) : Job が実行されている名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

follow (`bool`, *任意*) : `True`の場合、ジョブが完了するまでリアルタイムでログをストリーミングします（ブロッキング）。`False`（デフォルト）の場合、現在利用可能なログのみを取得して即座に返します（ノンブロッキング）。

tail (`int`, *任意*) : ログから返す最大行数。`follow=True` と組み合わせると、最後の N 行から開始し、新しいログのストリーミングを続けます。`follow=False` の場合、現在利用可能なログから最後の N 行のみを返します。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

Hugging Face のインフラストラクチャ上の compute Job からすべてのログを取得します。

例:

```python
>>> from huggingface_hub import fetch_job_logs, run_job
>>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"])
>>> for log in fetch_job_logs(job_id=job.id):
...     print(log)
Hello from HF compute!

>>> # Non-blocking: fetch only currently available logs
>>> for log in fetch_job_logs(job_id=job.id, follow=False):
...     print(log)

>>> # Stream logs starting from the last 100 lines
>>> for log in fetch_job_logs(job_id=job.id, follow=True, tail=100):
...     print(log)
```

#### fetch_job_metrics[[huggingface_hub.HfApi.fetch_job_metrics]]

```python
fetch_job_metrics(job_id: str, namespace: str | None = None, follow: bool = False, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12407)

**パラメータ:**

job_id (`str`) : Job の ID。

namespace (`str`, *任意*) : Job が実行されている名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

follow (`bool`, *optional*) : `True`の場合、ジョブが完了するまで（ブロッキング）リアルタイムでメトリクスをストリーミングします。`False`（デフォルト）の場合、現在のメトリクスのみを取得して返します（ノンブロッキング）。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

Hugging Faceのインフラストラクチャ上のcompute Jobからライブメトリクスを取得します。

例:

```python
>>> from huggingface_hub import fetch_job_metrics, run_job
>>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], flavor="a10g-small")
>>> for metrics in fetch_job_metrics(job_id=job.id):
...     print(metrics)
{
    "cpu_usage_pct": 0,
    "cpu_millicores": 3500,
    "memory_used_bytes": 1306624,
    "memory_total_bytes": 15032385536,
    "rx_bps": 0,
    "tx_bps": 0,
    "gpus": {
        "882fa930": {
            "utilization": 0,
            "memory_used_bytes": 0,
            "memory_total_bytes": 22836000000
        }
    },
    "replica": "57vr7"
}

>>> # Stream metrics until the job completes
>>> for metrics in fetch_job_metrics(job_id=job.id, follow=True):
...     print(metrics)
```

#### fetch_space_logs[[huggingface_hub.HfApi.fetch_space_logs]]

```python
fetch_space_logs(repo_id: str, build: bool = False, follow: bool = False, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8737)

**パラメータ:**

repo_id (`str`) : Space の ID。例: `"bigcode/in-the-stack"`。

build (`bool`、*任意*、デフォルトは`False`) : `True`の場合、コンテナのビルドログを取得します（Spaceが`BUILD_ERROR`で停止している場合に有用です）。`False`（デフォルト）の場合、実行ログ、つまり実行中のアプリケーションのstdout/stderrを取得します。

follow (`bool`、*任意*、デフォルトは`False`) : `True`の場合、サーバーがストリームを閉じるか`KeyboardInterrupt`が発生するまで、ログをリアルタイムで（ブロッキング方式で）ストリーミングします。`False`（デフォルト）の場合、現在バッファリングされているログのみを取得して即座に返します（ノンブロッキング、`docker logs`と同様）。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン。デフォルトではローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

**戻り値:** `Iterable[str]`

利用可能なログ行を生成するジェネレーター。

Hub上のSpaceの実行ログまたはビルドログを取得します。

Spaceのビルド失敗や実行時クラッシュのデバッグに有用です。特に、ブラウザでログを読むことができないスクリプトやエージェント型ワークフローからの場合です。

例:

```python
>>> from huggingface_hub import fetch_space_logs
>>> # Non-blocking: print currently available run logs and exit.
>>> for line in fetch_space_logs("username/my-space"):
...     print(line, end="")

>>> # Debug a build failure:
>>> for line in fetch_space_logs("username/my-space", build=True):
...     print(line, end="")

>>> # Stream run logs until the server closes the stream.
>>> for line in fetch_space_logs("username/my-space", follow=True):
...     print(line, end="")
```

#### file_exists[[huggingface_hub.HfApi.file_exists]]

```python
file_exists(repo_id: str, filename: str, repo_type: str | None = None, revision: str | None = None, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3768)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

filename (`str`) : 確認するファイルの名前。例: `"config.json"`

repo_type (`str`, *任意*) : データセットまたはスペースからリポジトリ情報を取得する場合は `"dataset"` または `"space"`、モデルからリポジトリ情報を取得する場合は `None` または `"model"` を設定します。デフォルトは `None` です。

revision (`str`, *任意*) : 情報を取得するリポジトリのリビジョン。デフォルトは `"main"` ブランチです。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:**

ファイルが存在する場合はTrue、それ以外の場合はFalse。

Hugging Face Hub上のリポジトリにファイルが存在するかどうかを確認します。

例:
```py
>>> from huggingface_hub import file_exists
>>> file_exists("bigcode/starcoder", "config.json")
True
>>> file_exists("bigcode/starcoder", "not-a-file")
False
>>> file_exists("bigcode/not-a-repo", "config.json")
False
```

#### get_bucket_file_metadata[[huggingface_hub.HfApi.get_bucket_file_metadata]]

```python
get_bucket_file_metadata(bucket_id: str, remote_path: str, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L15010)

**パラメータ:**

bucket_id (`str`) : バケットのID（例: `"username/my-bucket"`）。

remote_path (`str`) : バケット内のファイルのパス。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [BucketFileMetadata](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.BucketFileMetadata)

サイズとxet情報を含むファイルのメタデータ。

バケット内のファイルのメタデータを取得します。

例:
```python
>>> from huggingface_hub import get_bucket_file_metadata
>>> metadata = get_bucket_file_metadata(
...     bucket_id="username/my-bucket",
...     remote_path="models/model.safetensors",
... )
>>> metadata.size
42000
```

#### get_bucket_paths_info[[huggingface_hub.HfApi.get_bucket_paths_info]]

```python
get_bucket_paths_info(bucket_id: str, paths: Iterable[str], token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14356)

**パラメータ:**

bucket_id (`str`) : バケットのID（例: `"username/my-bucket"`）。

paths (`Iterable[str]`) : 情報取得対象のパスです。存在しないパスは例外を発生させずに無視されます。ファイルパスのみサポートされています。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[BucketFile]`

[BucketFile](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.BucketFile) オブジェクトのイテラブルとしての、パスに関する情報。

バケットのパスに関する情報を取得します。

呼び出しは1000パスずつのバッチで行われます。結果は受信された時点で返されます。

例:
```py
>>> from huggingface_hub import get_bucket_paths_info
>>> paths_info = get_bucket_paths_info("username/my-bucket", ["file.txt", "checkpoints/model.safetensors"])
>>> for info in paths_info:
...     print(info)
BucketFile(type='file', path='file.txt', size=2379, xet_hash='96e637d9665bd35477b1908a23f2e254edfba0618dbd2d62f90a6baee7d139cf', mtime=datetime.datetime(2024, 9, 25, 15, 31, 2, 346000, tzinfo=datetime.timezone.utc))
BucketFile(type='file', path='checkpoints/model.safetensors', size=2408828, xet_hash='3ed0e9fefe788ddd61d1e26eba67057e9740a064b009256fbafadf6bb95785ca', mtime=datetime.datetime(2024, 9, 25, 15, 31, 2, 346000, tzinfo=datetime.timezone.utc))
```

#### get_collection[[huggingface_hub.HfApi.get_collection]]

```python
get_collection(collection_slug: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10152)

**パラメータ:**

collection_slug (`str`) : Hub のコレクションのスラッグ。例: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

Hub上のCollectionに関する情報を取得します。

戻り値: [Collection](/docs/huggingface_hub/v2.4.0/ja/package_reference/collections#huggingface_hub.Collection)

例:

```py
>>> from huggingface_hub import get_collection
>>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")
>>> collection.title
'Recent models'
>>> len(collection.items)
37
>>> collection.items[0]
CollectionItem(
    item_object_id='651446103cd773a050bf64c2',
    item_id='TheBloke/U-Amethyst-20B-AWQ',
    item_type='model',
    position=88,
    note=None
)
```

#### get_dataset_leaderboard[[huggingface_hub.HfApi.get_dataset_leaderboard]]

```python
get_dataset_leaderboard(repo_id: str, base_model_only: bool | None = None, token: bool | str | None = None, timeout: float | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3289)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。例: `"allenai/olmOCR-bench"`。

base_model_only (`bool` または `None`、*任意*) : デフォルトでは、リーダーボードには `base_model` 関係が宣言されていないモデル（つまり、正規/ルートリポジトリ）のみが含まれます。これは Hub のデフォルトのリーダーボード表示と一致します。親モデルを宣言しているファインチューニング済みまたは派生リポジトリは除外されます。このフィルタを無効にして、モデルがベースモデルの関係を宣言しているかどうかに関わらず、すべての提出結果を含めるには、`base_model_only=False` を渡してください。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

timeout (`float`, *任意*) : Hub へのリクエストにタイムアウトを設定するかどうか。

**戻り値:** `list[DatasetLeaderboardEntry]`

ランキング順に並べられたリーダーボードのエントリを表す[DatasetLeaderboardEntry](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.DatasetLeaderboardEntry)オブジェクトのリスト。

Hub上のデータセットのリーダーボードを取得します。

リーダーボードは、指定されたベンチマークデータセットでの評価スコアに基づいてモデルをランキングします。すべてのデータセットにリーダーボードがあるわけではなく、評価結果が提出されたベンチマークデータセットのみが対象です。これにより、スコアのデータセット中心のビューが得られます。モデル中心のビューが必要な場合は、`expand=["evalResults"]` を指定して [model_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.model_info) を使用してください。

> [!TIP]
> 以下のエラーを発生させます：
>
> - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) リポジトリが見つからない場合。存在しないか、`private`に設定されておりアクセス権限がない可能性があります。 - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) データセットにリーダーボードがない場合。

例:
```python
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> leaderboard = api.get_dataset_leaderboard("allenai/olmOCR-bench")
>>> leaderboard[0].model_id
'datalab-to/chandra-ocr-2'
>>> leaderboard[0].rank
1

# Include fine-tuned / derivative models too
>>> full_leaderboard = api.get_dataset_leaderboard("allenai/olmOCR-bench", base_model_only=False)
```

#### get_dataset_tags[[huggingface_hub.HfApi.get_dataset_tags]]

```python
get_dataset_tags()
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2301)

有効なデータセットタグをすべて、ネストされた名前空間オブジェクトとして一覧表示します。

#### get_discussion_details[[huggingface_hub.HfApi.get_discussion_details]]

```python
get_discussion_details(repo_id: str, discussion_num: int, repo_type: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7364)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

discussion_num (`int`) : Discussion または Pull Request の番号です。正の整数である必要があります。

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

HubからDiscussion / Pull Requestの詳細を取得します。

戻り値: [DiscussionWithDetails](/docs/huggingface_hub/v2.4.0/ja/package_reference/community#huggingface_hub.DiscussionWithDetails)

> [!TIP]
> 以下のエラーを発生させます：
>
> - HuggingFace APIがエラーを返した場合に[`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) - パラメータの値が無効な場合に[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) - ダウンロード元のリポジトリが見つからない場合に[RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)。存在しないか、`private`に設定されていてアクセス権限がないためです。

#### get_full_repo_name[[huggingface_hub.HfApi.get_full_repo_name]]

```python
get_full_repo_name(model_id: str, organization: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7218)

**パラメータ:**

model_id (`str`) : モデルの名前。

organization (`str`, *任意*) : 指定された場合、リポジトリ名はユーザーネームスペースではなく、組織ネームスペース内に配置されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `str`

組織が指定されない場合は、ユーザーのネームスペース内のリポジトリ名（{username}/{model_id}）、指定される場合は組織のネームスペース内のリポジトリ名（{organization}/{model_id}）です。

指定されたモデルIDと任意の組織名に対して、リポジトリ名を返します。

#### get_hf_file_metadata[[huggingface_hub.HfApi.get_hf_file_metadata]]

```python
get_hf_file_metadata(url: str, token: bool | str | None = None, timeout: float | None = 10)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6285)

**パラメータ:**

url (`str`) : ファイルのURL。例えば、[hf_hub_url()](/docs/huggingface_hub/v2.4.0/ja/package_reference/file_download#huggingface_hub.hf_hub_url)によって返されるもの。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

timeout (`float`、*任意*、デフォルトは 10) : サーバーがメタデータを送信するのを待ってから諦めるまでの秒数。

**戻り値:**

位置情報、etag、サイズ、commit_hashなどのメタデータを含む[HfFileMetadata](/docs/huggingface_hub/v2.4.0/ja/package_reference/file_download#huggingface_hub.HfFileMetadata)オブジェクト。

指定されたURLの、Hub上でバージョン管理されているファイルのメタデータを取得します。

#### get_inference_endpoint[[huggingface_hub.HfApi.get_inference_endpoint]]

```python
get_inference_endpoint(name: str, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9659)

**パラメータ:**

name (`str`) : 情報取得対象のInference Endpointの名前。

namespace (`str`, *任意*) : Inference Endpoint が配置されている名前空間です。デフォルトでは、現在のユーザーになります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/ja/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint)

要求されたInference Endpointに関する情報。

Inference Endpointに関する情報を取得します。

例:
```python
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.get_inference_endpoint("my-text-to-image")
>>> endpoint
InferenceEndpoint(name='my-text-to-image', ...)

# Get status
>>> endpoint.status
'running'
>>> endpoint.url
'https://my-text-to-image.region.vendor.endpoints.huggingface.cloud'

# Run inference
>>> endpoint.client.text_to_image(...)
```

#### get_model_tags[[huggingface_hub.HfApi.get_model_tags]]

```python
get_model_tags()
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2292)

有効なモデルタグをすべてネストされた名前空間オブジェクトとして一覧表示します

#### get_organization_overview[[huggingface_hub.HfApi.get_organization_overview]]

```python
get_organization_overview(organization: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11747)

**パラメータ:**

organization (`str`) : 概要を取得する組織の名前。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Organization`

組織の概要を含む`Organization`オブジェクト。

**例外:** ``HTTPError``

- [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) -- 組織が Hub に存在しない場合、HTTP 404 が返されます。

Hub上の組織の概要を取得します。

#### get_paths_info[[huggingface_hub.HfApi.get_paths_info]]

```python
get_paths_info(repo_id: str, paths: list[str] | str, expand: bool = False, revision: str | None = None, repo_type: str | None = None, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4269)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

paths (`Union[list[str], str]`、*optional*) : 情報取得の対象となるパスです。パスが存在しない場合は、例外を発生させずに無視されます。

expand (`bool`、*任意*、デフォルトは`False`) : パスに関する追加情報（例：最終コミットやファイルのセキュリティスキャン結果）を取得するかどうか。この操作はサーバーにとってコストが高いため、1ページあたりの返却結果は50件（1000件ではなく）に制限されます。`huggingface_hub`でページネーションが実装されているため、結果を取得するまでの時間がかかる点を除けば、ユーザーには透過的です。

revision (`str`, *任意*) : 情報を取得するリポジトリのリビジョン。デフォルトは `"main"` ブランチです。

repo_type (`str`, *任意*) : 情報を取得するリポジトリのタイプ (`"model"`、`"dataset"` または `"space"`。デフォルトは `"model"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `list[Union[RepoFile, RepoFolder]]`

[RepoFile](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.RepoFile)オブジェクトと`RepoFolder`オブジェクトのリストとして、パスに関する情報。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- リポジトリが見つからない場合（エラー 404）: repo_id/repo_type が誤っている、プライベートリポジトリだが認証されていない、またはリポジトリが存在しない。
- [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- リポジトリ上でリビジョンが見つからない場合（エラー 404）。

リポジトリのパスに関する情報を取得します。

例:
```py
>>> from huggingface_hub import get_paths_info
>>> paths_info = get_paths_info("allenai/c4", ["README.md", "en"], repo_type="dataset")
>>> paths_info
[
    RepoFile(path='README.md', size=2379, blob_id='f84cb4c97182890fc1dbdeaf1a6a468fd27b4fff', lfs=None, last_commit=None, security=None),
    RepoFolder(path='en', tree_id='dc943c4c40f53d02b31ced1defa7e5f438d5862e', last_commit=None)
]
```

#### get_repo_discussions[[huggingface_hub.HfApi.get_repo_discussions]]

```python
get_repo_discussions(repo_id: str, author: str | None = None, discussion_type: constants.DiscussionTypeFilter | None = None, discussion_status: constants.DiscussionStatusFilter | None = None, repo_type: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7256)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

author (`str`, *任意*) : ディスカッションの著者でフィルタリングするための値を渡します。`None` はフィルタリングしないことを意味します。デフォルトは`None`です。

discussion_type (`str`, *任意*) : `"pull_request"`に設定するとプルリクエストのみ、`"discussion"`に設定するとディスカッションのみを取得します。`"all"`または`None`に設定すると両方とも取得します。デフォルトは`None`です。

discussion_status (`str`, *任意*) : `"open"`（または `"closed"`）に設定すると、オープン（またはクローズ）されたディスカッションのみを取得します。`"all"` または `None` に設定すると、両方とも取得します。デフォルトは `None` です。

repo_type (`str`, *任意*) : データセットまたはスペースから取得する場合は `"dataset"` または `"space"`、モデルから取得する場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterator[Discussion]`

[Discussion](/docs/huggingface_hub/v2.4.0/ja/package_reference/community#huggingface_hub.Discussion)オブジェクトのイテレータ。

指定されたリポジトリのディスカッションとプルリクエストを取得します。

例:

リポジトリのすべてのディスカッションをリストに集める:

```python
>>> from huggingface_hub import get_repo_discussions
>>> discussions_list = list(get_repo_discussions(repo_id="bert-base-uncased"))
```

リポジトリのディスカッションを反復処理する:

```python
>>> from huggingface_hub import get_repo_discussions
>>> for discussion in get_repo_discussions(repo_id="bert-base-uncased"):
...     print(discussion.num, discussion.title)
```

#### get_safetensors_metadata[[huggingface_hub.HfApi.get_safetensors_metadata]]

```python
get_safetensors_metadata(repo_id: str, repo_type: str | None = None, revision: str | None = None, token: bool | str | None = None, timeout: float | None = 10)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6669)

**パラメータ:**

repo_id (`str`) : ユーザー名または組織名とリポジトリ名を`/`で区切ったもの。

repo_type (`str`, *任意*) : ファイルがデータセットまたはスペースにある場合は `"dataset"` または `"space"`、モデルにある場合は `None` または `"model"` を設定します。デフォルトは `None` です。

revision (`str`, *任意*) : ファイルを取得する git リビジョンです。ブランチ名、タグ、またはコミットハッシュを指定できます。デフォルトでは、`"main"` ブランチの先頭が使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

timeout (`float`、*任意*、デフォルト値は 10) : サーバーがデータを送信するのを待ってから諦めるまでの秒数です。safetensors ファイルのヘッダーを取得する各リクエストに渡されます。タイムアウトを無効にするには `None` を設定してください（接続が停止した際に呼び出しが無限にハングする可能性があるため、非推奨です）。

**戻り値:** `SafetensorsRepoMetadata`

safetensorsリポジトリに関する情報。

**例外:** `NotASafetensorsRepoError` または `SafetensorsParsingError`

- `NotASafetensorsRepoError` -- リポジトリがsafetensorsのリポジトリでない場合、つまり`model.safetensors`ファイルまたは`model.safetensors.index.json`ファイルのいずれも存在しない場合に発生します。
- `SafetensorsParsingError` -- safetensorsファイルのヘッダーを正しく解析できなかった場合。

Hub上のsafetensorsリポジトリのメタデータを解析します。

まず、リポジトリが単一のsafetensorsファイルか、シャード化されたsafetensorsリポジトリかをチェックします。単一のsafetensorsファイルの場合は、このファイルからメタデータを解析します。シャード化されたsafetensorsリポジトリの場合は、インデックスファイルからメタデータを解析し、その後、各シャードからメタデータを解析します。

単一のsafetensorsファイルからメタデータを解析するには、[parse_safetensors_file_metadata()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.parse_safetensors_file_metadata)を使用します。シャード化されたモデルの`main`上のすべてのシャードヘッダーを1回のリクエストで取得するには、[get_sharded_safetensors_metadata()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.get_sharded_safetensors_metadata)を使用します。

safetensors形式の詳細については、https://huggingface.co/docs/safetensors/index#format をご覧ください。

例:
```py
# Parse repo with single weights file
>>> metadata = get_safetensors_metadata("bigscience/bloomz-560m")
>>> metadata
SafetensorsRepoMetadata(
    metadata=None,
    sharded=False,
    weight_map={'h.0.input_layernorm.bias': 'model.safetensors', ...},
    files_metadata={'model.safetensors': SafetensorsFileMetadata(...)}
)
>>> metadata.files_metadata["model.safetensors"].metadata
{'format': 'pt'}

# Parse repo with sharded model
>>> metadata = get_safetensors_metadata("bigscience/bloom")
Parse safetensors files: 100%|██████████████████████████████████████████| 72/72 [00:12<00:00,  5.78it/s]
>>> metadata
SafetensorsRepoMetadata(metadata={'total_size': 352494542848}, sharded=True, weight_map={...}, files_metadata={...})
>>> len(metadata.files_metadata)
72  # All safetensors files have been fetched

# Parse repo with sharded model
>>> get_safetensors_metadata("runwayml/stable-diffusion-v1-5")
NotASafetensorsRepoError: 'runwayml/stable-diffusion-v1-5' is not a safetensors repo. Couldn't find 'model.safetensors.index.json' or 'model.safetensors' files.
```

#### get_sharded_safetensors_metadata[[huggingface_hub.HfApi.get_sharded_safetensors_metadata]]

```python
get_sharded_safetensors_metadata(repo_id: str, filename: str = 'model.safetensors.index.json', token: bool | str | None = None, timeout: float | None = 10)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6824)

**パラメータ:**

repo_id (`str`) : ユーザー名または組織名とリポジトリ名を`/`で区切ったもの。

filename (`str`, *任意*) : リポジトリ内のsafetensorsインデックスファイルのパス。デフォルトは`"model.safetensors.index.json"`です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

timeout (`float`、*任意*、デフォルトは 10) : サーバーからデータを受信するのを待ってから諦めるまでの秒数です。タイムアウトを無効にするには `None` を設定してください（接続が停止した際に呼び出しが無限にハングする可能性があるため、推奨されません）。

**戻り値:** `SafetensorsRepoMetadata`

[get_safetensors_metadata()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.get_safetensors_metadata) と同じメタデータ。

`main`のHub上のシャード化されたsafetensorsモデルのすべてのシャードのメタデータを、[get_safetensors_metadata()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.get_safetensors_metadata)が各シャードのヘッダーを解析する代わりに、単一のリクエストで取得します。Hugging Face Hubのみ。

例:
```py
>>> metadata = get_sharded_safetensors_metadata("HuggingFaceH4/zephyr-7b-beta")
>>> len(metadata.files_metadata)
8
```

#### get_space_runtime[[huggingface_hub.HfApi.get_space_runtime]]

```python
get_space_runtime(repo_id: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8239)

**パラメータ:**

repo_id (`str`) : 更新するリポジトリの ID。例: `"bigcode/in-the-stack"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceRuntime)

Spaceのステージやハードウェアなど、Spaceに関するランタイム情報。

Spaceのランタイム情報を取得します。

#### get_space_secrets[[huggingface_hub.HfApi.get_space_secrets]]

```python
get_space_secrets(repo_id: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8109)

**パラメータ:**

repo_id (`str`) : クエリ対象のリポジトリの ID。例: `"bigcode/in-the-stack"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `dict[str, SpaceSecret]`

シークレット名をキーとする`SpaceSecret`オブジェクトの辞書。

Spaceからすべてのシークレットを取得します。

Secret値は書き込み専用であり、読み戻すことはできません。返されるのはキー、説明、最終更新時刻のみです。

Secretsを使用すると、Spaceにシークレットキーやトークンを設定できますが、ハードコードする必要はありません。詳細については、https://huggingface.co/docs/hub/spaces-overview#managing-secretsを参照してください。

例:
```python
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.get_space_secrets("username/my-space")
{'HF_TOKEN': SpaceSecret(key='HF_TOKEN', description='...', updated_at=datetime.datetime(...))}
```

#### get_space_variables[[huggingface_hub.HfApi.get_space_variables]]

```python
get_space_variables(repo_id: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8146)

**パラメータ:**

repo_id (`str`) : クエリ対象のリポジトリの ID。例: `"bigcode/in-the-stack"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

Spaceからすべての変数を取得します。

変数を使用すると、Space にハードコードせずに環境変数を設定できます。詳細については、https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables を参照してください。

#### get_user_overview[[huggingface_hub.HfApi.get_user_overview]]

```python
get_user_overview(username: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11721)

**パラメータ:**

username (`str`) : 概要を取得するユーザーのユーザー名。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `User`

ユーザーの概要を含む[User](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.User)オブジェクト。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` -- ユーザーが Hub に存在しない場合、HTTP 404 が返されます。

Hub上のユーザーの概要を取得します。

#### get_webhook[[huggingface_hub.HfApi.get_webhook]]

```python
get_webhook(webhook_id: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11072)

**パラメータ:**

webhook_id (`str`) : 取得する Webhook の一意の識別子。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [WebhookInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.WebhookInfo)

Webhookに関する情報。

idを指定してWebhookを取得します。

例:
```python
>>> from huggingface_hub import get_webhook
>>> webhook = get_webhook("654bbbc16f2ec14d77f109cc")
>>> print(webhook)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    job=None,
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    secret="my-secret",
    domains=["repo", "discussion"],
    disabled=False,
)
```

#### get_zero_gpu_quota[[huggingface_hub.HfApi.get_zero_gpu_quota]]

```python
get_zero_gpu_quota(token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8283)

**パラメータ:**

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。ファイングレイントークンには「Billing > Read billing usage and payment method status」の権限が必要であり、OAuth トークンには `read-billing` スコープが必要です。

**戻り値:** [ZeroGpuQuota](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.ZeroGpuQuota)

認証済みユーザーのZeroGPUクォータ。

認証済みユーザーのZeroGPUクォータを取得します。

ZeroGPU Spaces をプログラムから呼び出す際（アプリ、エージェント、MCP サーバーなどから）の ZeroGPU 使用状況を追跡するのに便利です。詳細は https://huggingface.co/docs/hub/spaces-zerogpu を参照してください。

例:
```py
>>> from huggingface_hub import get_zero_gpu_quota
>>> quota = get_zero_gpu_quota()
>>> quota
ZeroGpuQuota(base=2400, remaining=1810, resets_at=datetime.datetime(2026, 9, 30, 9, 12, 3, tzinfo=datetime.timezone.utc), overquota_used=0)
>>> print(f"{quota.remaining / 60:.1f} minutes left")
30.2 minutes left
```

#### grant_access[[huggingface_hub.HfApi.grant_access]]

```python
grant_access(repo_id: str, user: str, repo_type: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11017)

**パラメータ:**

repo_id (`str`) : アクセス権を付与するリポジトリのID。

user (`str`) : アクセス権限を付与するユーザーのユーザー名。

repo_type (`str`, *任意*) : アクセス権を付与するリポジトリの種類。`model`、`dataset`、`space` のいずれかである必要があります。デフォルトは `model` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` -- リポジトリがゲート付きでない場合、HTTP 400 が返されます。
- `HfHubHTTPError` -- ユーザーがすでにリポジトリにアクセス権限を持っている場合、HTTP 400 が返されます。
- `HfHubHTTPError` -- リポジトリへのアクセス権限が読み取り専用の場合、HTTP 403 が返されます。リポジトリが属する組織で `write` または `admin` のロールを持っていない場合、または `read` トークンを渡した場合に、この状況が発生します。
- `HfHubHTTPError` -- ユーザーが Hub に存在しない場合、HTTP 404 が返されます。

指定されたゲート付きリポジトリに対して、ユーザーへのアクセス権を付与します。

アクセス権限の付与には、ユーザー自身がアクセスリクエストを送信する必要はありません。ユーザーは自動的に承認リストに追加され、ファイルをダウンロードできるようになります。付与したアクセス権限は、[cancel_access_request()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.cancel_access_request)または[reject_access_request()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.reject_access_request)を使用して、いつでも取り消すことができます。

ゲート付きリポジトリの詳細については、https://huggingface.co/docs/hub/models-gated を参照してください。

#### hf_hub_download[[huggingface_hub.HfApi.hf_hub_download]]

```python
hf_hub_download(repo_id: str, filename: str, subfolder: str | None = None, repo_type: str | None = None, revision: str | None = None, cache_dir: str | Path | None = None, local_dir: str | Path | None = None, force_download: bool = False, etag_timeout: float = 10, token: bool | str | None = None, local_files_only: bool = False, tqdm_class: type[base_tqdm] | None = None, dry_run: bool = False)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6364)

**パラメータ:**

repo_id (`str`) : ユーザー名または組織名とリポジトリ名を`/`で区切ったもの。

filename (`str`) : リポジトリ内のファイル名。

subfolder (`str`, *任意*) : リポジトリ内のフォルダーに対応する任意の値。

repo_type (`str`, *任意*) : データセットまたはスペースからダウンロードする場合は `"dataset"` または `"space"`、モデルからダウンロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

revision (`str`, *任意*) : 任意の Git リビジョン ID。ブランチ名、タグ、またはコミットハッシュを指定できます。

cache_dir (`str`, `Path`, *省略可*) : キャッシュされたファイルを保存するフォルダへのパス。

local_dir (`str` または `Path`、*省略可能*) : 指定された場合、ダウンロードされたファイルはこのディレクトリ以下に配置されます。

force_download (`bool`, *任意*, デフォルトは `False`) : ローカルキャッシュに既に存在する場合でも、ファイルをダウンロードするかどうか。

etag_timeout (`float`、*任意*、デフォルトは`10`) : ETagを取得する際、サーバーがデータを送信するのを待ってから諦めるまでの秒数です。`httpx2.request`に渡されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

local_files_only (`bool`、*任意*、デフォルトは`False`) : `True`の場合、ファイルのダウンロードを回避し、ローカルにキャッシュされたファイルが存在する場合はそのパスを返します。

tqdm_class (`tqdm`、*任意*) : 指定された場合、プログレスバーのデフォルトの動作を上書きします。渡される引数は、`tqdm.auto.tqdm` を継承するか、少なくともその動作を模倣している必要があります。デフォルトでは、`HF_HUB_DISABLE_PROGRESS_BARS` 環境変数を設定することで無効化できる、HF 独自のプログレスバーが使用されます。

dry_run (`bool`、*任意*、デフォルトは`False`) : `True`の場合、ファイルをダウンロードせずにドライランを実行します。ダウンロードされる内容に関する情報を含む[DryRunFileInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.DryRunFileInfo)オブジェクトを返します。

**戻り値:** `str` または [DryRunFileInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.DryRunFileInfo)

- `dry_run=False`の場合: ファイルのローカルパス、またはネットワークがオフの場合はディスクにキャッシュされたファイルの最終バージョン。
- `dry_run=True`の場合: ダウンロード情報を含む[DryRunFileInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.DryRunFileInfo)オブジェクト。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) または `~utils.RemoteEntryNotFoundError` または [LocalEntryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.LocalEntryNotFoundError) または ``EnvironmentError`` または ``OSError`` または ``ValueError``

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- ダウンロード元のリポジトリが見つからない場合。存在しないか、`private`に設定されておりアクセス権限がない可能性があります。
- [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- ダウンロード元のリビジョンが見つからない場合。
- `~utils.RemoteEntryNotFoundError` -- ダウンロード対象のファイルが見つからない場合。
- [LocalEntryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.LocalEntryNotFoundError) -- ネットワークが無効または利用不可で、ファイルがキャッシュに見つからない場合。
- [`EnvironmentError`](https://docs.python.org/3/library/exceptions.html#EnvironmentError) -- `token=True` であるが、トークンが見つからない場合。
- [`OSError`](https://docs.python.org/3/library/exceptions.html#OSError) -- ETag を決定できない場合。
- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- パラメータの値が無効な場合。

ローカルキャッシュに存在しない場合、指定されたファイルをダウンロードします。

新しいキャッシュファイルのレイアウトは以下のようになります:
- cache ディレクトリには、repo_id ごとに1つのサブフォルダが含まれます（リポジトリタイプで名前空間が区切られています）。
- 各リポジトリフォルダ内:
  - refs は、最新既知の revision => commit_hash のペアのリストです
  - blobsには、実際のファイルのブロブが含まれています（LFSファイルかどうかによって、git-shaまたはsha256で識別されます）。
  - snapshotsにはコミットごとに1つのサブフォルダが含まれており、各「commit」には、その特定のコミット時点で解決されたファイルのサブセットが含まれます。各ファイル名は、その特定のコミット時点のblobへのシンボリックリンクです。

```
[  96]  .
└── [ 160]  models--julien-c--EsperBERTo-small
    ├── [ 160]  blobs
    │   ├── [321M]  403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd
    │   ├── [ 398]  7cb18dc9bafbfcf74629a4b760af1b160957a83e
    │   └── [1.4K]  d7edf6bd2a681fb0175f7735299831ee1b22b812
    ├── [  96]  refs
    │   └── [  40]  main
    └── [ 128]  snapshots
        ├── [ 128]  2439f60ef33a0d46d85da5001d52aeda5b00ce9f
        │   ├── [  52]  README.md -> ../../blobs/d7edf6bd2a681fb0175f7735299831ee1b22b812
        │   └── [  76]  pytorch_model.bin -> ../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd
        └── [ 128]  bbc77c8132af1cc5cf678da3f1ddf2de43606d48
            ├── [  52]  README.md -> ../../blobs/7cb18dc9bafbfcf74629a4b760af1b160957a83e
            └── [  76]  pytorch_model.bin -> ../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd
```

`local_dir` が指定されている場合、リポジトリのファイル構造がこの場所に複製されます。このオプションを使用すると、`cache_dir` は使用されず、`local_dir` のルートに `.cache/huggingface/` フォルダが作成され、ダウンロードされたファイルに関連する一部のメタデータが保存されます。この仕組みはメインのキャッシュシステムほど堅牢ではありませんが、リポジトリの最新バージョンを定期的に取得する用途に最適化されています。

#### hide_discussion_comment[[huggingface_hub.HfApi.hide_discussion_comment]]

```python
hide_discussion_comment(repo_id: str, discussion_num: int, comment_id: str, token: bool | str | None = None, repo_type: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7940)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

discussion_num (`int`) : Discussion または Pull Request の番号です。正の整数である必要があります。

comment_id (`str`) : 編集するコメントのID。

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [DiscussionComment](/docs/huggingface_hub/v2.4.0/ja/package_reference/community#huggingface_hub.DiscussionComment)

非表示のコメント

Discussion / Pull Request のコメントを非表示にします。

> [!WARNING]
> 非表示コメントの内容はもう取得できません。コメントの非表示は元に戻せません。

> [!TIP]
> 以下のエラーを発生させます：
>
> - HuggingFace APIがエラーを返した場合に[`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) - パラメータの値が無効な場合に[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) - ダウンロード元のリポジトリが見つからない場合に[RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)。存在しないか、`private`に設定されていてアクセス権限がないためです。

#### inspect_job[[huggingface_hub.HfApi.inspect_job]]

```python
inspect_job(job_id: str, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12563)

**パラメータ:**

job_id (`str`) : Job の ID。

namespace (`str`, *任意*) : Job が実行されている名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

Hugging Faceのインフラストラクチャ上で実行されているCompute Jobを検査します。

例:

```python
>>> from huggingface_hub import inspect_job, run_job
>>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"])
>>> inspect_job(job_id=job.id)
JobInfo(
    id='68780d00bbe36d38803f645f',
    created_at=datetime.datetime(2025, 7, 16, 20, 35, 12, 808000, tzinfo=datetime.timezone.utc),
    docker_image='python:3.12',
    space_id=None,
    command=['python', '-c', "print('Hello from HF compute!')"],
    arguments=[],
    environment={},
    secrets={},
    flavor='cpu-basic',
    status=JobStatus(stage='RUNNING', message=None)
)
```

#### inspect_scheduled_job[[huggingface_hub.HfApi.inspect_scheduled_job]]

```python
inspect_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13285)

**パラメータ:**

scheduled_job_id (`str`) : スケジュールされたJobのID。

namespace (`str`, *任意*) : スケジュールされた Job が存在する名前空間です。デフォルトでは、現在のユーザーの名前空間になります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

Hugging Faceのインフラストラクチャ上でスケジュールされた計算Jobを検査します。

例:

```python
>>> from huggingface_hub import inspect_scheduled_job, create_scheduled_job
>>> scheduled_job = create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], schedule="@hourly")
>>> inspect_scheduled_job(scheduled_job_id=scheduled_job.id)
```

#### kernel_info[[huggingface_hub.HfApi.kernel_info]]

```python
kernel_info(repo_id: str, revision: str | None = None, timeout: float | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3429)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

revision (`str`, *任意*) : カーネルリポジトリから情報を取得するためのリビジョン。

timeout (`float`, *任意*) : Hub へのリクエストにタイムアウトを設定するかどうか。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [ModelInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.ModelInfo)

カーネルリポジトリの情報。

huggingface.co上の特定の1つのカーネルに関する情報を取得します。

#### list_accepted_access_requests[[huggingface_hub.HfApi.list_accepted_access_requests]]

```python
list_accepted_access_requests(repo_id: str, repo_type: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10669)

**パラメータ:**

repo_id (`str`) : アクセスリクエストを取得するリポジトリのID。

repo_type (`str`, *任意*) : アクセスリクエストを取得するリポジトリの種類。`model`、`dataset`、または `space` のいずれかである必要があります。デフォルトは `model` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[AccessRequest]`

`AccessRequest`オブジェクトのイテラブルです。各アイテムには、`username`、`request_id`、`email`、`status`、`timestamp`という属性が含まれます。ゲート付きリポジトリにカスタムフォームがある場合、`fields`属性にはユーザーの回答が格納されます。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` -- リポジトリがゲート付きでない場合、HTTP 400 が返されます。
- `HfHubHTTPError` -- リポジトリへのアクセス権限が読み取り専用の場合、HTTP 403 が返されます。リポジトリが属する組織で `write` または `admin` のロールを持っていない場合、または `read` トークンを渡した場合に、この状況が発生します。

指定されたゲート付きリポジトリの承認済みアクセスリクエストを取得します。

承認されたリクエストとは、ユーザーがリポジトリへのアクセスをリクエストし、そのリクエストが承認されたことを意味します。ユーザーはリポジトリ内の任意のファイルをダウンロードできます。承認モードが自動の場合、このリストにはデフォルトですべてのリクエストが含まれる必要があります。承認されたリクエストは、[cancel_access_request()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.cancel_access_request) および [reject_access_request()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.reject_access_request) を使用して、いつでもキャンセルまたは拒否できます。キャンセルされたリクエストは保留リストに戻り、拒否されたリクエストは拒否リストに移動します。どちらの場合も、ユーザーはリポジトリへのアクセス権を失います。

ゲート付きリポジトリの詳細については、https://huggingface.co/docs/hub/models-gated を参照してください。

例:
```py
>>> from huggingface_hub import list_accepted_access_requests

>>> requests = list(list_accepted_access_requests("meta-llama/Llama-2-7b"))
>>> len(requests)
411
>>> requests[0]
[
    AccessRequest(
        username='clem',
        request_id='655f3a1c9e6b2d4f8a7c1e05',
        fullname='Clem 🤗',
        email='***',
        timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc),
        status='accepted',
        fields=None,
    ),
    ...
]
```

#### list_bucket_tree[[huggingface_hub.HfApi.list_bucket_tree]]

```python
list_bucket_tree(bucket_id: str, prefix: str | None = None, recursive: bool | None = None, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14301)

**パラメータ:**

bucket_id (`str`) : バケットのID（例: `"username/my-bucket"`）。

prefix (`str`, *任意*) : パスがこのプレフィックスで始まるファイルに結果を絞り込みます。

recursive (`bool`, *optional*) : `True`の場合、ファイルを再帰的に一覧表示します。`False`（デフォルト）の場合、ルートディレクトリ内のファイルとディレクトリのみを一覧表示します。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[Union[BucketFile, BucketFolder]]`

ファイルおよびディレクトリの情報（パスなど）を含む [BucketFile](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.BucketFile) および `BucketFolder` オブジェクトのイテラブル。

バケット内のファイルをリスト表示します。

例:
```python
>>> from huggingface_hub import list_bucket_tree
>>> for file_info in list_bucket_tree(bucket_id="username/my-bucket"):
...     print(file_info.path)

>>> # Filter by prefix
>>> for file_info in list_bucket_tree(bucket_id="username/my-bucket", prefix="models/"):
...     print(file_info.path)
```

#### list_buckets[[huggingface_hub.HfApi.list_buckets]]

```python
list_buckets(namespace: str | None = None, search: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14108)

**パラメータ:**

namespace (`str`, *省略可*) : この名前空間（ユーザーまたは組織）配下のバケットをリスト表示します。デフォルトでは、ユーザーのバケットをリスト表示します。

search (`str`, *任意*) : バケット名を絞り込むための検索文字列。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[BucketInfo]`

[BucketInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.BucketInfo)オブジェクトのイテラブル。

特定のネームスペースの下にあるHubのバケットをリスト表示します。

例:
```python
>>> from huggingface_hub import list_buckets
>>> for bucket in list_buckets(): # lists buckets in the user's namespace
...     print(bucket)

>>> for bucket in list_buckets(namespace="huggingface"): # lists buckets in the "huggingface" organization
...     print(bucket)

>>> for bucket in list_buckets(search="my-prefix"): # filter buckets by name
...     print(bucket)
```

#### list_collections[[huggingface_hub.HfApi.list_collections]]

```python
list_collections(owner: list[str] | str | None = None, item: list[str] | str | None = None, sort: CollectionSort_T | None = None, limit: int | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10096)

**パラメータ:**

owner (`list[str]` または `str`、*任意*) : オーナーのユーザー名でフィルタリングします。

item (`list[str]` または `str`、*任意*) : 特定のアイテムを含むコレクションをフィルタリングします。例: `"models/teknium/OpenHermes-2.5-Mistral-7B"`、`"datasets/squad"` または `"papers/2311.12983"`。

sort (`Literal["lastModified", "trending", "upvotes"]`, *任意*) : コレクションを最終更新日時、トレンド、またはアップボートの順にソートします。

limit (`int`, *任意*) : 返されるコレクションの最大数。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[Collection]`

[Collection](/docs/huggingface_hub/v2.4.0/ja/package_reference/collections#huggingface_hub.Collection)オブジェクトのイテラブル。

いくつかのフィルターを指定して、Huggingface Hub上のコレクションをリスト表示します。

> [!WARNING]
> コレクションをリスト表示する際、各コレクションのアイテムリストは最大4件に切り詰められます。コレクションのすべてのアイテムを取得するには、[get_collection()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.get_collection)を使用する必要があります。

#### list_daily_papers[[huggingface_hub.HfApi.list_daily_papers]]

```python
list_daily_papers(date: str | None = None, token: bool | str | None = None, week: str | None = None, month: str | None = None, submitter: str | None = None, sort: DailyPapersSort_T | None = None, p: int | None = None, limit: int | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11978)

**パラメータ:**

date (`str`, *任意*) : 日次ペーパーを取得する日付（ISO形式 YYYY-MM-DD）。デフォルトでは、最新のものが取得されます。

token (Union[bool, str, None], *任意*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。認証を無効にするには、`False`を渡します。

week (`str`, *任意*) : 日次論文を取得するISO形式の週 (YYYY-Www)。例: `2025-W09`。

month (`str`, *任意*) : 日次論文を取得する月（ISO形式 YYYY-MM）。例: `2025-02`。

submitter (`str`, *任意*) : 日次論文をフィルタリングするための提出者のユーザー名。

sort (`Literal["publishedAt", "trending"]`, *任意*) : 日次ペーパーのソート順。`publishedAt`または`trending`のいずれかです。デフォルトは`"publishedAt"`です。

p (`int`, *optional*) : ページネーション用のページ番号。デフォルトは 0 です。

limit (`int`, *optional*) : 取得する論文の上限数。デフォルトは50です。

**戻り値:** `Iterable[PaperInfo]`

`huggingface_hub.hf_api.PaperInfo`オブジェクトのイテラブルです。

Hugging Face Hubで指定した日に日に公開されたデイリーペーパーをリスト表示します。

例:

```python
>>> from huggingface_hub import HfApi

>>> api = HfApi()
>>> list(api.list_daily_papers(date="2025-10-29"))
```

#### list_dataset_parquet_files[[huggingface_hub.HfApi.list_dataset_parquet_files]]

```python
list_dataset_parquet_files(repo_id: str, config: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2707)

**パラメータ:**

repo_id (`str`) : データセットのリポジトリID（例: `"username/dataset-name"`）。

config (`str`, *任意*) : 特定の config/subset 名でフィルタリングします。指定した場合、その config に対応する parquet ファイルのみが返されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `list[DatasetParquetEntry]`

各 parquet ファイルの設定、スプリット、URL、サイズを含む`DatasetParquetEntry`オブジェクトのリスト。

Hub上のデータセットで利用可能なparquetファイルをリスト表示します。

Hub にホストされているすべてのデータセットは、[Dataset Viewer](https://huggingface.co/docs/dataset-viewer/parquet) によって自動的に Parquet に変換されます。このメソッドは、Parquet ファイルのリストを、その URL、config、split、サイズとともに返します。

例:
```python
>>> from huggingface_hub import list_dataset_parquet_files
>>> list_dataset_parquet_files("lhoestq/demo1")
>>> entries[0]
DatasetParquetEntry(config='default', split='train', url='https://huggingface.co/...', size=5038)
```

#### list_datasets[[huggingface_hub.HfApi.list_datasets]]

```python
list_datasets(filter: str | Iterable[str] | None = None, author: str | None = None, benchmark: Literal[True] | Literal['official'] | str | None = None, dataset_name: str | None = None, gated: bool | None = None, language_creators: str | list[str] | None = None, language: str | list[str] | None = None, multilinguality: str | list[str] | None = None, size_categories: str | list[str] | None = None, task_categories: str | list[str] | None = None, task_ids: str | list[str] | None = None, search: str | None = None, sort: DatasetSort_T | None = None, limit: int | None = None, expand: list[ExpandDatasetProperty_T] | None = None, full: bool | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2502)

**パラメータ:**

filter (`str` または `Iterable[str]`、*省略可能*) : Hub上のデータセットをフィルタリングするための文字列または文字列のリスト。

author (`str`, *任意*) : 返されるデータセットの作成者を識別する文字列。

benchmark (`True`, `"official"`, `str`, *任意*) : ベンチマークでデータセットをフィルタリングします。`True`または`"official"`を指定すると、公式のベンチマークデータセットが返されます。将来の互換性を考慮し、ベンチマーク名を表す文字列（現在サポートされているのは"official"のみ）を指定することもできます。

dataset_name (`str`, *任意*) : Hub上で `SQAC` や `wikineural` のような名前によってデータセットを識別するために使用できる文字列、または文字列のリスト

gated (`bool`, *optional*) : Hub上のデータセットがゲート付きかどうかでフィルタリングするためのブール値です。デフォルトでは、すべてのデータセットが返されます。`gated=True` が渡された場合、ゲート付きのデータセットのみが返されます。`gated=False` が渡された場合、ゲートなしのデータセットのみが返されます。

language_creators (`str` または `List`、*省略可能*) : Hub 上のデータセットを、データのキュレーション方法（`crowdsourced` や `machine_generated` など）で識別するために使用できる文字列または文字列のリスト。

language (`str` または `List`、*省略可能*) : Hub でデータセットを絞り込むための 2 文字の言語を表す文字列、または文字列のリスト。

multilinguality (`str` または `List`、*省略可能*) : 複数言語を含むデータセットに対するフィルタを表す文字列または文字列のリスト。

size_categories (`str` または `List`、*任意*) : データセットのサイズ（例: `100K<n<1M` または `1M<n<10M`）によって Hub 上のデータセットを識別するために使用できる文字列または文字列のリスト。

task_categories (`str` または `List`、*任意*) : `audio_classification` や `named_entity_recognition` のように、設計されたタスクによって Hub 上のデータセットを識別するために使用できる文字列または文字列のリスト。

task_ids (`str` または `List`、*省略可能*) : `speech_emotion_recognition` や `paraphrase` のような特定のタスクによって、Hub 上のデータセットを識別するために使用できる文字列または文字列のリスト。

search (`str`, *任意*) : 返されるデータセットに含まれる文字列。

sort (`DatasetSort_T`, *任意*) : 結果のデータセットをソートするためのキー。使用可能な値は "created_at"、"downloads"、"last_modified"、"likes"、"trending_score" です。

limit (`int`, *optional*) : 取得するデータセット数の上限です。このオプションを`None`にすると、すべてのデータセットが取得されます。

expand (`list[ExpandDatasetProperty_T]`, *任意*) : レスポンスで返すプロパティのリスト。指定した場合、リストに含まれるプロパティのみが返されます。`full` が渡されている場合は、このパラメーターを使用できません。指定可能な値は `"author"`、`"cardData"`、`"citation"`、`"createdAt"`、`"disabled"`、`"description"`、`"downloads"`、`"downloadsAllTime"`、`"gated"`、`"lastModified"`、`"likes"`、`"mainSize"`、`"paperswithcode_id"`、`"private"`、`"siblings"`、`"sha"`、`"tags"`、`"trendingScore"`、`"usedStorage"`、および `"resourceGroup"` です。

full (`bool`, *任意*) : `last_modified`、`card_data`、およびファイルを含む、すべてのデータセットデータを取得するかどうかを指定します。PapersWithCode ID などの有用な情報が含まれる場合があります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[DatasetInfo]`

[huggingface_hub.hf_api.DatasetInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.DatasetInfo)オブジェクトのイテラブルです。

いくつかのフィルターを指定して、Huggingface Hub にホストされているデータセットのリストを取得します。

`filter`引数を使った使用例:

```python
>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all datasets
>>> api.list_datasets()

# List only the text classification datasets
>>> api.list_datasets(filter="task_categories:text-classification")

# List only the datasets in russian for language modeling
>>> api.list_datasets(
...     filter=("language:ru", "task_ids:language-modeling")
... )

# List FiftyOne datasets (identified by the tag "fiftyone" in dataset card)
>>> api.list_datasets(filter="fiftyone")
```

`search`引数を使った使用例:

```python
>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all datasets with "text" in their name
>>> api.list_datasets(search="text")

# List all datasets with "text" in their name made by google
>>> api.list_datasets(search="text", author="google")
```

#### list_inference_catalog[[huggingface_hub.HfApi.list_inference_catalog]]

```python
list_inference_catalog(accelerator: Literal['cpu', 'gpu', 'neuron'] | str | None = None, engine: Literal['llamacpp', 'sglang', 'tei', 'vllm'] | str | None = None, license: str | None = None, task: str | None = None, search: str | None = None, limit: int | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9587)

**パラメータ:**

accelerator (`str`, *任意*) : このアクセラレーター（`"cpu"`、`"gpu"`または`"neuron"`）のレシピを持つモデルのみを返します。

engine (`str`, *任意*) : この推論エンジン用のレシピを持つモデルのみを返します（例: `"vllm"`、`"llamacpp"`、`"tei"`、`"sglang"`）。

license (`str`, *任意*) : このライセンス（例: `"Apache 2.0"`）の下にあるモデルのみを返します。

task (`str`, *任意*) : このタスク（例: `"text-generation"`）のモデルのみを返します。

search (`str`, *任意*) : この検索クエリに一致するモデルのみを返します。

limit (`int`, *任意*) : 返すモデルの最大数。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。

**戻り値:** `list[InferenceCatalogModel]`

カタログで利用可能なモデルと、それぞれにテスト済みのレシピ。

Hugging Face Inference Catalog で利用可能なモデルのリストを表示します。

Inference Catalogの目的は、推論用に最適化され、デフォルト設定がテスト済みのモデルの厳選リストを提供することです。カタログで利用可能なモデルのリストは、https://endpoints.huggingface.co/catalog をご覧ください。

カタログからモデルまたはレシピをデプロイするには、[create_inference_endpoint_from_catalog()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_inference_endpoint_from_catalog)を使用します。

例:
```python
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> catalog = api.list_inference_catalog(task="text-generation", accelerator="neuron")
>>> [(model.repo_id, [recipe.id for recipe in model.recipes]) for model in catalog]
[('meta-llama/Llama-3.1-8B-Instruct', ['sizzling-biryani-g4xsi1ac', 'artisanal-quinoa-yz9ynamx']), ...]
```

> [!WARNING]
> `list_inference_catalog` は実験的な機能です。将来、API が変更される可能性があります。ご意見やご要望がございましたら、フィードバックをお寄せください。

#### list_inference_endpoints[[huggingface_hub.HfApi.list_inference_endpoints]]

```python
list_inference_endpoints(namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9147)

**パラメータ:**

namespace (`str`, *任意*) : エンドポイントをリスト表示する名前空間です。デフォルトでは現在のユーザーが設定されます。`"*"`に設定すると、すべての名前空間（つまり、個人の名前空間とユーザーが所属するすべての組織）のエンドポイントをリスト表示します。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** list[InferenceEndpoint](/docs/huggingface_hub/v2.4.0/ja/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint)

指定された名前空間のすべての推論エンドポイントのリスト。

指定された名前空間のすべての推論エンドポイントをリストします。

例:
```python
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.list_inference_endpoints()
[InferenceEndpoint(name='my-endpoint', ...), ...]
```

#### list_inference_endpoints_hardware[[huggingface_hub.HfApi.list_inference_endpoints_hardware]]

```python
list_inference_endpoints_hardware(namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10038)

**パラメータ:**

namespace (`str`, *任意*) : 利用可能なハードウェアとアクセラレーターのクォータをリスト表示する名前空間。デフォルトでは現在のユーザーが使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。

**戻り値:** `list[InferenceEndpointHardware]`

すべてのベンダーとリージョンで利用可能なハードウェア（現在利用できないものや非推奨とされているものを含む）。

Inference Endpoint のデプロイに使用できるハードウェアをリスト表示します。

各エントリには、[create_inference_endpoint()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_inference_endpoint)が期待する`vendor`、`region`、`accelerator`、`instance_type`、`instance_size`の正確な値に加えて、価格とネームスペースのアクセラレータ割当が含まれています。

例:
```python
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> hardware = api.list_inference_endpoints_hardware()
>>> [hw.id for hw in hardware if hw.accelerator == "gpu" and hw.status == "available"]
['aws-us-east-1-nvidia-l4-x1', 'aws-us-east-1-nvidia-l4-x4', ...]
```

#### list_jobs[[huggingface_hub.HfApi.list_jobs]]

```python
list_jobs(status: list[JobStage | str] | JobStage | str | None = None, labels: dict[str, str] | None = None, timeout: int | None = None, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12487)

**パラメータ:**

status (`JobStage`、`str`または`list`、*省略可能*) : 指定されたステータス（例: `"RUNNING"`または`[JobStage.RUNNING, JobStage.SCHEDULING]`）を持つJobのみを返します。可能な値については、[JobStage](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.JobStage)を参照してください。

labels (`dict[str, str]`、*任意*) : 指定されたすべての`key=value`ラベルを持つJobsのみを返します。例: `{"env": "prod", "team": "ml"}`。

timeout (`float`, *任意*) : Hub へのリクエストにタイムアウトを設定するかどうか。

namespace (`str`, *任意*) : ジョブを列挙するネームスペース。デフォルトでは、現在のユーザーのネームスペースが使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

**戻り値:** `Iterable[JobInfo]`

[JobInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.JobInfo)オブジェクトのイテラブル。

Hugging Faceのインフラストラクチャ上で計算ジョブをリスト表示します。

#### list_jobs_hardware[[huggingface_hub.HfApi.list_jobs_hardware]]

```python
list_jobs_hardware(token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12535)

**戻り値:** `list[JobHardwareInfo]`

利用可能なハードウェア構成のリスト。

Hugging Face のインフラストラクチャ上で、Jobs に利用可能なハードウェアオプションをリスト表示します。

例:

```python
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> hardware_list = api.list_jobs_hardware()
>>> hardware_list[0]
JobHardwareInfo(name='cpu-basic', pretty_name='CPU Basic', cpu='2 vCPU', ram='16 GB', ephemeral_storage='20 GB', accelerator=None, unit_cost_micro_usd=167, unit_cost_usd=0.000167, unit_label='minute')
>>> hardware_list[0].name
'cpu-basic'

# Filter GPU options
>>> gpu_hardware = [hw for hw in hardware_list if hw.accelerator is not None]
>>> gpu_hardware[0].accelerator.model
'T4'
```

#### list_lfs_files[[huggingface_hub.HfApi.list_lfs_files]]

```python
list_lfs_files(repo_id: str, repo_type: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4426)

**パラメータ:**

repo_id (`str`) : LFS ファイルのリストを取得するリポジトリ。

repo_type (`str`, *任意*) : リポジトリの種類。データセットまたはスペースから一覧を取得する場合は `"dataset"` または `"space"`、モデルから一覧を取得する場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[LFSFileInfo]`

`LFSFileInfo`オブジェクトのイテレータ。

Hub上のリポジトリ内のすべてのLFSファイルをリスト表示します。

これは主に、リポジトリが使用しているストレージ量をカウントし、最終的に[permanently_delete_lfs_files()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.permanently_delete_lfs_files)を使用して大きなファイルをクリーンアップするために有用です。この操作は恒久的であり、削除されたファイルを参照するすべてのコミットに影響を及ぼし、元に戻すことはできません。

例:
```py
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> lfs_files = api.list_lfs_files("username/my-cool-repo")

# Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`.
# e.g. select only LFS files in the "checkpoints" folder
>>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/"))

# Permanently delete LFS files
>>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete)
```

#### list_liked_repos[[huggingface_hub.HfApi.list_liked_repos]]

```python
list_liked_repos(user: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2988)

**パラメータ:**

user (`str`, *任意*) : ライクを取得したいユーザーの名前。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [UserLikes](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.UserLikes)

ユーザー名と、リポジトリIDの3つのリスト（モデル用1つ、データセット用1つ、Spaces用1つ）を含むオブジェクト。

**例外:** ``ValueError``

- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- `user` が渡されず、トークンが見つからない場合（引数からでも、マシンからでも）。

huggingface.coでユーザーが「いいね」したすべての公開リポジトリをリスト表示します。

このリストは公開されているため、トークンは省略可能です。`user`が指定されない場合、デフォルトでログイン中のユーザーが使用されます。

また、[unlike()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.unlike)も参照してください。

例:
```python
>>> from huggingface_hub import list_liked_repos

>>> likes = list_liked_repos("julien-c")

>>> likes.user
"julien-c"

>>> likes.models
["osanseviero/streamlit_1.15", "Xhaheen/ChatGPT_HF", ...]
```

#### list_models[[huggingface_hub.HfApi.list_models]]

```python
list_models(filter: str | Iterable[str] | None = None, author: str | None = None, apps: str | list[str] | None = None, gated: bool | None = None, inference: Literal['warm'] | None = None, inference_provider: Literal['all'] | PROVIDER_T | list[PROVIDER_T] | None = None, trained_dataset: str | list[str] | None = None, search: str | None = None, pipeline_tag: str | None = None, num_parameters: str | None = None, emissions_thresholds: tuple[float, float] | None = None, sort: ModelSort_T | None = None, limit: int | None = None, expand: list[ExpandModelProperty_T] | None = None, full: bool | None = None, cardData: bool = False, fetch_config: bool = False, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2310)

**パラメータ:**

filter (`str` または `Iterable[str]`、*省略可能*) : Hub 上のモデルをフィルタリングするための文字列または文字列のリストです。モデルは、ライブラリ、言語、タスク、タグなどによってフィルタリングできます。

author (`str`, *任意*) : 返されるモデルの作成者（ユーザーまたは組織）を識別する文字列。

apps (`str` または `List`、*省略可能*) : Hub上で指定されたアプリをサポートするモデルをフィルタリングするための文字列または文字列のリストです。例として、`"ollama"` や `["ollama", "vllm"]` などが挙げられます。

gated (`bool`, *任意*) : Hub上のモデルがゲート付きかどうかでフィルタリングするためのブール値です。デフォルトでは、すべてのモデルが返されます。`gated=True` が渡された場合、ゲート付きのモデルのみが返されます。`gated=False` が渡された場合、ゲートなしのモデルのみが返されます。

inference (`Literal["warm"]`, *任意*) : "warm" の場合、Hub 上で現在少なくとも 1 つのプロバイダーによって提供されているモデルをフィルタリングします。

inference_provider (`Literal["all"]` または `str`、*任意*) : Hub 上で特定のプロバイダーによって提供されているモデルをフィルタリングするための文字列です。少なくとも 1 つのプロバイダーによって提供されているすべてのモデルを取得するには、`"all"` を渡します。

trained_dataset (`str` または `List`、*省略可能*) : Hub 上のモデルの学習済みデータセットの文字列タグ、または文字列タグのリスト。

search (`str`, *任意*) : 返されるモデルIDに含まれる文字列。

pipeline_tag (`str`, *任意*) : Hub上でモデルを絞り込むための文字列のパイプラインタグ。例: `summarization`

num_parameters (`str`, *任意*) : パラメータ数でモデルをフィルタリングします。Hub UIおよびAPIと同じ範囲構文を受け付けます。例えば `"min:6B,max:128B"`、`"min:6B"` または `"max:128B"` などです。

emissions_thresholds (`Tuple`, *任意*) : 最小値と最大値を表す2つのintまたはfloatのタプル。結果として得られるモデルをグラム単位でフィルタリングするために使用します。

sort (`ModelSort_T`, *任意*) : 結果として得られるモデルをソートするためのキー。使用可能な値は "created_at"、"downloads"、"last_modified"、"likes"、"trending_score" です。

limit (`int`, *optional*) : 取得するモデル数の上限です。このオプションを`None`にすると、すべてのモデルが取得されます。

expand (`list[ExpandModelProperty_T]`, *任意*) : レスポンスで返すプロパティのリストです。指定した場合、リストに含まれるプロパティのみが返されます。このパラメータは、`full`、`cardData`、または `fetch_config` が渡されている場合は使用できません。指定可能な値は、`"author"`、`"cardData"`、`"config"`、`"createdAt"`、`"disabled"`、`"downloads"`、`"downloadsAllTime"`、`"evalResults"`、`"gated"`、`"gguf"`、`"inference"`、`"inferenceProviderMapping"`、`"lastModified"`、`"library_name"`、`"likes"`、`"mask_token"`、`"model-index"`、`"pipeline_tag"`、`"private"`、`"safetensors"`、`"sha"`、`"siblings"`、`"spaces"`、`"tags"`、`"transformersInfo"`、`"trendingScore"`、`"widgetData"`、および `"resourceGroup"` です。

full (`bool`, *任意*) : `last_modified`、`sha`、ファイル、`tags`を含むすべてのモデルデータを取得するかどうか。フィルタを使用する場合、デフォルトでは`True`に設定されます。

cardData (`bool`, *任意*) : モデルのメタデータも取得するかどうか。炭素排出量、メトリクス、学習に使用されたデータセットなど、有用な情報が含まれる場合があります。

fetch_config (`bool`, *任意*) : モデルの構成も取得するかどうか。`full` にはサイズが大きいため含まれていません。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[ModelInfo]`

[huggingface_hub.hf_api.ModelInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.ModelInfo)オブジェクトのイテラブルです。

いくつかのフィルターを指定して、Huggingface Hub にホストされているモデルのリストを取得します。

例:

```python
>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all models
>>> api.list_models()

# List text classification models
>>> api.list_models(filter="text-classification")

# List models from the KerasHub library
>>> api.list_models(filter="keras-hub")

# List models served by Cohere
>>> api.list_models(inference_provider="cohere")

# List models with "bert" in their name
>>> api.list_models(search="bert")

# List models with "bert" in their name and pushed by google
>>> api.list_models(search="bert", author="google")

# List models with 6B to 128B parameters
>>> api.list_models(num_parameters="min:6B,max:128B", sort="likes")
```

#### list_organization_followers[[huggingface_hub.HfApi.list_organization_followers]]

```python
list_organization_followers(organization: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11774)

**パラメータ:**

organization (`str`) : フォロー者を取得する組織の名前。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[User]`

組織のフォロワーの[User](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.User)オブジェクトのリスト。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` -- 組織が Hub に存在しない場合、HTTP 404 が返されます。

Hub上の組織のフォロワーをリスト表示します。

#### list_organization_members[[huggingface_hub.HfApi.list_organization_members]]

```python
list_organization_members(organization: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11803)

**パラメータ:**

organization (`str`) : メンバーを取得する組織の名前。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[User]`

組織のメンバーを含む[User](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.User)オブジェクトのリスト。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` -- 組織が Hub に存在しない場合、HTTP 404 が返されます。

Hub上の組織のメンバーの一覧。

#### list_papers[[huggingface_hub.HfApi.list_papers]]

```python
list_papers(query: str | None = None, limit: int | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11887)

**パラメータ:**

query (`str`, *任意*) : 論文を検索するためのクエリ文字列です。指定された場合、クエリに一致する論文が返されます。

limit (`int`, *任意*) : 返す論文の最大数。

token (Union[bool, str, None], *任意*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[PaperInfo]`

`huggingface_hub.hf_api.PaperInfo`オブジェクトのイテラブルです。

検索クエリを指定して、Hugging Face Hub上の日次ペーパーのリストを取得します。

例:

```python
>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all papers with "attention" in their title
>>> api.list_papers(query="attention")
```

#### list_pending_access_requests[[huggingface_hub.HfApi.list_pending_access_requests]]

```python
list_pending_access_requests(repo_id: str, repo_type: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10604)

**パラメータ:**

repo_id (`str`) : アクセスリクエストを取得するリポジトリのID。

repo_type (`str`, *任意*) : アクセスリクエストを取得するリポジトリの種類。`model`、`dataset`、または `space` のいずれかである必要があります。デフォルトは `model` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[AccessRequest]`

`AccessRequest`オブジェクトのイテラブルです。各アイテムには、`username`、`request_id`、`email`、`status`、`timestamp`という属性が含まれます。ゲート付きリポジトリにカスタムフォームがある場合、`fields`属性にはユーザーの回答が格納されます。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` -- リポジトリがゲート付きでない場合、HTTP 400 が返されます。
- `HfHubHTTPError` -- リポジトリへのアクセス権限が読み取り専用の場合、HTTP 403 が返されます。リポジトリが属する組織で `write` または `admin` のロールを持っていない場合、または `read` トークンを渡した場合に、この状況が発生します。

指定されたゲート付きリポジトリの保留中のアクセスリクエストを取得します。

保留中のリクエストとは、ユーザーがリポジトリへのアクセスを要求したものの、まだ処理されていない状態を指します。承認モードが自動の場合、このリストは空であるはずです。保留中のリクエストは、[accept_access_request()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.accept_access_request) および [reject_access_request()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.reject_access_request) を使用して承認または拒否できます。

ゲート付きリポジトリの詳細については、https://huggingface.co/docs/hub/models-gated を参照してください。

例:
```py
>>> from huggingface_hub import list_pending_access_requests, accept_access_request

# List pending requests
>>> requests = list(list_pending_access_requests("meta-llama/Llama-2-7b"))
>>> len(requests)
411
>>> requests[0]
[
    AccessRequest(
        username='clem',
        request_id='655f3a1c9e6b2d4f8a7c1e05',
        fullname='Clem 🤗',
        email='***',
        timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc),
        status='pending',
        fields=None,
    ),
    ...
]

# Accept Clem's request
>>> accept_access_request("meta-llama/Llama-2-7b", "clem")
```

#### list_rejected_access_requests[[huggingface_hub.HfApi.list_rejected_access_requests]]

```python
list_rejected_access_requests(repo_id: str, repo_type: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10732)

**パラメータ:**

repo_id (`str`) : アクセスリクエストを取得するリポジトリのID。

repo_type (`str`, *任意*) : アクセスリクエストを取得するリポジトリの種類。`model`、`dataset`、または `space` のいずれかである必要があります。デフォルトは `model` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[AccessRequest]`

`AccessRequest`オブジェクトのイテラブルです。各アイテムには、`username`、`request_id`、`email`、`status`、`timestamp`という属性が含まれます。ゲート付きリポジトリにカスタムフォームがある場合、`fields`属性にはユーザーの回答が格納されます。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` -- リポジトリがゲート付きでない場合、HTTP 400 が返されます。
- `HfHubHTTPError` -- リポジトリへのアクセス権限が読み取り専用の場合、HTTP 403 が返されます。リポジトリが属する組織で `write` または `admin` のロールを持っていない場合、または `read` トークンを渡した場合に、この状況が発生します。

指定されたゲート付きリポジトリの拒否されたアクセスリクエストを取得します。

リクエストが拒否された場合、ユーザーがリポジトリへのアクセスを要求し、そのリクエストがリポジトリのオーナー（あなたまたは組織内の他のユーザー）によって明示的に拒否されたことを意味します。ユーザーはリポジトリのファイルをダウンロードできません。拒否されたリクエストは、[accept_access_request()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.accept_access_request) および [cancel_access_request()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.cancel_access_request) を使用して、いつでも承認またはキャンセルできます。キャンセルされたリクエストは保留リストに戻り、承認されたリクエストは承認リストに移動します。

ゲート付きリポジトリの詳細については、https://huggingface.co/docs/hub/models-gated を参照してください。

例:
```py
>>> from huggingface_hub import list_rejected_access_requests

>>> requests = list(list_rejected_access_requests("meta-llama/Llama-2-7b"))
>>> len(requests)
411
>>> requests[0]
[
    AccessRequest(
        username='clem',
        request_id='655f3a1c9e6b2d4f8a7c1e05',
        fullname='Clem 🤗',
        email='***',
        timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc),
        status='rejected',
        fields=None,
    ),
    ...
]
```

#### list_repo_commits[[huggingface_hub.HfApi.list_repo_commits]]

```python
list_repo_commits(repo_id: str, repo_type: str | None = None, token: bool | str | None = None, revision: str | None = None, formatted: bool = False)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4183)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

repo_type (`str`, *任意*) : データセットまたはSpaceのコミットをリストする場合は`"dataset"`または`"space"`、モデルからリストする場合は`None`または`"model"`に設定します。デフォルトは`None`です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

revision (`str`, *任意*) : コミット元の git リビジョンです。`"main"` ブランチのヘッドがデフォルトです。

formatted (`bool`) : コミットのHTML形式のタイトルと説明を返すかどうか。デフォルトはFalseです。

**戻り値:** list[[GitCommitInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.GitCommitInfo)]

Hub上のリポジトリのコミットに関する情報を含むオブジェクトのリスト。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- リポジトリが見つからない場合（エラー 404）: repo_id/repo_type が誤っている、プライベートリポジトリだが認証されていない、またはリポジトリが存在しない。
- [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- リポジトリ上でリビジョンが見つからない場合（エラー 404）。

Hub上のリポジトリの指定されたリビジョンのコミット一覧を取得します。

コミットは日付順に並べ替えられます（最新のコミットが先頭）。

例:
```py
>>> from huggingface_hub import HfApi
>>> api = HfApi()

# Commits are sorted by date (last commit first)
>>> initial_commit = api.list_repo_commits("gpt2")[-1]

# Initial commit is always a system commit containing the `.gitattributes` file.
>>> initial_commit
GitCommitInfo(
    commit_id='9b865efde13a30c13e0a33e536cf3e4a5a9d71d8',
    authors=['system'],
    created_at=datetime.datetime(2019, 2, 18, 10, 36, 15, tzinfo=datetime.timezone.utc),
    title='initial commit',
    message='',
    formatted_title=None,
    formatted_message=None
)

# Create an empty branch by deriving from initial commit
>>> api.create_branch("gpt2", branch="new_empty_branch", revision=initial_commit.commit_id)
```

#### list_repo_files[[huggingface_hub.HfApi.list_repo_files]]

```python
list_repo_files(repo_id: str, revision: str | None = None, repo_type: str | None = None, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3829)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

revision (`str`, *任意*) : 情報を取得するリポジトリのリビジョン。

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `list[str]`

指定されたリポジトリ内のファイルのリスト

指定されたリポジトリ内のファイルのリストを取得します。

#### list_repo_likers[[huggingface_hub.HfApi.list_repo_likers]]

```python
list_repo_likers(repo_id: str, repo_type: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3105)

**パラメータ:**

repo_id (`str`) : 取得するリポジトリ。例: `"user/my-cool-model"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

**戻り値:** `Iterable[User]`

[huggingface_hub.hf_api.User](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.User)オブジェクトのイテラブルです。

Hugging Face Hub上の特定のリポジトリに「いいね」をつけたすべてのユーザーをリスト表示します。

また、[list_liked_repos()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_liked_repos)も参照してください。

#### list_repo_refs[[huggingface_hub.HfApi.list_repo_refs]]

```python
list_repo_refs(repo_id: str, repo_type: str | None = None, include_pull_requests: bool = False, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4111)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

repo_type (`str`, *任意*) : dataset、Space、Kernel の refs を一覧表示する場合は `"dataset"`、`"space"`、`"kernel"` を、model から一覧表示する場合は `None` または `"model"` を設定します。デフォルトは `None` です。

include_pull_requests (`bool`, *任意*) : リストにプルリクエストの参照を含めるかどうか。デフォルトは`False`です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [GitRefs](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.GitRefs)

Hub上のリポジトリのブランチとタグに関するすべての情報を含むオブジェクト。

指定されたリポジトリのrefs（タグとブランチ）のリストを取得します。

例:
```py
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.list_repo_refs("gpt2")
GitRefs(branches=[GitRefInfo(name='main', ref='refs/heads/main', target_commit='e7da7f221d5bf496a48136c0cd264e630fe9fcc8')], converts=[], tags=[])

>>> api.list_repo_refs("bigcode/the-stack", repo_type='dataset')
GitRefs(
    branches=[
        GitRefInfo(name='main', ref='refs/heads/main', target_commit='18edc1591d9ce72aa82f56c4431b3c969b210ae3'),
        GitRefInfo(name='v1.1.a1', ref='refs/heads/v1.1.a1', target_commit='f9826b862d1567f3822d3d25649b0d6d22ace714')
    ],
    converts=[],
    tags=[
        GitRefInfo(name='v1.0', ref='refs/tags/v1.0', target_commit='c37a8cd1e382064d8aced5e05543c5f7753834da')
    ]
)
```

#### list_repo_tree[[huggingface_hub.HfApi.list_repo_tree]]

```python
list_repo_tree(repo_id: str, path_in_repo: str | None = None, recursive: bool = False, expand: bool = False, revision: str | None = None, repo_type: str | None = None, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3866)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

path_in_repo (`str`, *任意*) : リポジトリ内のツリー（フォルダ）の相対パス。例: `"checkpoints/1fec34a/results"`。デフォルトでは、リポジトリのルートツリー（フォルダ）になります。

recursive (`bool`、*任意*、デフォルトは`False`) : ツリーのファイルとフォルダを再帰的に一覧表示するかどうか。

expand (`bool`、*任意*、デフォルトは`False`) : ツリーのファイルやフォルダーに関する追加情報（最終コミットやファイルのセキュリティスキャン結果など）を取得するかどうかを指定します。この操作はサーバーにとってコストが高いため、1ページあたりの返却結果は50件（1000件ではなく）に制限されます。`huggingface_hub`ではページネーションが実装されているため、結果を取得するまでの時間がかかる点を除けば、ユーザーには透過的です。

revision (`str`, *任意*) : ツリーを取得するリポジトリのリビジョン。デフォルトは`"main"`ブランチです。

repo_type (`str`, *任意*) : ツリーを取得するリポジトリのタイプ (`"model"`、`"dataset"`、`"space"` または `"kernel"`)。デフォルトは `"model"` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[Union[RepoFile, RepoFolder]]`

ツリーのファイルとフォルダに関する情報。[RepoFile](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.RepoFile)オブジェクトと`RepoFolder`オブジェクトのイテラブルです。ファイルとフォルダの順序は保証されません。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) または `~utils.RemoteEntryNotFoundError`

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- リポジトリが見つからない場合（エラー 404）: repo_id/repo_type が誤っている、プライベートリポジトリだが認証されていない、またはリポジトリが存在しない。
- [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- リポジトリ上でリビジョンが見つからない場合（エラー 404）。
- `~utils.RemoteEntryNotFoundError` -- リポジトリ上にツリー（フォルダ）が存在しない場合（エラー 404）。

リポジトリツリーのファイルとフォルダーをリスト表示し、それらの情報取得

例:

リポジトリのツリーに関する情報を取得します。

```py
>>> from huggingface_hub import list_repo_tree
>>> repo_tree = list_repo_tree("lysandre/arxiv-nlp")
>>> repo_tree
<generator object HfApi.list_repo_tree at 0x7fa4088e1ac0>
>>> list(repo_tree)
[
    RepoFile(path='.gitattributes', size=391, blob_id='ae8c63daedbd4206d7d40126955d4e6ab1c80f8f', lfs=None, last_commit=None, security=None),
    RepoFile(path='README.md', size=391, blob_id='43bd404b159de6fba7c2f4d3264347668d43af25', lfs=None, last_commit=None, security=None),
    RepoFile(path='config.json', size=554, blob_id='2f9618c3a19b9a61add74f70bfb121335aeef666', lfs=None, last_commit=None, security=None),
    RepoFile(
        path='flax_model.msgpack', size=497764107, blob_id='8095a62ccb4d806da7666fcda07467e2d150218e',
        lfs={'size': 497764107, 'sha256': 'd88b0d6a6ff9c3f8151f9d3228f57092aaea997f09af009eefd7373a77b5abb9', 'pointer_size': 134}, last_commit=None, security=None
    ),
    RepoFile(path='merges.txt', size=456318, blob_id='226b0752cac7789c48f0cb3ec53eda48b7be36cc', lfs=None, last_commit=None, security=None),
    RepoFile(
        path='pytorch_model.bin', size=548123560, blob_id='64eaa9c526867e404b68f2c5d66fd78e27026523',
        lfs={'size': 548123560, 'sha256': '9be78edb5b928eba33aa88f431551348f7466ba9f5ef3daf1d552398722a5436', 'pointer_size': 134}, last_commit=None, security=None
    ),
    RepoFile(path='vocab.json', size=898669, blob_id='b00361fece0387ca34b4b8b8539ed830d644dbeb', lfs=None, last_commit=None, security=None)]
]
```

リポジトリのツリーに関するさらなる情報（最終コミットとファイルのセキュリティスキャン結果）を取得します

```py
>>> from huggingface_hub import list_repo_tree
>>> repo_tree = list_repo_tree("prompthero/openjourney-v4", expand=True)
>>> list(repo_tree)
[
    RepoFolder(
        path='feature_extractor',
        tree_id='aa536c4ea18073388b5b0bc791057a7296a00398',
        last_commit={
            'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190',
            'title': 'Upload diffusers weights (#48)',
            'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc)
        }
    ),
    RepoFolder(
        path='safety_checker',
        tree_id='65aef9d787e5557373fdf714d6c34d4fcdd70440',
        last_commit={
            'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190',
            'title': 'Upload diffusers weights (#48)',
            'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc)
        }
    ),
    RepoFile(
        path='model_index.json',
        size=582,
        blob_id='d3d7c1e8c3e78eeb1640b8e2041ee256e24c9ee1',
        lfs=None,
        last_commit={
            'oid': 'b195ed2d503f3eb29637050a886d77bd81d35f0e',
            'title': 'Fix deprecation warning by changing `CLIPFeatureExtractor` to `CLIPImageProcessor`. (#54)',
            'date': datetime.datetime(2023, 5, 15, 21, 41, 59, tzinfo=datetime.timezone.utc)
        },
        security={
            'safe': True,
            'av_scan': {'virusFound': False, 'virusNames': None},
            'pickle_import_scan': None
        }
    )
    ...
]
```

#### list_scheduled_jobs[[huggingface_hub.HfApi.list_scheduled_jobs]]

```python
list_scheduled_jobs(labels: dict[str, str] | None = None, timeout: int | None = None, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13231)

**パラメータ:**

labels (`dict[str, str]`, *任意*) : 指定された `key=value` のラベルをすべて持つスケジュール済み Job のみを返します。例: `{"env": "prod", "team": "ml"}`。

timeout (`float`, *任意*) : Hub へのリクエストにタイムアウトを設定するかどうか。

namespace (`str`, *任意*) : ジョブを列挙するネームスペース。デフォルトでは、現在のユーザーのネームスペースが使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

**戻り値:** `list[ScheduledJobInfo]`

`ScheduledJobInfo`オブジェクトのリスト。

Hugging Face のインフラストラクチャ上でスケジュールされた compute Jobs を一覧表示します。

#### list_space_templates[[huggingface_hub.HfApi.list_space_templates]]

```python
list_space_templates(token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4548)

**パラメータ:**

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `list[SpaceTemplate]`

利用可能なSpaceテンプレートのリスト。

Hubで利用可能な公式Spaceテンプレートのリストを表示します。

返されたテンプレートの`repo_id`(またはその短縮名`name`)を`space_template`として[HfApi.create_repo()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_repo)に渡すことで、そのテンプレートから新しいSpaceを初期化できます。

例:
```py
>>> from huggingface_hub import list_space_templates
>>> templates = list_space_templates()
>>> templates[0]
SpaceTemplate(name='Streamlit', repo_id='streamlit/streamlit-template-space', sdk='docker', preferred_private=False)
```

#### list_spaces[[huggingface_hub.HfApi.list_spaces]]

```python
list_spaces(filter: str | Iterable[str] | None = None, author: str | None = None, search: str | None = None, datasets: str | Iterable[str] | None = None, models: str | Iterable[str] | None = None, linked: bool = False, sort: SpaceSort_T | None = None, limit: int | None = None, expand: list[ExpandSpaceProperty_T] | None = None, full: bool | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2774)

**パラメータ:**

filter (`str` または `Iterable`、*省略可*) : Hub 上の Spaces を識別するために使用できる文字列タグまたはタグのリスト。

author (`str`, *任意*) : 返される Spaces の作成者を識別する文字列。

search (`str`, *任意*) : 返される Spaces に含まれる文字列。

datasets (`str` または `Iterable`、*省略可能*) : データセットを利用する Spaces を返すかどうかを指定します。特定のデータセットの名前を文字列として渡すことができます。

models (`str` または `Iterable`、*省略可能*) : モデルを利用する Spaces を返すかどうかを指定します。特定のモデル名を文字列として渡すことができます。

linked (`bool`, *任意*) : モデルまたはデータセットのいずれかを利用する Spaces を返すかどうかを指定します。

sort (`SpaceSort_T`, *任意*) : 結果のスペースをソートするためのキー。使用可能な値は "created_at"、"last_modified"、"likes"、"trending_score" です。

limit (`int`, *optional*) : 取得する Spaces の数に設定する上限です。このオプションを `None` にすると、すべての Spaces が取得されます。

expand (`list[ExpandSpaceProperty_T]`, *optional*) : レスポンスで返すプロパティのリストです。指定した場合、リストに含まれるプロパティのみが返されます。`full` が渡されている場合は、このパラメーターを使用できません。指定可能な値は `"author"`、`"cardData"`、`"datasets"`、`"disabled"`、`"lastModified"`、`"createdAt"`、`"likes"`、`"models"`、`"private"`、`"region"`、`"runtime"`、`"sdk"`、`"siblings"`、`"sha"`、`"subdomain"`、`"tags"`、`"trendingScore"`、`"usedStorage"`、および `"resourceGroup"` です。

full (`bool`, *任意*) : `last_modified`、`siblings`、`card_data` フィールドを含むすべての Spaces データを取得するかどうか。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[SpaceInfo]`

[huggingface_hub.hf_api.SpaceInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.SpaceInfo)オブジェクトのイテラブルです。

いくつかのフィルターを指定して、Huggingface Hub にホストされているスペースのリストを取得します。

#### list_spaces_hardware[[huggingface_hub.HfApi.list_spaces_hardware]]

```python
list_spaces_hardware(token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8260)

**戻り値:** `list[JobHardwareInfo]`

利用可能なハードウェア構成のリスト。

Spacesで利用可能なハードウェアオプションをリスト表示します。

例:

```python
>>> from huggingface_hub import list_spaces_hardware
>>> hardware_list = list_spaces_hardware()
>>> hardware_list[0]
JobHardwareInfo(name='cpu-basic', pretty_name='CPU Basic', cpu='2 vCPU', ram='16 GB', ...)
>>> hardware_list[0].name
'cpu-basic'
```

#### list_user_followers[[huggingface_hub.HfApi.list_user_followers]]

```python
list_user_followers(username: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11831)

**パラメータ:**

username (`str`) : フォロー者を取得するユーザーのユーザー名。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[User]`

ユーザーのフォロワーを含む[User](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.User)オブジェクトのリスト。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` -- ユーザーが Hub に存在しない場合、HTTP 404 が返されます。

Hub上のユーザーのフォロワーのリストを取得します。

#### list_user_following[[huggingface_hub.HfApi.list_user_following]]

```python
list_user_following(username: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11859)

**パラメータ:**

username (`str`) : フォローしているユーザーを取得する対象のユーザー名。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[User]`

そのユーザーがフォローしているユーザーの[User](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.User)オブジェクトのリスト。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` -- ユーザーが Hub に存在しない場合、HTTP 404 が返されます。

Hub上でユーザーがフォローしているユーザーのリストを取得します。

#### list_user_repos[[huggingface_hub.HfApi.list_user_repos]]

```python
list_user_repos(namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3065)

**パラメータ:**

namespace (`str`, *任意*) : 組織名。指定しない場合、認証済みユーザーのリポジトリをリスト表示します。

token (`bool`または`str`、*省略可能*) : 有効なユーザーアクセストークン。デフォルトでは、ローカルに保存されたトークンが使用されます。

**戻り値:** `Iterable[RepoStorageInfo]`

`RepoStorageInfo`オブジェクトのイテラブル。

ストレージ情報付きで、ユーザーまたは組織のすべてのリポジトリ（モデル、データセット、スペース、バケット）をリスト表示します。

認証済みユーザーには`/api/settings/repositories`エンドポイント、組織には`/api/organizations/{namespace}/settings/repositories`エンドポイントを使用します。

例:
```python
>>> from huggingface_hub import list_user_repos

>>> repos = list(list_user_repos())
>>> repos[0]
RepoStorageInfo(id='username/my-model', type='model', ...)

>>> # List repos from an organization
>>> repos = list(list_user_repos(namespace="my-org"))
```

#### list_webhooks[[huggingface_hub.HfApi.list_webhooks]]

```python
list_webhooks(token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11125)

**パラメータ:**

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `list[WebhookInfo]`

Webhook情報オブジェクトのリスト。

設定済みのすべてのWebhookをリスト表示します。

例:
```python
>>> from huggingface_hub import list_webhooks
>>> webhooks = list_webhooks()
>>> len(webhooks)
2
>>> webhooks[0]
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    secret="my-secret",
    domains=["repo", "discussion"],
    disabled=False,
)
```

#### merge_pull_request[[huggingface_hub.HfApi.merge_pull_request]]

```python
merge_pull_request(repo_id: str, discussion_num: int, token: bool | str | None = None, comment: str | None = None, repo_type: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7830)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

discussion_num (`int`) : Discussion または Pull Request の番号です。正の整数である必要があります。

comment (`str`, *任意*) : ステータス変更と同時に投稿する任意のコメント。

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [DiscussionStatusChange](/docs/huggingface_hub/v2.4.0/ja/package_reference/community#huggingface_hub.DiscussionStatusChange)

ステータス変更イベント

Pull Request をマージします。

> [!TIP]
> 以下のエラーを発生させます：
>
> - HuggingFace APIがエラーを返した場合に[`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) - パラメータの値が無効な場合に[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) - ダウンロード元のリポジトリが見つからない場合に[RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)。存在しないか、`private`に設定されていてアクセス権限がないためです。

#### model_info[[huggingface_hub.HfApi.model_info]]

```python
model_info(repo_id: str, revision: str | None = None, timeout: float | None = None, securityStatus: bool | None = None, files_metadata: bool = False, expand: list[ExpandModelProperty_T] | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3144)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

revision (`str`, *任意*) : 情報取得元のモデルリポジトリのリビジョン。

timeout (`float`, *任意*) : Hub へのリクエストにタイムアウトを設定するかどうか。

securityStatus (`bool`, *任意*) : モデルリポジトリからもセキュリティステータスを取得するかどうか。セキュリティステータスは`security_repo_status`フィールドに返されます。

files_metadata (`bool`, *任意*) : リポジトリ内のファイルのメタデータ（サイズ、LFSメタデータなど）を取得するかどうか。デフォルトは`False`です。

expand (`list[ExpandModelProperty_T]`、*任意*) : レスポンスで返すプロパティのリスト。指定した場合、リストに含まれるプロパティのみが返されます。`securityStatus` または `files_metadata` が渡されている場合は、このパラメータを使用できません。指定可能な値は `"author"`、`"baseModels"`、`"cardData"`、`"childrenModelCount"`、`"config"`、`"createdAt"`、`"disabled"`、`"downloads"`、`"downloadsAllTime"`、`"evalResults"`、`"gated"`、`"gguf"`、`"inference"`、`"inferenceProviderMapping"`、`"lastModified"`、`"library_name"`、`"likes"`、`"mask_token"`、`"model-index"`、`"pipeline_tag"`、`"private"`、`"safetensors"`、`"sha"`、`"siblings"`、`"spaces"`、`"tags"`、`"transformersInfo"`、`"trendingScore"`、`"widgetData"`、`"usedStorage"`、および `"resourceGroup"` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [huggingface_hub.hf_api.ModelInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.ModelInfo)

モデルリポジトリの情報。

huggingface.co上の特定の1つのモデルに関する情報を取得します

Modelは、許可されたトークンを渡すか、ログインしている場合にプライベートに設定できます。

> [!TIP]
> 以下のエラーを発生させます：
>
> - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) ダウンロード元のリポジトリが見つからない場合。存在しないか、`private`に設定されておりアクセス権限がない可能性があります。 - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) ダウンロード元のリビジョンが見つからない場合。

#### move_bucket[[huggingface_hub.HfApi.move_bucket]]

```python
move_bucket(from_id: str, to_id: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14199)

**パラメータ:**

from_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とバケット名。元のバケット識別子（例: `"username/my-bucket"`）。

to_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とバケット名。最終的なバケット識別子（例: `"username/new-bucket-name"`または`"organization/my-bucket"`）。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**例外:** `BucketNotFoundError`

- `BucketNotFoundError` -- ソースのバケットが見つからない場合。存在しないか、`private`に設定されておりアクセス権限がない可能性があります。

バケットを"namespace1/repo_name1"から"namespace2/repo_name2"に移動します

いくつかの制限がある点にご注意ください。リポジトリの移動に関する詳細については、https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo を参照してください。

例:
```python
>>> from huggingface_hub import move_bucket

>>> # Rename a bucket within the same namespace
>>> move_bucket(from_id="username/old-name", to_id="username/new-name")

>>> # Transfer a bucket to an organization
>>> move_bucket(from_id="username/my-bucket", to_id="my-org/my-bucket")
```

#### move_repo[[huggingface_hub.HfApi.move_repo]]

```python
move_repo(from_id: str, to_id: str, repo_type: str | None = None, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4918)

**パラメータ:**

from_id (`str`) : `/`で区切られたネームスペース（ユーザーまたは組織）とリポジトリ名。元のリポジトリ識別子。

to_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。最終的なリポジトリ識別子。

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

リポジトリをnamespace1/repo_name1からnamespace2/repo_name2へ移動する

いくつかの制限がある点にご注意ください。リポジトリの移動に関する詳細については、https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo を参照してください。

> [!TIP]
> 以下のエラーを発生させます：
>
> - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) ダウンロード元のリポジトリが見つからない場合。存在しないか、`private`に設定されておりアクセス権限がない可能性があります。

#### paper_info[[huggingface_hub.HfApi.paper_info]]

```python
paper_info(id: str)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11938)

**パラメータ:**

id (`str`, **任意**) : 論文の ArXiv ID。

**戻り値:** `PaperInfo`

`PaperInfo`オブジェクト。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` --  Hub に論文が存在しない場合、HTTP 404 が返されます。

Hub上の論文の情報を取得します。

#### parse_safetensors_file_metadata[[huggingface_hub.HfApi.parse_safetensors_file_metadata]]

```python
parse_safetensors_file_metadata(repo_id: str, filename: str, repo_type: str | None = None, revision: str | None = None, token: bool | str | None = None, timeout: float | None = 10)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6882)

**パラメータ:**

repo_id (`str`) : ユーザー名または組織名とリポジトリ名を`/`で区切ったもの。

filename (`str`) : リポジトリ内のファイル名。

repo_type (`str`, *任意*) : ファイルがデータセットまたはスペースにある場合は `"dataset"` または `"space"`、モデルにある場合は `None` または `"model"` を設定します。デフォルトは `None` です。

revision (`str`, *任意*) : ファイルを取得する git リビジョンです。ブランチ名、タグ、またはコミットハッシュを指定できます。デフォルトでは、`"main"` ブランチの先頭が使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

timeout (`float`、*任意*、デフォルトは 10) : サーバーからデータを受信するのを待ってから諦めるまでの秒数です。タイムアウトを無効にするには `None` を設定してください（接続が停止した際に呼び出しが無限にハングする可能性があるため、推奨されません）。

**戻り値:** `SafetensorsFileMetadata`

safetensorsファイルに関する情報。

**例外:** `NotASafetensorsRepoError` または `SafetensorsParsingError`

- `NotASafetensorsRepoError` -- リポジトリがsafetensorsのリポジトリでない場合、つまり`model.safetensors`ファイルまたは`model.safetensors.index.json`ファイルのいずれも存在しない場合に発生します。
- `SafetensorsParsingError` -- safetensorsファイルのヘッダーを正しく解析できなかった場合。

Hub上のsafetensorsファイルからメタデータを解析します。

リポジトリ内のすべてのsafetensorsファイルからメタデータを一度に解析するには、[get_safetensors_metadata()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.get_safetensors_metadata)を使用します。

safetensors形式の詳細については、https://huggingface.co/docs/safetensors/index#format をご覧ください。

#### pause_inference_endpoint[[huggingface_hub.HfApi.pause_inference_endpoint]]

```python
pause_inference_endpoint(name: str, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9922)

**パラメータ:**

name (`str`) : 一時停止する Inference Endpoint の名前。

namespace (`str`, *任意*) : Inference Endpoint が配置されている名前空間です。デフォルトでは、現在のユーザーになります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/ja/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint)

一時停止されたInference Endpointに関する情報。

Inference Endpointを一時停止します。

一時停止されたInference Endpointには料金は発生しません。[resume_inference_endpoint()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.resume_inference_endpoint)を使用して、いつでも再開できます。これは、[scale_to_zero_inference_endpoint()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.scale_to_zero_inference_endpoint)でInference Endpointをゼロにスケーリングすることとは異なり、後者の場合はリクエストが送信されると自動的に再起動されます。

便宜のため、[pause_inference_endpoint()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.pause_inference_endpoint) を使用して Inference Endpoint を一時停止することもできます。

#### pause_space[[huggingface_hub.HfApi.pause_space]]

```python
pause_space(repo_id: str, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8419)

**パラメータ:**

repo_id (`str`) : 一時停止する Space の ID。例: `"Salesforce/BLIP2"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceRuntime)

`stage=PAUSED` や要求されたハードウェアなど、Spaceに関するランタイム情報。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) または [BadRequestError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.BadRequestError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Space が見つからない場合（エラー 404）に発生します。おそらく repo_id が誤っているか、Space がプライベートであるにもかかわらず認証されていないことが原因です。
- [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- 403 Forbidden: Spaceを一時停止できるのは所有者のみです。所有していないSpaceを管理したい場合は、Discussionを開いて所有者に依頼するか、Spaceを複製してください。
- [BadRequestError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.BadRequestError) --  該当の Space が静的 Space の場合です。静的 Space は常に稼働しており、請求は発生しません。静的 Space を非表示にする場合は、プライベートに設定できます。

Spaceを一時停止します。

一時停止された Space は、オーナーによって手動で再起動されるまで実行を停止します。これは、48 時間の非アクティブ状態後に無料の Space が移行するスリープ状態とは異なります。選択したハードウェアにかかわらず、一時停止中の時間はアカウントに請求されません。Space を再起動するには、[restart_space()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.restart_space) を使用し、Space の設定ページにアクセスしてください。

詳細については、[ドキュメント](https://huggingface.co/docs/hub/spaces-gpus#pause)をご覧ください。

#### permanently_delete_lfs_files[[huggingface_hub.HfApi.permanently_delete_lfs_files]]

```python
permanently_delete_lfs_files(repo_id: str, lfs_files: Iterable[LFSFileInfo], rewrite_history: bool = True, repo_type: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4480)

**パラメータ:**

repo_id (`str`) : LFS ファイルのリストを取得するリポジトリ。

lfs_files (`Iterable[LFSFileInfo]`) : リポジトリから恒久的に削除する`LFSFileInfo`アイテムのイテラブル。リポジトリ内のすべてのLFSファイルをリストするには、[list_lfs_files()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_lfs_files)を使用します。

rewrite_history (`bool`、*任意*、デフォルトは`True`) : 削除されたLFSファイルを参照するファイルポインタを削除するためにリポジトリの履歴を書き換えるかどうか（推奨）。

repo_type (`str`, *任意*) : リポジトリの種類。データセットまたはスペースから一覧を取得する場合は `"dataset"` または `"space"`、モデルから一覧を取得する場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

Hub上のリポジトリからLFSファイルを恒久的に削除します。

> [!WARNING]
> これは恒久的な操作であり、削除されたファイルを参照するすべてのコミットに影響を与え、リポジトリを破損させる可能性があります。この操作は元に戻せません。その影響を十分に理解している場合のみ使用してください。

例:
```py
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> lfs_files = api.list_lfs_files("username/my-cool-repo")

# Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`.
# e.g. select only LFS files in the "checkpoints" folder
>>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/"))

# Permanently delete LFS files
>>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete)
```

#### preupload_lfs_files[[huggingface_hub.HfApi.preupload_lfs_files]]

```python
preupload_lfs_files(repo_id: str, additions: Iterable[CommitOperationAdd], token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, create_pr: bool | None = None, num_threads: int = 5, free_memory: bool = True, gitignore_content: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L5311)

**パラメータ:**

repo_id (`str`) : ファイルをコミットするリポジトリ。例: `"username/custom_transformers"`。

additions (`Iterable` of [CommitOperationAdd](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.CommitOperationAdd)) : アップロードするファイルのリストです。警告: このリスト内のオブジェクトは、アップロードに関する情報を含むように変更されます。同じオブジェクトを複数のコミットに再利用しないでください。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

repo_type (`str`, *任意*) : アップロード先のリポジトリの種類（例: `"model"` -デフォルト-、`"dataset"`、`"space"`、または`"kernel"`）。

revision (`str`, *任意*) : コミット元の git リビジョンです。`"main"` ブランチのヘッドがデフォルトです。

create_pr (`boolean`, *任意*) : そのコミットで Pull Request を作成するかどうか。デフォルトは `False` です。

num_threads (`int`, *optional*) : ファイルのアップロードに使用する同時実行スレッド数。デフォルト値は5です。2に設定すると、同時にアップロードされるファイルは最大2つになります。

free_memory (`bool`、*任意*、デフォルトは`True`) : `True`の場合、各`CommitOperationAdd`の`path_or_fileobj`属性は、アップロード後にメモリを節約するために空の`bytes`オブジェクトに置き換えられます。後続の[create_commit()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_commit)呼び出しの外で操作オブジェクトを再利用する必要がある場合は、`False`に設定してください。

gitignore_content (`str`, *任意*) : どのファイルを無視すべきかを知るための`.gitignore`ファイルの内容です。優先順位は、まず`gitignore_content`が渡されているかを確認し、次にコミット対象のファイル一覧に`.gitignore`ファイルが存在するかを確認し、最後にHubに既にホストされている`.gitignore`ファイル（存在する場合）をデフォルトとして使用することです。

将来のコミットに備えて、LFSファイルをS3に事前アップロードします。

このメソッドは、アップロードするファイルをオンザフライで生成しており、アップロード前にすべてメモリに保存したくない場合に便利です。

> [!WARNING]
> これは上級者向けのメソッドです。通常のコミットを行うために直接呼び出す必要はありません。代わりに、[create_commit()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_commit)を直接使用してください。

> [!WARNING]
> コミット操作は処理の過程で変更されます。特に、添付された`path_or_fileobj`は、メモリを節約するためにアップロード後に削除されます（空の`bytes`オブジェクトに置き換えられます）。[create_commit()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_commit)に渡す場合を除き、同じオブジェクトを再利用しないでください。コミット操作オブジェクトから添付されたコンテンツを削除したくない場合は、`free_memory=False`を渡してください。

例:
```py
>>> from huggingface_hub import CommitOperationAdd, preupload_lfs_files, create_commit, create_repo

>>> repo_id = create_repo("test_preupload").repo_id

# Generate and preupload LFS files one by one
>>> operations = [] # List of all `CommitOperationAdd` objects that will be generated
>>> for i in range(5):
...     content = ... # generate binary content
...     addition = CommitOperationAdd(path_in_repo=f"shard_{i}_of_5.bin", path_or_fileobj=content)
...     preupload_lfs_files(repo_id, additions=[addition]) # upload + free memory
...     operations.append(addition)

# Create commit
>>> create_commit(repo_id, operations=operations, commit_message="Commit all shards")
```

#### read_paper[[huggingface_hub.HfApi.read_paper]]

```python
read_paper(id: str)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11958)

**パラメータ:**

id (`str`) : 論文の ArXiv ID。

**戻り値:** `str`

論文ページのコンテンツをMarkdown形式で表示します。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` --  Hub に論文が存在しない場合、HTTP 404 が返されます。

Hub上の論文ページのMarkdownコンテンツを取得します。

#### reject_access_request[[huggingface_hub.HfApi.reject_access_request]]

```python
reject_access_request(repo_id: str, user: str | None = None, request_id: str | None = None, repo_type: str | None = None, rejection_reason: str | None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10925)

**パラメータ:**

repo_id (`str`) : アクセス要求を拒否するリポジトリのID。

user (`str`, *任意*) : アクセス要求を拒否する対象のユーザー名。`user`または`request_id`のいずれか一方のみを指定する必要があります。

request_id (`str`, *任意*) : 拒否するアクセスリクエストの ID（`AccessRequest`を参照）。リポジトリがリクエスト送信者のユーザー名を共有しないように設定されている場合に必須です。`user`または`request_id`のいずれか一方のみを指定する必要があります。

repo_type (`str`, *任意*) : アクセス要求を拒否するリポジトリの種類。`model`、`dataset`、`space` のいずれかである必要があります。デフォルトは `model` です。

rejection_reason (`str`, *任意*) : ユーザーに表示される任意の拒否理由（最大200文字）。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**例外:** `HfHubHTTPError`

- `HfHubHTTPError` -- リポジトリがゲート付きでない場合、HTTP 400 が返されます。
- `HfHubHTTPError` -- リポジトリへのアクセス権限が読み取り専用の場合、HTTP 403 が返されます。リポジトリが属する組織で `write` または `admin` のロールを持っていない場合、または `read` トークンを渡した場合に、この状況が発生します。
- `HfHubHTTPError` -- ユーザーが Hub に存在しない場合、HTTP 404 が返されます。
- `HfHubHTTPError` -- ユーザーのアクセスリクエストが見つからない場合、HTTP 404 が返されます。
- `HfHubHTTPError` -- ユーザーのアクセスリクエストが既に拒否リストに含まれている場合、HTTP 404 が返されます。

指定されたゲート付きリポジトリに対するユーザーのアクセス要求を拒否します。

拒否されたリクエストは、拒否リストに移動します。ユーザーはリポジトリのファイルをダウンロードできません。拒否されたリクエストは、[accept_access_request()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.accept_access_request)および[cancel_access_request()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.cancel_access_request)を使用して、いつでも承認またはキャンセルできます。キャンセルされたリクエストは保留リストに戻り、承認されたリクエストは承認リストに移動します。

ゲート付きリポジトリの詳細については、https://huggingface.co/docs/hub/models-gated を参照してください。

#### rename_discussion[[huggingface_hub.HfApi.rename_discussion]]

```python
rename_discussion(repo_id: str, discussion_num: int, new_title: str, token: bool | str | None = None, repo_type: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7689)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

discussion_num (`int`) : Discussion または Pull Request の番号です。正の整数である必要があります。

new_title (`str`) : ディスカッションの新しいタイトル

repo_type (`str`, *任意*) : データセットまたはスペースにアップロードする場合は `"dataset"` または `"space"`、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [DiscussionTitleChange](/docs/huggingface_hub/v2.4.0/ja/package_reference/community#huggingface_hub.DiscussionTitleChange)

タイトル変更イベント

Discussionの名前を変更します。

例:
```python
>>> new_title = "New title, fixing a typo"
>>> HfApi().rename_discussion(
...     repo_id="username/repo_name",
...     discussion_num=34,
...     new_title=new_title
... )
# DiscussionTitleChange(id='deadbeef0000000', type='title-change', ...)

```

> [!TIP]
> 以下のエラーを発生させます：
>
> - HuggingFace APIがエラーを返した場合に[`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) - パラメータの値が無効な場合に[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) - ダウンロード元のリポジトリが見つからない場合に[RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)。存在しないか、`private`に設定されていてアクセス権限がないためです。

#### repo_exists[[huggingface_hub.HfApi.repo_exists]]

```python
repo_exists(repo_id: str, repo_type: str | None = None, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3677)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

repo_type (`str`, *任意*) : データセットまたはスペースからリポジトリ情報を取得する場合は `"dataset"` または `"space"`、モデルからリポジトリ情報を取得する場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:**

リポジトリが存在する場合は True、それ以外の場合は False。

Hugging Face Hubにリポジトリが存在するかどうかを確認します。

例:
```py
>>> from huggingface_hub import repo_exists
>>> repo_exists("google/gemma-7b")
True
>>> repo_exists("google/not-a-repo")
False
```

#### repo_info[[huggingface_hub.HfApi.repo_info]]

```python
repo_info(repo_id: str, revision: str | None = None, repo_type: str | None = None, timeout: float | None = None, files_metadata: bool = False, expand: ExpandModelProperty_T | ExpandDatasetProperty_T | ExpandSpaceProperty_T | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3469)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

revision (`str`, *任意*) : 情報を取得するリポジトリのリビジョン。

repo_type (`str`, *任意*) : データセットまたはスペースからリポジトリ情報を取得する場合は `"dataset"` または `"space"`、モデルからリポジトリ情報を取得する場合は `None` または `"model"` を設定します。デフォルトは `None` です。

timeout (`float`, *任意*) : Hub へのリクエストにタイムアウトを設定するかどうか。

expand (`ExpandModelProperty_T` または `ExpandDatasetProperty_T` または `ExpandSpaceProperty_T`、*任意*) : レスポンスで返すプロパティのリスト。指定した場合、リストに含まれるプロパティのみが返されます。`files_metadata` が渡されている場合は、このパラメータを使用できません。利用可能なプロパティの完全なリストについては、[model_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.model_info)、[dataset_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.dataset_info) または [space_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.space_info) を参照してください。

files_metadata (`bool`, *任意*) : リポジトリ内のファイルのメタデータ（サイズ、LFSメタデータなど）を取得するかどうか。デフォルトは`False`です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Union[SpaceInfo, DatasetInfo, ModelInfo]`

リポジトリの情報が、[huggingface_hub.hf_api.DatasetInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.DatasetInfo)、[huggingface_hub.hf_api.ModelInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.ModelInfo)または[huggingface_hub.hf_api.SpaceInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.SpaceInfo)オブジェクトとして。

指定されたタイプの指定されたリポジトリのinfoオブジェクトを取得します。

> [!TIP]
> 以下のエラーを発生させます：
>
> - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) ダウンロード元のリポジトリが見つからない場合。存在しないか、`private`に設定されておりアクセス権限がない可能性があります。 - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) ダウンロード元のリビジョンが見つからない場合。

#### request_space_hardware[[huggingface_hub.HfApi.request_space_hardware]]

```python
request_space_hardware(repo_id: str, hardware: SpaceHardware, token: bool | str | None = None, sleep_time: int | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8323)

**パラメータ:**

repo_id (`str`) : 更新するリポジトリの ID。例: `"bigcode/in-the-stack"`。

hardware (`str` または [SpaceHardware](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceHardware)) : Space を実行するハードウェア。例: `"t4-medium"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

sleep_time (`int`, *optional*) : Space がスリープ状態に入るまで、待機状態を何秒間待つかを指定します。Space がスリープしない場合は `-1` を設定してください（アップグレードされたハードウェアのデフォルト動作です）。無料のハードウェアでは、スリープ時間を設定できません（値は 48 時間の待機に固定されています）。詳細は https://huggingface.co/docs/hub/spaces-gpus#sleep-time を参照してください。

**戻り値:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceRuntime)

Spaceのステージやハードウェアなど、Spaceに関するランタイム情報。

Space用の新しいハードウェアをリクエストします。

> [!TIP]
> Space リポジトリを作成する際に、ハードウェアを直接リクエストすることも可能です。詳細は [create_repo()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_repo) を参照してください。

#### rerun_job[[huggingface_hub.HfApi.rerun_job]]

```python
rerun_job(job_id: str, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12728)

**パラメータ:**

job_id (`str`) : 再実行する Job の ID。

namespace (`str`, *任意*) : Job の名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

token (`bool`または`str`、*省略可能*) : ユーザーアクセストークン。デフォルトでは、ローカルに保存されたトークンが使用されます。

**戻り値:** [JobInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.JobInfo)

新しく開始されたJob。

既存のJobのspec（リトライ設定やリソース設定を含む）を使用して、新しいJobを実行します。

#### resolve_revision[[huggingface_hub.HfApi.resolve_revision]]

```python
resolve_revision(repo_id: str, repo_type: str | None = None, revision: str | None = None, cache_dir: str | Path | None = None, local_files_only: bool = False, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3544)

**パラメータ:**

repo_id (`str`) : ユーザー名または組織名とリポジトリ名を`/`で区切ったもの。

repo_type (`str`, *任意*) : リポジトリがデータセット、スペース、またはカーネルのリポジトリの場合は `"dataset"`、`"space"`、または `"kernel"` を設定し、モデルの場合は `None` または `"model"` を設定します。デフォルトは `None` です。

revision (`str`, *任意*) : 解決するリビジョンです。ブランチ名、タグ、PR リファレンス、またはコミットハッシュを指定できます。デフォルトでは、デフォルトブランチが使用されます。[ResolvedRevision](/docs/huggingface_hub/v2.4.0/ja/package_reference/file_download#huggingface_hub.ResolvedRevision) が渡された場合は、そのまま返されます。ただし、別のリポジトリに対して解決された場合は、最初に要求されたリビジョンが再度解決されます。

cache_dir (`str`, `Path`, *任意*) : キャッシュされたファイルを保存するフォルダへのパス。デフォルトでは`HF_HUB_CACHE`の値が使用されます。

local_files_only (`bool`、*任意*、デフォルトは`False`) : `True`の場合、Hubに接続せずにローカルキャッシュのみからリビジョンを解決します。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [ResolvedRevision](/docs/huggingface_hub/v2.4.0/ja/package_reference/file_download#huggingface_hub.ResolvedRevision)

要求されたリビジョンと、それが解決されるコミットハッシュの両方を保持する`str`のサブクラス。

**例外:** [RevisionResolutionError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionResolutionError) または [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) または [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)

- [RevisionResolutionError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionResolutionError) -- リビジョンを解決できない場合: Hub に接続できず、ローカルにキャッシュが存在しない場合。
- [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Hub上にそのリビジョンが存在しない場合。
- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- リポジトリが見つからない場合。存在しないか、`private`に設定されておりアクセス権限がない可能性があります。

リビジョン（ブランチ、タグ、PR リファレンス）をコミットハッシュに解決します。

これは、リポジトリの複数のコンポーネント（config、weights、tokenizer など）を個別にダウンロードして読み込むライブラリ向けに設計されています。リビジョンを一度解決し、返された[ResolvedRevision](/docs/huggingface_hub/v2.4.0/ja/package_reference/file_download#huggingface_hub.ResolvedRevision)をそのまま渡すことで、リポジトリがその間に更新されていても、以降のすべての呼び出しが正確に同じコミットを対象とすることを保証します。また、コミットハッシュを用いたダウンロードは Hub に問い合わせることなくローカルキャッシュから提供できるため、HTTP 呼び出しの回数を削減できます。

`revision` -> `commit hash` のマッピングは、ベストエフォートでディスク上にキャッシュされます（キャッシュの `refs/` フォルダ内）。その後、Hub に接続できない場合（オフラインモード、接続エラー、タイムアウト、Hub の停止など）、キャッシュされた値がフォールバックとして使用されます。

> [!TIP]
> フルリポジトリのスナップショットのダウンロードのみが必要な場合、[snapshot_download()](/docs/huggingface_hub/v2.4.0/ja/package_reference/file_download#huggingface_hub.snapshot_download)を1回呼び出すだけで十分であり、すでに正しい動作を行います。`resolve_revision`は、ファイルを個別にダウンロードする場合にのみ有用です。

例:
```py
>>> from huggingface_hub import hf_hub_download, resolve_revision
>>> revision = resolve_revision("openai-community/gpt2")
>>> revision
ResolvedRevision(initial=None, resolved='607a30d783dfa663caf39e06633721c8d4cfcd7e')

# Pass it around: every download is pinned to the same commit
>>> config = hf_hub_download("openai-community/gpt2", "config.json", revision=revision)
>>> weights = hf_hub_download("openai-community/gpt2", "model.safetensors", revision=revision)
```

#### restart_space[[huggingface_hub.HfApi.restart_space]]

```python
restart_space(repo_id: str, token: bool | str | None = None, factory_reboot: bool = False)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8542)

**パラメータ:**

repo_id (`str`) : 再起動する Space の ID。例: `"Salesforce/BLIP2"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

factory_reboot (`bool`, *任意*) : `True`の場合、Spaceは要件をキャッシュせずに最初から再構築されます。

**戻り値:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceRuntime)

Spaceのランタイムに関する情報。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) または [BadRequestError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.BadRequestError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Space が見つからない場合（エラー 404）に発生します。おそらく repo_id が誤っているか、Space がプライベートであるにもかかわらず認証されていないことが原因です。
- [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- 403 Forbidden: Spaceの再起動は、そのSpaceの所有者のみ可能です。所有していないSpaceを再起動する場合は、Discussionを開いて所有者に依頼するか、そのSpaceを複製してください。
- [BadRequestError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.BadRequestError) --  該当の Space が静的 Space の場合です。静的 Space は常に稼働しており、請求は発生しません。静的 Space を非表示にする場合は、プライベートに設定できます。

Spaceを再起動してください。

Spaceを一時停止（[pause_space()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.pause_space)を参照）した場合、プログラムによってSpaceを再起動できる唯一の方法です。Spaceを再起動するには、そのSpaceの所有者である必要があります。アップグレードされたハードウェアを使用している場合、Spaceの再起動と同時にアカウントに請求が行われます。Spaceの現在の状態に関わらず、再起動をトリガーできます。

詳細については、[ドキュメント](https://huggingface.co/docs/hub/spaces-gpus#pause)をご覧ください。

#### resume_inference_endpoint[[huggingface_hub.HfApi.resume_inference_endpoint]]

```python
resume_inference_endpoint(name: str, namespace: str | None = None, running_ok: bool = True, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9957)

**パラメータ:**

name (`str`) : 再開する Inference Endpoint の名前。

namespace (`str`, *任意*) : Inference Endpoint が配置されている名前空間です。デフォルトでは、現在のユーザーになります。

running_ok (`bool`, *任意*) : `True`の場合、Inference Endpointが既に実行中であっても、メソッドはエラーを発生させません。デフォルト値は`True`です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/ja/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint)

再開されたInference Endpointに関する情報。

Inference Endpointを再開します。

便宜のため、[InferenceEndpoint.resume()](/docs/huggingface_hub/v2.4.0/ja/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint.resume) を使用して Inference Endpoint を再開することもできます。

#### resume_scheduled_job[[huggingface_hub.HfApi.resume_scheduled_job]]

```python
resume_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13384)

**パラメータ:**

scheduled_job_id (`str`) : スケジュールされたJobのID。

namespace (`str`, *任意*) : スケジュールされた Job が存在する名前空間です。デフォルトでは、現在のユーザーの名前空間になります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

Resume Hugging Faceのインフラストラクチャ上でスケジュールされたCompute Jobを再開（unpause）します。

#### revision_exists[[huggingface_hub.HfApi.revision_exists]]

```python
revision_exists(repo_id: str, revision: str, repo_type: str | None = None, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3721)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

revision (`str`) : 確認するリポジトリのリビジョン。

repo_type (`str`, *任意*) : データセットまたはスペースからリポジトリ情報を取得する場合は `"dataset"` または `"space"`、モデルからリポジトリ情報を取得する場合は `None` または `"model"` を設定します。デフォルトは `None` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:**

リポジトリとリビジョンが存在する場合は True、それ以外の場合は False を返します。

Hugging Face Hub上のリポジトリに特定のリビジョンが存在するかどうかを確認します。

例:
```py
>>> from huggingface_hub import revision_exists
>>> revision_exists("google/gemma-7b", "float16")
True
>>> revision_exists("google/gemma-7b", "not-a-revision")
False
```

#### run_as_future[[huggingface_hub.HfApi.run_as_future]]

```python
run_as_future(fn: Callable[..., R], *args, **kwargs)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2178)

**パラメータ:**

fn (`Callable`) : バックグラウンドで実行するメソッド。

- ***args,** **kwargs : メソッドを呼び出す際に使用される引数。

**戻り値:** `Future`

タスクの結果を取得するための[Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects)インスタンス。

メソッドをバックグラウンドで実行し、Futureインスタンスを返します。

主な目的は、メインスレッドをブロックせずにメソッドを実行することです（例: トレーニング中にデータをプッシュする）。バックグラウンドジョブはキューに格納されて順序が保たれますが、並列実行はされません。APIへの多数の呼び出しを並列化してスクリプトを高速化したい場合は、独自の[ThreadPoolExecutor](https://docs.python.org/3/library/concurrent.futures.html#threadpoolexecutor)を設定して使用する必要があります。

注: [upload_file()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.upload_file)、[upload_folder()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.upload_folder)、[create_commit()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_commit) などのよく使われるメソッドには、バックグラウンドで直接呼び出すための `run_as_future: bool` 引数が用意されています。これらは `api.run_as_future(...)` を呼び出すのと同じですが、記述が簡潔です。

例:
```py
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> future = api.run_as_future(api.whoami) # instant
>>> future.done()
False
>>> future.result() # wait until complete and return result
(...)
>>> future.done()
True
```

#### run_job[[huggingface_hub.HfApi.run_job]]

```python
run_job(image: str, command: list[str], env: dict[str, Any] | None = None, secrets: dict[str, Any] | None = None, flavor: JobHardware | str | None = None, timeout: int | float | str | None = None, attempts: int | None = None, name: str | None = None, labels: dict[str, str] | None = None, volumes: list[Volume] | None = None, expose: list[int] | None = None, expose_public: list[int] | None = None, ssh: bool = False, network_group: str | None = None, network_aliases: list[str] | None = None, resource_group_id: str | None = None, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12122)

**パラメータ:**

image (`str`) : 使用する Docker イメージです。例: `"ubuntu"`、`"python:3.12"`、`"pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"`。Space からのイメージの例: `"hf.co/spaces/lhoestq/duckdb"`。

command (`list[str]`) : 実行するコマンド。例: `["echo", "hello"]`。

env (`dict[str, Any]`、*任意*) : Job の環境変数を定義します。

secrets (`dict[str, Any]`、*任意*) : Jobのシークレット環境変数を定義します。

flavor (`str`, *任意*) : ハードウェアの Flavor です。使用可能な値については `JobHardware` を参照してください。デフォルト値は `"cpu-basic"` です。

timeout (`Union[int, float, str]`、*任意*) : ジョブの最大実行時間: int で s (秒、デフォルト)、m (分)、h (時間)、d (日) を指定します。例: `300` または 5 分を指定する場合は `"5m"`。

attempts (`int`, *optional*) : 初期実行を含む最大試行回数。デフォルト値は1です。例えば、3に設定すると、失敗したJobは最大2回リトライされます。

name (`str`, *任意*) : Job の名前です。`name` ラベルとして保存されます。`labels` に `name` キーを同時に渡すことはできません。名前の一意性は必須ではありません。デフォルトでは、イメージとコマンドから派生した名前（短いハッシュサフィックス付き）が使用されます。

labels (`dict[str, str]`, *省略可*) : ジョブに付与するラベル（キーと値のペア）。

volumes (`list[Volume]`、*任意*) : ジョブコンテナにボリュームとしてマウントする Hugging Face Buckets または Repos。各ボリュームは [Volume](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.Volume) で、`type`（`"bucket"`、`"model"`、`"dataset"`、または `"space"`）、`source`（例: `"username/my-bucket"`）、および `mount_path`（例: `"/data"`）を持ちます。

expose (`list[int]`, *optional*) : ジョブのプロキシ経由で公開するコンテナポート。リストに指定された各ポートは、パブリックなジョブドメイン（例: `https://<job_id>--8000.hf.jobs`）からアクセスできます。アクセスには常に、そのジョブのネームスペースへの読み取りアクセス権限を持つ HF トークンが必要です。認証なしでのアクセスには `expose_public` を使用してください。

expose_public (`list[int]`, *optional*) : 認証なしで Jobs プロキシ経由で公開するポート。これらは `expose` に列挙する必要はありません。

ssh (`bool`, *任意*) : True の場合、ジョブのコンテナは `job.status.ssh_url` で指定された URL 経由で SSH 接続可能になります（例: `ssh <job_id>@ssh.hf.jobs`、または CLI から `hf jobs ssh <job_id>`）。接続には、ジョブのネームスペースへの書き込みアクセス権と、Hub に登録された SSH 公開鍵（https://huggingface.co/settings/keys）が必要です。デフォルト値は False です。

network_group (`str`, *任意*) : 参加するネットワークグループの名前。同じnamespaceとresource group内でグループを共有するジョブは一緒に配置され、すべてのポートで相互に通信できます。各メンバー内では、`HF_NETWORK_GROUP_HOSTNAME`がグループのすべてのメンバーに解決されます。小文字の英数字とダッシュのみ使用可能で、最大46文字です。

network_aliases (`list[str]`, *optional*) : このジョブがネットワークグループ内で主張するエイリアスです。メンバーは、`${HF_NETWORK_GROUP_PREFIX}<alias>` を経由して、そのエイリアスを主張しているジョブに到達できます。複数のジョブが同じエイリアスを主張できます。小文字の英数字とダッシュのみ使用でき、最大34文字、ジョブ内で一意である必要があります。`network_group` が必要です。

resource_group_id (`str`, *任意*) : Job を作成するリソースグループの ID です。組織内のリソースへのアクセス制御や、コストの帰属・支出上限機能に使用されます。指定しない場合、Job はリソースグループの外に作成されます。

namespace (`str`, *任意*) : Job が作成される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

Hugging Faceのインフラストラクチャ上でcompute Jobsを実行します。

例:

最初のJobを実行する:

```python
>>> from huggingface_hub import run_job
>>> run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"])
```

GPUジョブの実行:

```python
>>> from huggingface_hub import run_job
>>> image = "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"
>>> command = ["python", "-c", "import torch; print(f'This code ran with the following GPU: {torch.cuda.get_device_name()}')"]
>>> run_job(image=image, command=command, flavor="a10g-small")
```

ボリュームを指定してジョブを実行する:

```python
>>> from huggingface_hub import Volume, run_job
>>> dataset_volume = Volume(type="dataset", source="HuggingFaceFW/fineweb", mount_path="/data")
>>> output_bucket_volume = Volume(type="bucket", source="username/my-bucket", mount_path="/output")
>>> image = "duckdb/duckdb"
>>> command = ["duckdb", "-c", "COPY (SELECT * FROM '/data/**/*.parquet' LIMIT 5) TO '/output/first-rows.parquet'"]
>>> run_job(image=image, command=command, volumes=[dataset_volume, output_bucket_volume])
```

#### run_uv_job[[huggingface_hub.HfApi.run_uv_job]]

```python
run_uv_job(script: str, script_args: list[str] | None = None, dependencies: list[str] | None = None, python: str | None = None, image: str | None = None, env: dict[str, Any] | None = None, secrets: dict[str, Any] | None = None, flavor: JobHardware | str | None = None, timeout: int | float | str | None = None, attempts: int | None = None, name: str | None = None, labels: dict[str, str] | None = None, volumes: list[Volume] | None = None, expose: list[int] | None = None, expose_public: list[int] | None = None, ssh: bool = False, network_group: str | None = None, network_aliases: list[str] | None = None, resource_group_id: str | None = None, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12871)

**パラメータ:**

script (`str`) : UVスクリプトのパスまたはURL、またはコマンド。

script_args (`list[str]`、*任意*) : スクリプトまたはコマンドに渡す引数。

dependencies (`list[str]`, *任意*) : UVスクリプトの実行に使用する依存関係。

python (`str`, *任意*) : 特定のPythonバージョンを使用します。デフォルトは3.12です。

image (`str`、*任意*、デフォルト値は "ghcr.io/astral-sh/uv --python3.12-bookworm"): `uv` がインストールされたカスタム Docker イメージを使用します。

env (`dict[str, Any]`、*任意*) : Job の環境変数を定義します。

secrets (`dict[str, Any]`、*任意*) : Jobのシークレット環境変数を定義します。

flavor (`str`, *任意*) : ハードウェアの Flavor です。使用可能な値については `JobHardware` を参照してください。デフォルト値は `"cpu-basic"` です。

timeout (`Union[int, float, str]`、*任意*) : ジョブの最大実行時間: int で s (秒、デフォルト)、m (分)、h (時間)、d (日) を指定します。例: `300` または 5 分を指定する場合は `"5m"`。

attempts (`int`, *optional*) : 初期実行を含む最大試行回数。デフォルトは1です。

name (`str`, *任意*) : Job の名前です。`name` ラベルとして保存されます。`labels` に `name` キーを同時に渡すことはできません。名前の一意性は必須ではありません。デフォルトでは、スクリプトとその引数から派生した名前（短いハッシュサフィックス付き）が使用されます。

labels (`dict[str, str]`, *省略可*) : ジョブに付与するラベル（キーと値のペア）。

volumes (`list[Volume]`、*任意*) : ジョブコンテナにボリュームとしてマウントする Hugging Face Buckets または Repos。各ボリュームは [Volume](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.Volume) で、`type`（`"bucket"`、`"model"`、`"dataset"`、または `"space"`）、`source`（例: `"username/my-bucket"`）、および `mount_path`（例: `"/data"`）を持ちます。

expose (`list[int]`, *optional*) : ジョブのプロキシ経由で公開するコンテナポート。リストに指定された各ポートは、パブリックなジョブドメイン（例: `https://<job_id>--8000.hf.jobs`）からアクセスできます。アクセスには常に、そのジョブのネームスペースへの読み取りアクセス権限を持つ HF トークンが必要です。認証なしでのアクセスには `expose_public` を使用してください。

expose_public (`list[int]`, *optional*) : 認証なしで Jobs プロキシ経由で公開するポート。これらは `expose` に列挙する必要はありません。

ssh (`bool`, *任意*) : True の場合、ジョブのコンテナは `job.status.ssh_url` で指定された URL 経由で SSH 接続可能になります（例: `ssh <job_id>@ssh.hf.jobs`、または CLI から `hf jobs ssh <job_id>`）。接続には、ジョブのネームスペースへの書き込みアクセス権と、Hub に登録された SSH 公開鍵（https://huggingface.co/settings/keys）が必要です。デフォルト値は False です。

network_group (`str`, *任意*) : 参加するネットワークグループの名前。同じnamespaceとresource group内でグループを共有するジョブは一緒に配置され、すべてのポートで相互に通信できます。各メンバー内では、`HF_NETWORK_GROUP_HOSTNAME`がグループのすべてのメンバーに解決されます。小文字の英数字とダッシュのみ使用可能で、最大46文字です。

network_aliases (`list[str]`, *optional*) : このジョブがネットワークグループ内で主張するエイリアスです。メンバーは、`${HF_NETWORK_GROUP_PREFIX}<alias>` を経由して、そのエイリアスを主張しているジョブに到達できます。複数のジョブが同じエイリアスを主張できます。小文字の英数字とダッシュのみ使用でき、最大34文字、ジョブ内で一意である必要があります。`network_group` が必要です。

resource_group_id (`str`, *任意*) : Job を作成するリソースグループの ID です。組織内のリソースへのアクセス制御や、コストの帰属・支出上限機能に使用されます。指定しない場合、Job はリソースグループの外に作成されます。

namespace (`str`, *任意*) : Job が作成される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

Hugging Faceのインフラストラクチャ上でUVスクリプトジョブを実行します。

> [!WARNING]
> `hf jobs uv run` とは異なり、このメソッドでは、UV スクリプトの PEP 723 ヘッダーに含めることのできる任意の `[tool.hf-jobs]` テーブル（[Jobs ガイド](../guides/jobs#ship-the-launch-config-with-the-script)を参照）は無視されます。ここでは、起動設定を明示的に渡す必要があります。

例:

URLからスクリプトを実行する:

```python
>>> from huggingface_hub import run_uv_job
>>> script = "https://raw.githubusercontent.com/huggingface/trl/refs/heads/main/trl/scripts/sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> run_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small")
```

ローカルスクリプトを実行します:

```python
>>> from huggingface_hub import run_uv_job
>>> script = "my_sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> run_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small")
```

コマンドを実行します:

```python
>>> from huggingface_hub import run_uv_job
>>> script = "lighteval"
>>> script_args= ["endpoint", "inference-providers", "model_name=openai/gpt-oss-20b,provider=auto", "lighteval|gsm8k|0|0"]
>>> run_uv_job(script, script_args=script_args, dependencies=["lighteval"], flavor="a10g-small")
```

volumeをマウントします。例えば、学習中にモデルのチェックポイントを保存する場合などです。

```python
>>> from huggingface_hub import Volume, run_uv_job
>>> script = "my_sft.py"
>>> script_args = ["--output_dir", "/training-outputs/training-v3-final", ...]
>>> checkpoints_bucket = Volume(type="bucket", source="username/my-bucket", mount_path="/training-outputs")
>>> run_uv_job(script, script_args=script_args, volumes=[checkpoints_bucket])
```

#### scale_to_zero_inference_endpoint[[huggingface_hub.HfApi.scale_to_zero_inference_endpoint]]

```python
scale_to_zero_inference_endpoint(name: str, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10003)

**パラメータ:**

name (`str`) : ゼロにスケーリングする Inference Endpoint の名前。

namespace (`str`, *任意*) : Inference Endpoint が配置されている名前空間です。デフォルトでは、現在のユーザーになります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/ja/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint)

スケーリングがゼロに設定されたInference Endpointに関する情報。

Scale Inference Endpoint to zero.

スケールがゼロに設定されたInference Endpointには料金は発生しません。次のリクエスト時にコールドスタートの遅延を伴い、自動的に再開されます。これは、[pause_inference_endpoint()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.pause_inference_endpoint)でInference Endpointを一時停止した場合とは異なり、その場合は[resume_inference_endpoint()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.resume_inference_endpoint)による手動での再開が必要です。

For convenience, you can also scale an Inference Endpoint to zero using [InferenceEndpoint.scale_to_zero()](/docs/huggingface_hub/v2.4.0/ja/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint.scale_to_zero).

#### search_spaces[[huggingface_hub.HfApi.search_spaces]]

```python
search_spaces(query: str, filter: str | Iterable[str] | None = None, sdk: str | list[str] | None = None, include_non_running: bool = False, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2878)

**パラメータ:**

query (`str`) : 検索クエリ文字列。

filter (`str` または `Iterable[str]`、*省略可能*) : フィルタリングに使用する文字列タグまたはタグのリスト。

sdk (`str` または `list[str]`、*省略可能*) : SDK によってフィルタリングします（例: `"gradio"`、`"docker"`、`"static"`）。

include_non_running (`bool`, *任意*) : 結果に実行されていない Spaces を含めるかどうか。デフォルトは `False` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `Iterable[SpaceSearchResult]`

[SpaceSearchResult](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.SpaceSearchResult)オブジェクトのイテラブル。

Hub上でセマンティック検索を使用して検索スペースを検索します。

このエンドポイントは、複数語のクエリに対してセマンティック検索（埋め込みベース）、単一語のクエリに対して全文検索を使用します。

例:
```python
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> results = list(api.search_spaces("generate image"))
>>> results[0].id
'mrfakename/Z-Image-Turbo'
>>> results[0].ai_category
'Image Generation'
```

#### set_space_sleep_time[[huggingface_hub.HfApi.set_space_sleep_time]]

```python
set_space_sleep_time(repo_id: str, sleep_time: int, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8373)

**パラメータ:**

repo_id (`str`) : 更新するリポジトリの ID。例: `"bigcode/in-the-stack"`。

sleep_time (`int`, *optional*) : Space がスリープ状態に入るまで、待機状態を何秒間待つかを指定します。Space が一時停止しない場合は `-1` を設定してください（アップグレードされたハードウェアのデフォルト動作です）。無料のハードウェアでは、スリープ時間を設定できません（値は 48 時間の待機に固定されています）。詳細は https://huggingface.co/docs/hub/spaces-gpus#sleep-time を参照してください。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceRuntime)

Spaceのステージやハードウェアなど、Spaceに関するランタイム情報。

アップグレードされたハードウェアで実行されているSpaceのカスタムスリープ時間を設定します。

Space は、X 秒間アクティビティがないとスリープ状態になります。Space が「スリープ」モードにある間は請求されません。新しい訪問者が Space にアクセスすると、Space が「起動」します。設定可能なスリープ時間は、アップグレードされたハードウェアでのみ利用できます。スリープ段階の詳細については、https://huggingface.co/docs/hub/spaces-gpus#sleep-time を参照してください。

> [!TIP]
> [request_space_hardware()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.request_space_hardware)でハードウェアをリクエストする際に、カスタムのスリープ時間を設定することも可能です。

#### set_space_volumes[[huggingface_hub.HfApi.set_space_volumes]]

```python
set_space_volumes(repo_id: str, volumes: list[Volume], token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9057)

**パラメータ:**

repo_id (`str`) : 更新する Space の ID。例: `"username/my-space"`。

volumes (`list[Volume]`) : マウントする[Volume](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.Volume)オブジェクトのリスト。各ボリュームには、`type`（`"bucket"`、`"model"`、`"dataset"`、または`"space"`）、`source`（リポジトリまたはバケットのID）、`mount_path`（コンテナ内のパス）、および任意の`revision`、`read_only`、`path`フィールドがあります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**例外:** `BadRequestError`

- `BadRequestError` -- Space が静的な Space の場合（静的な Space では volumes はサポートされていません）。

Space のボリュームを設定します。

Sets Spaceにマウントされるボリュームのリストを（または置き換えて）指定します。各ボリュームは、SpaceのコンテナにHubリソース（モデル、データセット、またはストレージバケット）へのアクセスを付与します。

例:
```python
>>> from huggingface_hub import HfApi, Volume
>>> api = HfApi()
>>> api.set_space_volumes(
...     "username/my-space",
...     volumes=[
...         Volume(type="model", source="username/my-model", mount_path="/models", read_only=True),
...         Volume(type="bucket", source="username/my-bucket", mount_path="/data"),
...     ],
... )
```

#### snapshot_download[[huggingface_hub.HfApi.snapshot_download]]

```python
snapshot_download(repo_id: str, repo_type: str | None = None, revision: str | None = None, cache_dir: str | Path | None = None, local_dir: str | Path | None = None, etag_timeout: float = 10, force_download: bool = False, token: bool | str | None = None, local_files_only: bool = False, allow_patterns: list[str] | str | None = None, ignore_patterns: list[str] | str | None = None, max_workers: int = 8, tqdm_class: type[base_tqdm] | None = None, dry_run: bool = False)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6546)

**パラメータ:**

repo_id (`str`) : ユーザー名または組織名とリポジトリ名を`/`で区切ったもの。

repo_type (`str`, *任意*) : データセットまたはスペースからダウンロードする場合は `"dataset"` または `"space"`、モデルからダウンロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

revision (`str`, *任意*) : 任意の Git リビジョン ID。ブランチ名、タグ、またはコミットハッシュを指定できます。

cache_dir (`str`, `Path`, *省略可*) : キャッシュされたファイルを保存するフォルダへのパス。

local_dir (`str` または `Path`、*省略可能*) : 指定された場合、ダウンロードされたファイルはこのディレクトリ以下に配置されます。

etag_timeout (`float`、*任意*、デフォルトは`10`) : ETagを取得する際、サーバーがデータを送信するのを待ってから諦めるまでの秒数です。`httpx2.request`に渡されます。

force_download (`bool`, *任意*, デフォルトは `False`) : ローカルキャッシュに既に存在する場合でも、ファイルをダウンロードするかどうか。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

local_files_only (`bool`、*任意*、デフォルトは`False`) : `True`の場合、ファイルのダウンロードを回避し、ローカルにキャッシュされたファイルが存在する場合はそのパスを返します。

allow_patterns (`list[str]` または `str`、*省略可能*) : 指定された場合、少なくとも1つのパターンに一致するファイルのみがダウンロードされます。

ignore_patterns (`list[str]` または `str`、*省略可能*) : 指定された場合、いずれかのパターンに一致するファイルはダウンロードされません。

max_workers (`int`, *optional*) : ファイルのダウンロードに使用する同時実行スレッド数（1スレッド = 1ファイルのダウンロード）です。デフォルト値は8です。

tqdm_class (`tqdm`, *任意*) : 指定すると、プログレスバーのデフォルトの動作を上書きします。渡される引数は、`tqdm.auto.tqdm` を継承しているか、少なくともその動作を模倣している必要があります。なお、`tqdm_class` は個々のダウンロードには渡されません。デフォルトでは、`HF_HUB_DISABLE_PROGRESS_BARS` 環境変数を設定することで無効化できる、HF 独自のプログレスバーが使用されます。

dry_run (`bool`、*任意*、デフォルトは`False`) : `True`の場合、ファイルをダウンロードせずにドライランを実行します。ダウンロードされる内容に関する情報を含む[DryRunFileInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.DryRunFileInfo)オブジェクトのリストを返します。

**戻り値:** `str` または [DryRunFileInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.DryRunFileInfo) のリスト

- `dry_run=False`の場合: リポジトリのスナップショットのフォルダパス。
- `dry_run=True`の場合: ダウンロード情報を含む[DryRunFileInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.DryRunFileInfo)オブジェクトのリスト。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) または ``EnvironmentError`` または ``OSError`` または ``ValueError``

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- ダウンロード元のリポジトリが見つからない場合。存在しないか、`private`に設定されておりアクセス権限がない可能性があります。
- [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- ダウンロード元のリビジョンが見つからない場合。
- [`EnvironmentError`](https://docs.python.org/3/library/exceptions.html#EnvironmentError) -- `token=True`が設定されている場合で、トークンが見つからない場合に発生します。
- [`OSError`](https://docs.python.org/3/library/exceptions.html#OSError) -- ETag を決定できない場合。
- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- パラメータの値が無効な場合。

リポジトリのファイルをダウンロードします。

指定されたリビジョンのリポジトリのファイルのスナップショット全体をダウンロードします。事前にどのファイルが必要か分からない場合、リポジトリのすべてのファイルを取得したい場合に便利です。すべてのファイルは、そのフォルダに対する実際のファイル名を相対パスとして保持するために、フォルダ内にネストされます。`allow_patterns` および `ignore_patterns` を使用して、ダウンロードするファイルをフィルタリングすることもできます。

`local_dir` が指定されている場合、リポジトリのファイル構造がこの場所に複製されます。このオプションを使用すると、`cache_dir` は使用されず、`local_dir` のルートに `.cache/huggingface/` フォルダが作成され、ダウンロードされたファイルに関連する一部のメタデータが保存されます。この仕組みはメインのキャッシュシステムほど堅牢ではありませんが、リポジトリの最新バージョンを定期的に取得するように最適化されています。

代替案としてリポジトリをクローンする方法がありますが、これにはgitとgit-lfsがインストールされ、正しく設定されている必要があります。また、gitを使用してリポジトリをクローンする際、ダウンロードするファイルをフィルタリングすることはできません。

#### space_info[[huggingface_hub.HfApi.space_info]]

```python
space_info(repo_id: str, revision: str | None = None, timeout: float | None = None, files_metadata: bool = False, expand: list[ExpandSpaceProperty_T] | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3359)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

revision (`str`, *任意*) : 情報を取得するスペースリポジトリのリビジョン。

timeout (`float`, *任意*) : Hub へのリクエストにタイムアウトを設定するかどうか。

files_metadata (`bool`, *任意*) : リポジトリ内のファイルのメタデータ（サイズ、LFSメタデータなど）を取得するかどうか。デフォルトは`False`です。

expand (`list[ExpandSpaceProperty_T]`, *optional*) : レスポンスで返すプロパティのリスト。指定した場合、リストに含まれるプロパティのみが返されます。このパラメータは、`full` が渡されている場合は使用できません。指定可能な値は、`"author"`、`"cardData"`、`"createdAt"`、`"datasets"`、`"disabled"`、`"lastModified"`、`"likes"`、`"models"`、`"private"`、`"region"`、`"runtime"`、`"sdk"`、`"siblings"`、`"sha"`、`"subdomain"`、`"tags"`、`"trendingScore"`、`"usedStorage"`、および `"resourceGroup"` です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [SpaceInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.SpaceInfo)

スペースのリポジトリ情報。

huggingface.co上の特定の1つのSpaceに関する情報を取得します。

許可されたトークンを渡すことで、Spaceをプライベートに設定できます。

> [!TIP]
> 以下のエラーを発生させます：
>
> - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) ダウンロード元のリポジトリが見つからない場合。存在しないか、`private`に設定されておりアクセス権限がない可能性があります。 - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) ダウンロード元のリビジョンが見つからない場合。

#### super_squash_history[[huggingface_hub.HfApi.super_squash_history]]

```python
super_squash_history(repo_id: str, branch: str | None = None, commit_message: str | None = None, repo_type: str | None = None, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4346)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

branch (`str`, *任意*) : スクワッシュするブランチ。`"main"`ブランチのヘッドがデフォルトです。

commit_message (`str`, *任意*) : スクイッシュされたコミットに使用するコミットメッセージ。

repo_type (`str`, *任意*) : データセットまたはSpaceのコミットをリストする場合は`"dataset"`または`"space"`、モデルからリストする場合は`None`または`"model"`に設定します。デフォルトは`None`です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) または [BadRequestError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.BadRequestError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- リポジトリが見つからない場合（エラー 404）: repo_id/repo_type が誤っている、プライベートリポジトリだが認証されていない、またはリポジトリが存在しない。
- [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- スクワッシュ対象のブランチが見つからない場合。
- [BadRequestError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.BadRequestError) --  ブランチの参照が無効な場合。タグでは履歴をsquashできません。

Hub上のリポジトリのブランチでコミット履歴をsquashします。

リポジトリの履歴をsquash（結合）することは、数百回のコミットを行うことが見込まれており、履歴を煩雑にしたくない場合に有用です。コミットのsquashは、ブランチの先頭（head）からのみ実行できます。

> [!WARNING]
> squash された後、コミット履歴は復元できません。これは元に戻せない操作です。

> [!WARNING]
> ブランチの履歴がsquashされた後、履歴が分岐しているため、他のブランチにマージすることはできません。

例:
```py
>>> from huggingface_hub import HfApi
>>> api = HfApi()

# Create repo
>>> repo_id = api.create_repo("test-squash").repo_id

# Make a lot of commits.
>>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"content")
>>> api.upload_file(repo_id=repo_id, path_in_repo="lfs.bin", path_or_fileobj=b"content")
>>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"another_content")

# Squash history
>>> api.super_squash_history(repo_id=repo_id)
```

#### suspend_scheduled_job[[huggingface_hub.HfApi.suspend_scheduled_job]]

```python
suspend_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13354)

**パラメータ:**

scheduled_job_id (`str`) : スケジュールされたJobのID。

namespace (`str`, *任意*) : スケジュールされた Job が存在する名前空間です。デフォルトでは、現在のユーザーの名前空間になります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

Suspend (pause) Hugging Face のインフラストラクチャ上でスケジュールされた compute Job。

#### sync_bucket[[huggingface_hub.HfApi.sync_bucket]]

```python
sync_bucket(source: str | None = None, dest: str | None = None, delete: bool = False, ignore_times: bool = False, ignore_sizes: bool = False, existing: bool = False, ignore_existing: bool = False, include: list[str] | None = None, exclude: list[str] | None = None, filter_from: str | None = None, plan: str | None = None, apply: str | None = None, dry_run: bool = False, verbose: bool = False, quiet: bool = False, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L15207)

**パラメータ:**

source (*str*、*任意*) : ソースパス: ローカルディレクトリまたは`hf://buckets/namespace/bucket_name(/prefix)`。`apply`を使用しない場合は必須です。

dest (*str*、*任意*) : 保存先パス: ローカルディレクトリまたは`hf://buckets/namespace/bucket_name(/prefix)`。`apply`を使用しない場合は必須です。

delete (*bool*、*optional*、デフォルトは *False*) : ソースに存在しない宛先のファイルを削除します。

ignore_times (*bool*、*optional*、デフォルトは *False*) : 変更時刻を無視し、サイズに基づいてのみファイルをスキップします。

ignore_sizes (*bool*、*optional*、デフォルトは *False*) : ファイルサイズを無視し、変更時刻のみを基準としてファイルをスキップします。

existing (*bool*、*optional*、デフォルトは *False*) : 受信側で新しいファイルの作成をスキップします（既存のファイルのみを更新します）。

ignore_existing (*bool*、*optional*、デフォルトは *False*) : 受信側に既に存在するファイルの更新をスキップします（新しいファイルのみを作成します）。

include (*list[str]*, *optional*) : パターン（fnmatch形式）に一致するファイルを含めるかどうかを指定します。

exclude (*list[str]*, *optional*) : パターン（fnmatch形式）に一致するファイルを除外します。

filter_from (*str*, *optional*) : 含める/除外するルールを含むフィルタファイルへのパス。

plan (*str*, *optional*) : 実行する代わりに、この JSONL ファイルに同期計画を保存します。

apply (*str*, *optional*) : 以前に保存されたプランファイルを適用します。設定されている場合、`source` と `dest` は不要です。

dry_run (*bool*、*optional*、デフォルトは *False*) : 実行せずに、同期プランを JSONL 形式で標準出力に出力します。

verbose (*bool*、*optional*、デフォルトは *False*) : ファイルごとの詳細な操作を表示します。

quiet (*bool*、*optional*、デフォルトは *False*) : すべての出力とプログレスバーを抑制します。

token (Union[bool, str, None], 省略可能) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。

**戻り値:** [*SyncPlan*]

計算（または読み込み）された同期プラン。

ローカルディレクトリとバケット間でファイルを同期します。

これは`hf buckets sync` CLIコマンドと同等です。`source`または`dest`のいずれかはバケットパス（`hf://buckets/...`）であり、もう一方はローカルディレクトリパスである必要があります。

例:
```python
>>> from huggingface_hub import HfApi
>>> api = HfApi()

# Upload local directory to bucket
>>> api.sync_bucket("./data", "hf://buckets/username/my-bucket")

# Download bucket to local directory
>>> api.sync_bucket("hf://buckets/username/my-bucket", "./data")

# Sync with delete and filtering
>>> api.sync_bucket(
...     "./data",
...     "hf://buckets/username/my-bucket",
...     delete=True,
...     include=["*.safetensors"],
... )

# Dry run: preview what would be synced
>>> plan = api.sync_bucket("./data", "hf://buckets/username/my-bucket", dry_run=True)
>>> plan.summary()
&amp;lcub;'uploads': 3, 'downloads': 0, 'deletes': 0, 'skips': 1, 'total_size': 4096}

# Save plan for review, then apply
>>> api.sync_bucket("./data", "hf://buckets/username/my-bucket", plan="sync-plan.jsonl")
>>> api.sync_bucket(apply="sync-plan.jsonl")
```

#### sync_job_volume[[huggingface_hub.HfApi.sync_job_volume]]

```python
sync_job_volume(source: str | Path, mount_path: str, remote_name: str | None = None, read_only: bool = True, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13857)

**パラメータ:**

source (`str` または `Path`) : 同期するローカルディレクトリへのパス。

mount_path (`str`) : Job コンテナ内のマウントパス。例: `"/inputs"`。`/` で始まる必要があります。

remote_name (`str`, *任意*) : 同期先のバケットサブフォルダーの名前。デフォルトでは、ソースパスとマシンのホスト名から導出される`{dirname}-{hash}`形式の名前が使用されます。

read_only (`bool`、*任意*、デフォルトは`True`) : Job内でボリュームを読み取り専用としてマウントします。バケットフォルダへの書き戻しを許可するには`False`を渡します（その後に[sync_bucket()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.sync_bucket)で出力を取得する場合など）。

namespace (`str`, *任意*) : `jobs-artifacts`バケットを所有するネームスペース。デフォルトでは、現在のユーザーのネームスペースが使用されます。ボリュームをマウントするJobと同じネームスペースを使用してください。

token (`Union[bool, str, None]`, *任意*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

**戻り値:** [Volume](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.Volume)

同期対象のサブフォルダーにスコープされたバケットボリューム。[run_job()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.run_job)、[run_uv_job()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.run_uv_job)、[create_scheduled_job()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_scheduled_job)、または [create_scheduled_uv_job()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_scheduled_uv_job) の `volumes` リストに渡すために使用します。

ローカルディレクトリをバケットに同期し、Jobでマウントできる準備が整った[Volume](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.Volume)を返します。

ファイルは、[sync_bucket()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.sync_bucket) と同じ同期ロジックを使用して、`{namespace}/jobs-artifacts` バケットのサブフォルダーにアップロードされます（プライベートとして自動作成されます。既に存在しパブリックである場合は警告が出力されます）。同じディレクトリを再同期しても、新規または変更されたファイルのみがアップロードされます。デフォルトでは、サブフォルダー名はディレクトリパスとマシンのホスト名から派生されるため、同じディレクトリからの繰り返し呼び出しでは同じリモートフォルダーが再利用されます。固定の名前を使用するには、`remote_name` を渡してください。

データはバケットにマウントされるのではなく、*コピー*されることに注意してください。同期後にローカルで加えた変更は Job に反映されません（更新するには `sync_job_volume` を再実行してください）。また、ボリュームはデフォルトで読み取り専用としてマウントされます。Job が読み書き可能なボリュームに書き込んだデータを取得するには、[sync_bucket()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.sync_bucket) を使用してバケットのフォルダを同期してください。ソースディレクトリが空の場合（出力ディレクトリなど）、ボリュームをマウントできるようにプレースホルダーの `.keep` ファイルがアップロードされます。

例:
```python
>>> from huggingface_hub import run_uv_job, sync_job_volume

# Upload ./training-data once, then run multiple jobs against it
>>> volume = sync_job_volume("./training-data", "/data")
>>> run_uv_job("train.py", script_args=["--learning-rate", "0.01"], volumes=[volume])
>>> run_uv_job("train.py", script_args=["--learning-rate", "0.05"], volumes=[volume])

# Read-write volume to retrieve outputs after the job completes
>>> volume = sync_job_volume("./outputs", "/outputs", read_only=False)
>>> job = run_uv_job("process.py", volumes=[volume])
```

#### trigger_scheduled_job[[huggingface_hub.HfApi.trigger_scheduled_job]]

```python
trigger_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13466)

**パラメータ:**

scheduled_job_id (`str`) : スケジュールされたJobのID。

namespace (`str`, *任意*) : スケジュールされた Job が存在する名前空間です。デフォルトでは、現在のユーザーの名前空間になります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

**戻り値:** [JobInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.JobInfo)

トリガーされた実行に関する情報。

**例外:** [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError)

- [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- 別のインスタンスがすでに実行中で、スケジュールされたジョブで`concurrency`が無効になっている場合、HTTP 409 が返されます。

スケジュールされたJobを即座に実行するようにトリガーします。

これにより、スケジュールされたジョブのspecが即座に1回実行されます。**変更されず**、次のスケジュール実行にも**影響しません**。すでにインスタンスが実行中で、かつスケジュールされたジョブが並行実行を許可していない場合、リクエストは拒否されます（HTTP 409）。

#### 異なり[[huggingface_hub.HfApi.unlike]]

```python
unlike(repo_id: str, token: bool | str | None = None, repo_type: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2937)

**パラメータ:**

repo_id (`str`) : 非いいねにしたいリポジトリ。例: `"user/my-cool-model"`。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

repo_type (`str`, *任意*) : データセットやスペースのいいね解除の場合は `"dataset"` または `"space"`、モデルのいいね解除の場合は `None` または `"model"` を設定します。デフォルトは `None` です。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- リポジトリが見つからない場合（エラー 404）: repo_id/repo_type が誤っている、プライベートリポジトリだが認証されていない、またはリポジトリが存在しない。

Hub上の特定のリポジトリとは異なり（例：お気に入りリストから削除）。

スパム利用を防ぐため、スクリプトからリポジトリに`like`することはできません。

また、[list_liked_repos()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_liked_repos)も参照してください。

例:
```python
>>> from huggingface_hub import list_liked_repos, unlike
>>> "gpt2" in list_liked_repos().models # we assume you have already liked gpt2
True
>>> unlike("gpt2")
>>> "gpt2" in list_liked_repos().models
False
```

#### update_bucket_settings[[huggingface_hub.HfApi.update_bucket_settings]]

```python
update_bucket_settings(bucket_id: str, private: bool, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14256)

**パラメータ:**

bucket_id (`str`) : バケットのID（例: `"username/my-bucket"`）。

private (`bool`) : バケットをプライベートにするかどうか。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**例外:** `BucketNotFoundError` または ``or``

- `BucketNotFoundError` -- バケットが見つからない場合。存在しないことが原因である可能性があります。
- ``or`` -- `private`に設定されているため、アクセス権限がないためです。

Hub上のバケットの設定を更新します。

現在、サポートされている設定はバケットの可視性のみです。

例:
```python
>>> from huggingface_hub import update_bucket_settings

>>> # Make a bucket public
>>> update_bucket_settings(bucket_id="Wauplin/first-bucket", private=False)

>>> # Make it private again
>>> update_bucket_settings(bucket_id="Wauplin/first-bucket", private=True)
```

#### update_collection_item[[huggingface_hub.HfApi.update_collection_item]]

```python
update_collection_item(collection_slug: str, item_object_id: str, note: str | None = None, position: int | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10495)

**パラメータ:**

collection_slug (`str`) : 更新するコレクションのスラッグ。例: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`。

item_object_id (`str`) : コレクション内のアイテムのIDです。これはHub上のアイテムのID（repo_idまたはpaper id）ではありません。[CollectionItem](/docs/huggingface_hub/v2.4.0/ja/package_reference/collections#huggingface_hub.CollectionItem)オブジェクトから取得する必要があります。例: `collection.items[0].item_object_id`。

note (`str`, *任意*) : コレクション内のアイテムに付与するメモ。メモの最大サイズは500文字です。

position (`int`, *任意*) : コレクション内のアイテムの新しい位置。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

コレクション内のアイテムを更新します。

例:

```py
>>> from huggingface_hub import get_collection, update_collection_item

# Get collection first
>>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")

# Update item based on its ID (add note + update position)
>>> update_collection_item(
...     collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026",
...     item_object_id=collection.items[-1].item_object_id,
...     note="Newly updated model!",
...     position=0,
... )
```

#### update_collection_metadata[[huggingface_hub.HfApi.update_collection_metadata]]

```python
update_collection_metadata(collection_slug: str, title: str | None = None, description: str | None = None, position: int | None = None, private: bool | None = None, theme: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10265)

**パラメータ:**

collection_slug (`str`) : 更新するコレクションのスラッグ。例: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`。

title (`str`) : 更新するコレクションのタイトル。

description (`str`, *任意*) : 更新するコレクションの説明。説明の最大サイズは150文字です。

position (`int`, *任意*) : ユーザーのコレクションリストにおける、そのコレクションの新しい位置。

private (`bool`, *任意*) : コレクションをプライベートにするかどうか。

theme (`str`, *任意*) : Hub上のコレクションのテーマ。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

Hub上のコレクションのメタデータを更新します。

すべての引数は任意です。提供されたメタデータのみが更新されます。

戻り値: [Collection](/docs/huggingface_hub/v2.4.0/ja/package_reference/collections#huggingface_hub.Collection)

例:

```py
>>> from huggingface_hub import update_collection_metadata
>>> collection = update_collection_metadata(
...     collection_slug="username/iccv-2023-64f9a55bb3115b4f513ec026",
...     title="ICCV Oct. 2023",
...     description="Portfolio of models, datasets, papers and demos I presented at ICCV Oct. 2023",
...     private=False,
...     theme="pink",
... )
>>> collection.slug
"username/iccv-oct-2023-64f9a55bb3115b4f513ec026"
# ^collection slug got updated but not the trailing ID
```

#### update_collection_resource_group[[huggingface_hub.HfApi.update_collection_resource_group]]

```python
update_collection_resource_group(collection_slug: str, resource_group_id: str | None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10333)

**パラメータ:**

collection_slug (`str`) : 更新するコレクションのスラッグ。例: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`。

resource_group_id (`str` または `None`) : コレクションを割り当てるリソースグループを、24文字の16進数文字列として指定します。`None` の場合、コレクションはリソースグループから削除されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

コレクションをリソースグループに割り当て、またはリソースグループから削除します。

組織が所有するコレクションでのみ有効です。

例:

```py
>>> from huggingface_hub import update_collection_resource_group
>>> update_collection_resource_group(
...     collection_slug="my-org/iccv-2023-64f9a55bb3115b4f513ec026",
...     resource_group_id="66980ecfc1e12a49c8f0e42d",
... )
```

#### update_inference_endpoint[[huggingface_hub.HfApi.update_inference_endpoint]]

```python
update_inference_endpoint(name: str, accelerator: str | None = None, instance_size: str | None = None, instance_type: str | None = None, min_replica: int | None = None, max_replica: int | None = None, scale_to_zero_timeout: int | None = None, scaling_metric: InferenceEndpointScalingMetric | None = None, scaling_threshold: float | None = None, repository: str | None = None, framework: str | None = None, revision: str | None = None, task: str | None = None, custom_image: dict | None = None, container_command: list[str] | None = None, container_args: list[str] | None = None, tensor_parallel_size: int | None = None, data_parallel_size: int | None = None, env: dict[str, str] | None = None, secrets: dict[str, str] | None = None, domain: str | None = None, path: str | None = None, cache_http_responses: bool | None = None, tags: list[str] | None = None, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9706)

**パラメータ:**

name (`str`) : 更新するInference Endpointの名前。

accelerator (`str`, *任意*) : 推論に使用されるハードウェアアクセラレータ（例: `"cpu"`）。

instance_size (`str`, *任意*) : モデルをホストするために使用されるインスタンスのサイズまたはタイプ（例: `"x4"`）。

instance_type (`str`, *任意*) : Inference Endpoint がデプロイされるクラウドインスタンスのタイプ（例: `"intel-icl"`）。

min_replica (`int`, *任意*) : Inference Endpoint で稼働させ続けるレプリカ（インスタンス）の最小数。

max_replica (`int`, *任意*) : Inference Endpointをスケーリングする際のレプリカ（インスタンス）の最大数。

scale_to_zero_timeout (`int`, *任意*) : 非アクティブなエンドポイントがゼロにスケーリングされるまでの時間（分）。

scaling_metric (`str` または `InferenceEndpointScalingMetric `、*任意*) : スケーリング用のメトリック参照です。指定する場合、"pendingRequests" または "hardwareUsage" のいずれかです。デフォルトは None です。

scaling_threshold (`float`, *optional*) : スケールアップをトリガーするために使用されるスケーリングメトリクスの閾値です。スケーリングメトリクスが指定されていない場合は無視されます。デフォルトは None です。

repository (`str`, *任意*) : Inference Endpointに関連付けられたモデルリポジトリの名前（例: `"gpt2"`）。

framework (`str`, *任意*) : モデルに使用される機械学習フレームワーク（例: `"custom"`）。

revision (`str`, *任意*) : Inference Endpoint にデプロイする特定のモデルのリビジョン（例: `"6c0e6080953db56375760c0471a8c5f2929baf11"`）。

task (`str`, *任意*) : モデルをデプロイするタスク（例: `"text-classification"`）。

custom_image (`dict`, *任意*) : 実行するコンテナイメージです。イメージのバリアントをキーとする辞書（例: `{"vLLM": {"url": "vllm/vllm-openai:v0.23.0", "port": 8000}}`、`sGLang`、`tgi`、`tei`、`llamacpp`、`hfServe` など）で、そのまま転送されます。または、カスタムコンテナを記述するフラットな辞書（例: `{"url": ..., "port": ...}`）で、`{"custom": ...}` として送信されます。

container_command (`list[str]`、*任意*) : コンテナのエントリポイントコマンドを上書きします（APIペイロードの`model.command`に対応します）。マネージドエンジンイメージ（vLLM、SGLang など）およびカスタムイメージの両方で動作します。

container_args (`list[str]`、*任意*) : コンテナのエントリポイントに追加される引数です（APIペイロードの `model.args` にマッピングされます）。マネージドエンジンイメージ（vLLM、SGLang など）およびカスタムイメージの両方で動作します。

tensor_parallel_size (`int`, *optional*) : 単一のモデルコピーをシャードするために使用するアクセラレータの数（vLLMおよびSGLangイメージ）。エンジンイメージの設定内に書き込まれます。APIは`model.image`全体を要求するため、`custom_image`が指定されていない場合、エンドポイントに現在設定されているイメージを取得して、その場で更新します。

data_parallel_size (`int`, *任意*) : アクセラレータごとに1つずつ実行するモデルのコピー数（vLLMイメージ）。`tensor_parallel_size`と同様の処理を行います。

env (`dict[str, str]`、*任意*) : コンテナ環境に注入する非シークレットの環境変数

secrets (`dict[str, str]`、*任意*) : コンテナの環境に注入するシークレット値。

domain (`str`, *任意*) : Inference Endpoint のデプロイメントに設定するカスタムドメインです。設定されている場合、推論エンドポイントはこのドメインで利用可能になります（例: `"my-new-domain.cool-website.woof"`）。

path (`str`, *任意*) : デプロイされたモデルのカスタムパスです。`/` で始まる必要があります（例: `"/models/google-bert/bert-base-uncased"`）。

cache_http_responses (`bool`, *任意*) : Inference EndpointからのHTTPレスポンスをキャッシュするかどうか。

tags (`list[str]`、*任意*) : Inference Endpointに関連付けるタグのリスト。

namespace (`str`, *任意*) : Inference Endpoint が更新される名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [InferenceEndpoint](/docs/huggingface_hub/v2.4.0/ja/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint)

更新されたInference Endpointに関する情報。

Inference Endpointを更新します。

このメソッドでは、compute設定、デプロイされたモデル、ルート、またはそれらの任意の組み合わせを更新できます。すべての引数は任意ですが、少なくとも1つは指定する必要があります。

便宜のため、[InferenceEndpoint.update()](/docs/huggingface_hub/v2.4.0/ja/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint.update) を使用して Inference Endpoint を更新することもできます。

#### update_job_expose[[huggingface_hub.HfApi.update_job_expose]]

```python
update_job_expose(job_id: str, expose: list[int] | None = None, expose_public: list[int] | None = None, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12787)

**パラメータ:**

job_id (`str`) : 実行中のJobのID。

expose (`list[int]`, *任意*) : Jobsプロキシ経由で公開するポート。アクセスには、Jobのnamespaceに対する読み取りアクセス権限を持つHFトークンが必要です。

expose_public (`list[int]`, *optional*) : 認証なしで Jobs プロキシ経由で公開するポート。これらは `expose` に列挙する必要はありません。

namespace (`str`, *任意*) : Job の名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

token (`bool`または`str`、*省略可能*) : ユーザーアクセストークン。デフォルトでは、ローカルに保存されたトークンが使用されます。

**戻り値:** [JobInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.JobInfo)

更新されたJob。

実行中のJobの公開ポートを、再実行せずに置き換えます。

`expose`と`expose_public`を組み合わせることで、完全なポート設定が構成されます。どちらのリストにも含まれていないポートは閉じられます。両方を渡さないと、公開されているすべてのポートが閉じられます。

#### update_job_labels[[huggingface_hub.HfApi.update_job_labels]]

```python
update_job_labels(job_id: str, labels: dict[str, str], namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12828)

**パラメータ:**

job_id (`str`) : Job の ID。

labels (`dict[str, str]`) : ジョブに設定する新しいラベルです。既存のすべてのラベルを置き換えます。キーと値の両方は最大100文字で、英数字、ダッシュ、アンダースコアのみを含む必要があります。

namespace (`str`, *任意*) : Job が実行されている名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

**戻り値:** [JobInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.JobInfo)

更新されたジョブ情報。

既存のJobのラベルを更新します。

既存のユーザー指定ラベルをすべて新しいラベルに置き換えます。

#### update_repo_settings[[huggingface_hub.HfApi.update_repo_settings]]

```python
update_repo_settings(repo_id: str, gated: Literal['auto', 'manual', False] | None = None, private: bool | None = None, visibility: RepoVisibility_T | None = None, token: str | bool | None = None, repo_type: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4838)

**パラメータ:**

repo_id (`str`) : / で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

gated (`Literal["auto", "manual", False]`, *optional*) : リポジトリのゲート状態です。`None` (デフォルト) に設定されている場合、リポジトリの `gated` 設定は更新されません。 * "auto": リポジトリはゲートされており、事前に定義された基準に基づいてアクセスリクエストが自動的に承認または拒否されます。 * "manual": リポジトリはゲートされており、アクセスリクエストには手動での承認が必要です。 * False : リポジトリはゲートされておらず、誰でもアクセスできます。

private (`bool`, *任意*) : リポジトリをプライベートにするかどうか。`visibility` と同時に指定することはできません。

visibility (`Literal["public", "private", "protected"]`, *任意*) : リポジトリの公開設定。`"public"`または`"private"`、Spaces の場合は`"protected"`を指定できます。

token (`Union[str, bool, None]`, *省略可能*) : 有効なユーザーアクセストークン（文字列）です。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、False を渡してください。

repo_type (`str`, *任意*) : 設定を更新するリポジトリのタイプ (`"model"`、`"dataset"` または `"space"`)。デフォルトは `"model"` です。

**例外:** ``ValueError`` または [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) または [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)

- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- gatedが"auto"、"manual"、Falseのいずれでもない場合。
- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- repo_type が constants.REPO_TYPES の値のいずれでもない場合。
- [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- Hugging Face Hub API へのリクエストが失敗した場合。
- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- ダウンロード元のリポジトリが見つからない場合。存在しないか、`private`に設定されておりアクセス権限がない可能性があります。

リポジトリの設定を更新します。ゲート付きアクセスと可視性を含みます。

リポジトリの使用方法に対する制御を強化するため、Hub ではリポジトリの作成者がアクセスリクエストを有効にしたり、リポジトリの公開範囲を変更したりできます。

#### update_scheduled_job_labels[[huggingface_hub.HfApi.update_scheduled_job_labels]]

```python
update_scheduled_job_labels(scheduled_job_id: str, labels: dict[str, str], namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13508)

**パラメータ:**

scheduled_job_id (`str`) : スケジュールされたJobのID。

labels (`dict[str, str]`) : スケジュールされたジョブに設定する新しいラベルです。既存のすべてのラベルを置き換えます。キーと値の両方は最大100文字で、英数字、ダッシュ、アンダースコアのみを含む必要があります。

namespace (`str`, *任意*) : スケジュールされた Job が存在する名前空間です。デフォルトでは、現在のユーザーの名前空間になります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

**戻り値:** `ScheduledJobInfo`

更新されたスケジュール済みジョブの情報。

既存のスケジュール済みJobのラベルを更新します。

既存のユーザー指定ラベルをすべて新しいラベルに置き換えます。

#### update_scheduled_job_schedule[[huggingface_hub.HfApi.update_scheduled_job_schedule]]

```python
update_scheduled_job_schedule(scheduled_job_id: str, schedule: str, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13414)

**パラメータ:**

scheduled_job_id (`str`) : スケジュールされたJobのID。

schedule (`str`) : "@annually"、"@yearly"、"@monthly"、"@weekly"、"@daily"、"@hourly" のいずれか、または CRON スケジュール式（例: 毎週月曜日の午前9時を指定する '0 9 * * 1'）。

namespace (`str`, *任意*) : スケジュールされた Job が存在する名前空間です。デフォルトでは、現在のユーザーの名前空間になります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

**戻り値:** `ScheduledJobInfo`

更新されたスケジュール済みジョブの情報。

既存のスケジュール済みJobの実行タイミングを変更します。

スケジュールのみが更新されます。Job の仕様、ラベル、および停止状態は保持されます。スケジュールを変更せずに、スケジュールされた Job を今すぐ一度実行するには、代わりに [trigger_scheduled_job()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.trigger_scheduled_job) を使用してください。

例:

```python
>>> from huggingface_hub import update_scheduled_job_schedule
>>> scheduled_job = update_scheduled_job_schedule(scheduled_job_id="6abb8dc9c617607c354d45f4", schedule="@daily")
>>> scheduled_job.schedule
'@daily'
```

#### update_webhook[[huggingface_hub.HfApi.update_webhook]]

```python
update_webhook(webhook_id: str, url: str | None = None, job_id: str | None = None, watched: list[dict | WebhookWatchedItem] | None = None, domains: list[constants.WEBHOOK_DOMAIN_T] | None = None, secret: str | None = None, secrets: dict[str, str] | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11319)

**パラメータ:**

webhook_id (`str`) : 更新対象のWebhookの一意の識別子。

url (`str`, 任意) : ペイロードが送信されるURL。

job_id (`str`, 任意) : WebhookペイロードでトリガーするソースJobのID。`secrets`を設定する場合は必須です。

watched (`list[WebhookWatchedItem]`, optional) : 監視するアイテムのリストです。ユーザー、組織、モデル、データセット、スペースのいずれかです。詳細は [WebhookWatchedItem](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.WebhookWatchedItem) を参照してください。監視対象のアイテムは、プレーンな辞書として指定することもできます。

domains (`list[Literal["repo", "discussion"]]`, optional) : 監視するドメインです。"repo"、"discussion"、またはその両方を指定できます。

secret (`str`, 任意) : ペイロードに署名するためのシークレット。セキュリティの追加レイヤーを提供します。

secrets (`dict[str, str]`, optional) : WebhookによってトリガーされるJob用のシークレット環境変数です。リストされたキーは保存済みの値を置き換え、空文字列は該当するシークレットを削除し、省略されたキーは保存済みの値を保持します。`job_id`が必要です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** [WebhookInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.WebhookInfo)

更新されたWebhookに関する情報。

既存のWebhookを更新します。

例:
```python
>>> from huggingface_hub import update_webhook
>>> updated_payload = update_webhook(
...     webhook_id="654bbbc16f2ec14d77f109cc",
...     url="https://new.webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
...     watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}],
...     domains=["repo"],
...     secret="my-secret",
... )
>>> print(updated_payload)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    job=None,
    url="https://new.webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo"],
    secret="my-secret",
    disabled=False,
```

#### upload_attachment[[huggingface_hub.HfApi.upload_attachment]]

```python
upload_attachment(path: str | Path, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8000)

**パラメータ:**

path (`str` または `Path`) : アップロードするファイルへのパス。対応する形式は PNG、JPEG、GIF、WebP、MP4、MOV、WebM、MP3、WAV です。ファイルサイズは 10MB 未満である必要があります（動画は 50MB まで）。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）です。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。トークンには `discussion.write` 権限が必要です。匿名でアップロードする場合は、`False` を渡します。

**戻り値:** `str`

アップロードされたファイルのURL。

**例外:** ``ValueError``

- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) --  ファイル形式がサポートされていない場合。

画像、動画、または音声ファイルを Hub にアップロードし、その URL を返します。

ファイルをDiscussionまたはPull Requestのコメント欄にドラッグ&ドロップした際に、HubのWebエディターが実行する処理は以下の通りです。返されたURLを説明欄やコメントに埋め込みます。画像の場合は`![alt text](url)`、動画の場合はURLそのもの、音声ファイルの場合は`<audio controls src="url"></audio>`を使用します。

例:
```python
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> url = api.upload_attachment("screenshot.png")
>>> api.create_discussion("username/my-model", title="Rendering bug", description=f"![screenshot]({url})")
```

#### upload_file[[huggingface_hub.HfApi.upload_file]]

```python
upload_file(path_or_fileobj: str | Path | bytes | BinaryIO, path_in_repo: str, repo_id: str, token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, commit_message: str | None = None, commit_description: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None, run_as_future: bool = False, _hot_reload: bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L5621)

**パラメータ:**

path_or_fileobj (`str`、`Path`、`bytes`、または `IO`) : ローカルマシン上のファイルへのパス、またはバイナリデータストリーム / fileobj / バッファ。

path_in_repo (`str`) : リポジトリ内の相対ファイルパス。例: `"checkpoints/1fec34a/weights.bin"`

repo_id (`str`) : ファイルがアップロードされるリポジトリ。例: `"username/custom_transformers"`

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

repo_type (`str`, *任意*) : データセット、スペース、またはカーネルのリポジトリにアップロードする場合は `"dataset"`、`"space"`、または `"kernel"` を設定し、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

revision (`str`, *任意*) : コミット元の git リビジョンです。`"main"` ブランチのヘッドがデフォルトです。

commit_message (`str`, *任意*) : 生成されたコミットのサマリー / タイトル / 最初の行

commit_description (`str`, *任意*) : 生成されたコミットの説明

create_pr (`boolean`, *任意*) : そのコミットで Pull Request を作成するかどうか。デフォルトは `False` です。`revision` が設定されていない場合、PR は `"main"` ブランチに対して作成されます。`revision` が設定されておりブランチである場合、PR はそのブランチに対して作成されます。`revision` が設定されているがブランチ名でない場合（例: コミット OID）、サーバーから `RevisionNotFoundError` が返されます。

parent_commit (`str`, *任意*) : 親コミットの OID / SHA を16進数文字列として指定します。略記法（先頭7文字）もサポートされています。指定され、かつ `create_pr` が `False` の場合、`revision` が `parent_commit` を指していないとコミットは失敗します。指定され、かつ `create_pr` が `True` の場合、`parent_commit` からプルリクエストが作成されます。`parent_commit` を指定することで、変更をコミットする前にリポジトリが変更されていないことを保証でき、リポジトリが並行して更新 / コミットされる場合に特に有用です。

run_as_future (`bool`, *任意*) : このメソッドをバックグラウンドで実行するかどうか。バックグラウンドジョブは、メインスレッドをブロックせずにシーケンシャルに実行されます。`run_as_future=True` を渡すと、[Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects) オブジェクトが返されます。デフォルトは `False` です。

**戻り値:** [CommitInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.CommitInfo) または `Future`

新しく作成されたコミットに関する情報（コミットハッシュ、コミットURL、PR URL、コミットメッセージなど）を含む[CommitInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.CommitInfo)のインスタンスを返します。`run_as_future=True`が渡された場合、実行時に結果を含むFutureオブジェクトを返します。

ローカルファイル（最大50 GB）を指定されたリポジトリにアップロードします。アップロードはHTTPのPOSTリクエストを通じて行われ、gitやgit-lfsのインストールは不要です。

> [!TIP]
> 以下のエラーを発生させます：
>
> - HuggingFace APIがエラーを返した場合、[`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) - 一部のパラメータ値が無効な場合、[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) - ダウンロード元のリポジトリが見つからない場合、[RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError)。存在しないか、`private`に設定されておりアクセス権限がない可能性があります。 - ダウンロード元のリビジョンが見つからない場合、[RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError)

> [!WARNING]
> `upload_file` は、リポジトリがすでに Hub に存在することを前提としています。Client エラー 404 が返された場合は、認証が有効であること、トークンに必要な権限が付与されていること、`repo_id` と `repo_type` が正しく設定されていることを確認してください。リポジトリが存在しない場合は、まず [create_repo()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_repo) を使用して作成してください。

例:

```python
>>> from huggingface_hub import upload_file

>>> with open("./local/filepath", "rb") as fobj:
...     upload_file(
...         path_or_fileobj=fileobj,
...         path_in_repo="remote/file/path.h5",
...         repo_id="username/my-dataset",
...         repo_type="dataset",
...         token="my_token",
...     )

>>> upload_file(
...     path_or_fileobj=".\\local\\file\\path",
...     path_in_repo="remote/file/path.h5",
...     repo_id="username/my-model",
...     token="my_token",
... )

>>> upload_file(
...     path_or_fileobj=".\\local\\file\\path",
...     path_in_repo="remote/file/path.h5",
...     repo_id="username/my-model",
...     token="my_token",
...     create_pr=True,
... )
```

#### upload_folder[[huggingface_hub.HfApi.upload_folder]]

```python
upload_folder(repo_id: str, folder_path: str | Path, path_in_repo: str | None = None, commit_message: str | None = None, commit_description: str | None = None, token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None, allow_patterns: list[str] | str | None = None, ignore_patterns: list[str] | str | None = None, delete_patterns: list[str] | str | None = None, run_as_future: bool = False)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L5808)

**パラメータ:**

repo_id (`str`) : ファイルがアップロードされるリポジトリ。例: `"username/custom_transformers"`

folder_path (`str` または `Path`) : ローカルファイルシステム上でアップロードするフォルダへのパス

path_in_repo (`str`, *任意*) : リポジトリ内のディレクトリの相対パスです。例: `"checkpoints/1fec34a/results"`。デフォルトでは、リポジトリのルートフォルダになります。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

repo_type (`str`, *任意*) : データセット、スペース、またはカーネルのリポジトリにアップロードする場合は `"dataset"`、`"space"`、または `"kernel"` を設定し、モデルにアップロードする場合は `None` または `"model"` を設定します。デフォルトは `None` です。

revision (`str`, *任意*) : コミット元の git リビジョンです。`"main"` ブランチのヘッドがデフォルトです。

commit_message (`str`, *任意*) : 生成されるコミットのサマリー / タイトル / 最初の行です。デフォルト値は `f"Upload {path_in_repo} with huggingface_hub"` です。

commit_description (`str` *任意*) : 生成されるコミットの説明

create_pr (`boolean`, *任意*) : そのコミットで Pull Request を作成するかどうか。デフォルトは `False` です。PR は常にデフォルトブランチに対して開かれます。`create_pr=True` と `revision` の両方を設定すると、`ValueError` が発生します。なお、`create_pr=True` を指定した各呼び出しで新しい Pull Request が開かれます。中断されたアップロードを既存の PR に再開するには、代わりに `revision="refs/pr/N"` を指定して再実行してください。

parent_commit (`str`, *任意*) : 親コミットの OID / SHA を16進数文字列として指定します。略記法（先頭7文字）もサポートされています。指定され、かつ `create_pr` が `False` の場合、`revision` が `parent_commit` を指していないとコミットは失敗します。`parent_commit` を指定することで、変更をコミットする前にリポジトリが変更されていないことを保証でき、リポジトリが並行して更新 / コミットされる場合に特に有用です。アップロードが複数のコミットに分割される場合（大きなフォルダなど）、`parent_commit` は最初のコミットにのみ適用されます。

allow_patterns (`list[str]` または `str`、*省略可能*) : 指定された場合、少なくとも1つのパターンに一致するファイルのみがアップロードされます。

ignore_patterns (`list[str]` または `str`、*省略可能*) : 指定された場合、これらのパターンのいずれかに一致するファイルはアップロードされません。

delete_patterns (`list[str]` または `str`、*省略可能*) : 指定された場合、新しいファイルをコミットする際に、これらのパターンのいずれかに一致するリモートファイルがリポジトリから削除されます。どのファイルがすでにアップロードされているか分からない場合に便利です。注: 不整合を避けるため、`.gitattributes` ファイルはパターンに一致していても削除されません。

run_as_future (`bool`, *任意*) : このメソッドをバックグラウンドで実行するかどうか。バックグラウンドジョブは、メインスレッドをブロックせずにシーケンシャルに実行されます。`run_as_future=True` を渡すと、[Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects) オブジェクトが返されます。デフォルトは `False` です。

**戻り値:** [CommitInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.CommitInfo) または `Future`

新しく作成されたコミットに関する情報（コミットハッシュ、コミットURL、PR URL、コミットメッセージなど）を含む[CommitInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.CommitInfo)のインスタンスを返します。`run_as_future=True`が渡された場合、実行時に結果を含むFutureオブジェクトを返します。

ローカルフォルダを指定されたリポジトリにアップロードします。アップロードはHTTPリクエストを通じて行われ、gitやgit-lfsのインストールは不要です。

フォルダの構造は保持されます。リポジトリ内に同名のファイルが既に存在する場合、そのファイルは上書きされます。その他のファイルは変更されません。

`allow_patterns` と `ignore_patterns` の引数を使用して、アップロードするファイルを指定します。これらのパラメータは、単一のパターンまたはパターンのリストを受け取ります。パターンは、[こちら](https://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm)にドキュメント化されている標準ワイルドカード（globbing パターン）です。`allow_patterns` と `ignore_patterns` の両方が指定された場合、両方の制約が適用されます。デフォルトでは、フォルダー内のすべてのファイルがアップロードされます。

`delete_patterns` 引数を使用して、削除したいリモートファイルを指定します。入力タイプは `allow_patterns` と同じです（上記を参照）。`path_in_repo` も指定されている場合、パターンはこのフォルダからの相対パスに対して照合されます。例えば、`upload_folder(..., path_in_repo="experiment", delete_patterns="logs/*")` は、`./experiment/logs/` 配下のすべてのリモートファイルを削除します。パターンに一致する場合でも、`.gitattributes` ファイルは削除されません。

サブディレクトリ内のどこかに存在する`.git/`フォルダは無視されます。ただし、`.gitignore`ファイルは考慮されない点にご注意ください。

`hf_xet` がインストールされている場合（デフォルト）、ファイルはストリーミングパイプラインを通じてアップロードされます。フォルダが Hub と照合されている間にアップロードが開始され、アップロード用のチャンク分割と並行してファイルのハッシュが計算されます（読み取りは 1 回のみ）。また、サーバーの制限を超えないように、大きなフォルダは自動的に複数のバッチでコミットされます（フォローアップのコミットには、コミットメッセージに ` (part N)` のサフィックスが付与されます）。アップロードが中断された場合、同じ呼び出しを再実行すると再開されます。すでにコミットされたファイルはスキップされ、すでにアップロードされたデータは重複排除されます。`hf_xet` がインストールされていない場合、[create_commit()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_commit) を使用して作成される単一のコミットにフォールバックします。

> [!TIP]
> 以下のエラーを発生させます：
>
> - HuggingFace APIがエラーを返した場合に[`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) - パラメータの値が無効な場合に[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError)

> [!WARNING]
> `upload_folder` は、リポジトリが Hub に既に存在することを前提としています。Client error 404 が発生した場合は、認証が有効であること、トークンに必要な権限が付与されていること、`repo_id` と `repo_type` が正しく設定されていることを確認してください。リポジトリが存在しない場合は、まず [create_repo()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_repo) を使用して作成してください。

例:

```python
# Upload checkpoints folder except the log files
>>> upload_folder(
...     folder_path="local/checkpoints",
...     path_in_repo="remote/experiment/checkpoints",
...     repo_id="username/my-dataset",
...     repo_type="datasets",
...     token="my_token",
...     ignore_patterns="**/logs/*.txt",
... )

# Upload checkpoints folder including logs while deleting existing logs from the repo
# Useful if you don't know exactly which log files have already being pushed
>>> upload_folder(
...     folder_path="local/checkpoints",
...     path_in_repo="remote/experiment/checkpoints",
...     repo_id="username/my-dataset",
...     repo_type="datasets",
...     token="my_token",
...     delete_patterns="**/logs/*.txt",
... )

# Upload checkpoints folder while creating a PR
>>> upload_folder(
...     folder_path="local/checkpoints",
...     path_in_repo="remote/experiment/checkpoints",
...     repo_id="username/my-dataset",
...     repo_type="datasets",
...     token="my_token",
...     create_pr=True,
... )
```

#### verify_repo_checksums[[huggingface_hub.HfApi.verify_repo_checksums]]

```python
verify_repo_checksums(repo_id: str, repo_type: str | None = None, revision: str | None = None, local_dir: str | Path | None = None, cache_dir: str | Path | None = None, token: str | bool | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4035)

**パラメータ:**

repo_id (`str`) : `/`で区切られた名前空間（ユーザーまたは組織）とリポジトリ名。

repo_type (`str`, *任意*) : ツリーを取得するリポジトリのタイプ (`"model"`、`"dataset"` または `"space"`。デフォルトは `"model"`。

revision (`str`, *任意*) : ツリーを取得するリポジトリのリビジョン。デフォルトは`"main"`ブランチです。

local_dir (`str` または `Path`、*省略可能*) : 検証するローカルディレクトリ。

cache_dir (`str` または `Path`、*省略可能*) : 検証するキャッシュディレクトリ。

token (Union[bool, str, None], 省略可能) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

**戻り値:** `FolderVerification`

検証の詳細を含む構造化された結果。

**例外:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) または [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError)

- [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- リポジトリが見つからない場合（エラー 404）: repo_id/repo_type が誤っている、プライベートリポジトリだが認証されていない、またはリポジトリが存在しない。
- [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/ja/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- リポジトリ上でリビジョンが見つからない場合（エラー 404）。

リポジトリのローカルファイルを、Hubのチェックサムに対して検証します。

#### wait_for_job[[huggingface_hub.HfApi.wait_for_job]]

```python
wait_for_job(job_id: str | list[str], timeout: float | None = None, poll_interval: float = 1.0, stages: list[JobStage] | None = None, namespace: str | None = None, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12638)

**パラメータ:**

job_id (`str` または `list[str]`) : 待機する Job の ID、または待機する Job ID のリストです。リストが渡された場合、[JobInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.JobInfo) のリストが返されます（同じ順序で）。

timeout (`float`, *optional*) : Job が完了するまで待機する最大時間（秒）。`None` の場合は、無限に待機します。

poll_interval (`float`, *optional*) : 各ステータスチェックの間隔（秒）。デフォルトは1秒です。

stages (`list[JobStage]`, *任意*) : 待機するステージを指定します。デフォルトでは、ターミナルステージ（`"COMPLETED"`、`"CANCELED"`、`"ERROR"`、`"DELETED"`）が設定されています。Job の実行開始を待機するには、例えば `[JobStage.RUNNING]` を渡します。この値に関わらず、ターミナルステージに到達すると常に待機が停止します。

namespace (`str`, *任意*) : Job が実行されている名前空間です。デフォルトでは、現在のユーザーの名前空間が使用されます。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークンです。指定しない場合、ローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は: https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

**戻り値:** [JobInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.JobInfo) または `list[JobInfo]`

最終的なJob info(s)。

**例外:** ``TimeoutError``

- ``TimeoutError`` -- `timeout` 秒後に、少なくとも 1 つの Job が目標のステージのいずれかに到達していない場合。

Hugging Face のインフラストラクチャ上で、1 つ以上の compute Jobs が指定されたステージに到達するまで待機します。

各 Job のステータスは、そのステージが `stages`（デフォルトではターミナルステージ: `"COMPLETED"`、`"CANCELED"`、`"ERROR"` または `"DELETED"`）のいずれかになるまで、`poll_interval` 秒ごとに [inspect_job()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.inspect_job) でポーリングされます。いずれの場合も、最終的な [JobInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/jobs#huggingface_hub.JobInfo) が返されます。失敗またはキャンセルされた Job は **例外を発生させません** — 結果に基づいて処理を行うには、`job.status.stage` を確認してください。

ターミナルステージは、`stages` に列挙されていなくても、常に待機を停止します。これにより、Job が到達することのないステージ（例: スケジューリング中に失敗する Job に対して `"RUNNING"` を待機するケース）を永遠に待機することを回避できます。

例:

```python
>>> from huggingface_hub import run_job, wait_for_job
>>> job = run_job(image="python:3.12", command=["python", "-c", "print('Hello from HF compute!')"])
>>> wait_for_job(job_id=job.id).status.stage
'COMPLETED'
```

#### wait_for_space[[huggingface_hub.HfApi.wait_for_space]]

```python
wait_for_space(repo_id: str, timeout: float | None = None, poll_interval: float = 1.0, token: bool | str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8803)

**パラメータ:**

repo_id (`str`) : 待機する Space の ID。例: `"username/my-space"`。

timeout (`float`, *optional*) : 最大待機時間（秒）。`None`の場合、無限に待機します。

poll_interval (`float`, *任意*) : ステータスチェックの間隔（秒）。デフォルトは1秒です。

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン。デフォルトではローカルに保存されたトークンが使用されます。これが推奨される認証方法です。認証を無効にするには `False` を設定してください。詳細は https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照してください。

**戻り値:** [SpaceRuntime](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceRuntime)

Spaceが終端状態に達した時点での最終的なランタイム情報。

**例外:** ``TimeoutError``

- ``TimeoutError`` -- `timeout` 秒後に Space が終端状態に達していない場合。

Spaceが終端状態（ビルド中/起動中ではない状態）に達するまで待機します。

ポーリングは、Space のステージが中間状態（`BUILDING`、`RUNNING_BUILDING`、`APP_STARTING`、`RUNNING_APP_STARTING`）でなくなるまで、`poll_interval` 秒ごとに [get_space_runtime()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.get_space_runtime) を呼び出します。いずれの場合も最終的な [SpaceRuntime](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceRuntime) を返します。結果に基づいて処理を行うには、`runtime.stage` を確認してください（例：`RUNNING` と `BUILD_ERROR` の区別）。

例:

```python
>>> from huggingface_hub import restart_space, wait_for_space
>>> restart_space("username/my-space")
>>> runtime = wait_for_space("username/my-space")
>>> runtime.stage
'RUNNING'
```

#### whoami[[huggingface_hub.HfApi.whoami]]

```python
whoami(token: bool | str | None = None, cache: bool = False)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2218)

**パラメータ:**

token (`bool` または `str`、*省略可能*) : 有効なユーザーアクセストークン（文字列）。デフォルトでは、ローカルに保存されたトークンが使用されます。これが認証の推奨方法です（https://huggingface.co/docs/huggingface_hub/quick-start#authentication を参照）。認証を無効にするには、`False` を渡します。

cache (`bool`, *任意*) : `whoami`呼び出しの結果を、その後の呼び出しのためにキャッシュするかどうか。最初の呼び出し中にエラーが発生した場合、結果はキャッシュされません。デフォルトは`False`です。

HF APIを呼び出して「whoami」を確認します。

`cache=True`を渡すと、そのPythonプロセスが存続する間、結果がキャッシュされ、以降の呼び出しで再利用されます。セキュリティ上の理由からこのエンドポイントはレート制限が厳しく設定されているため、`whoami`を複数回呼び出す予定がある場合に便利です。

## API データクラス

### AccessRequest[[huggingface_hub.hf_api.AccessRequest]]

#### huggingface_hub.hf_api.AccessRequest[[huggingface_hub.hf_api.AccessRequest]]

```python
huggingface_hub.hf_api.AccessRequest(username: str | None, request_id: str, fullname: str | None, email: str | None, timestamp: datetime, status: Literal['pending', 'accepted', 'rejected'], fields: dict[str, Any] | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L445)

**パラメータ:**

username (`str`, *任意*) : アクセスをリクエストしたユーザーのユーザー名。リポジトリがリクエスト者のユーザー名を共有しないように設定されている場合は `None` になります。その場合は、`request_id` を使用してリクエストを承認、拒否、またはキャンセルしてください。

request_id (`str`) : アクセスリクエストのID。ユーザー名が共有されていなくても、常に設定されます。

fullname (`str`, *任意*) : アクセスをリクエストしたユーザーのフルネーム。リポジトリがリクエスト者のユーザー名を共有しないように設定されている場合は`None`。

email (`str`, *任意*) : アクセスをリクエストしたユーザーのメールアドレス。ユーザーが手動でアクセス権限を付与された場合、またはリポジトリがリクエスト者のメールアドレスを共有しないように設定されている場合は `None` になります。

timestamp (`datetime`) : リクエストのタイムスタンプ。

status (`Literal["pending", "accepted", "rejected"]`) : リクエストのステータス。`["pending", "accepted", "rejected"]` のいずれかになります。

fields (`dict[str, Any]`、*任意*) : ゲートフォームでユーザーが埋める追加フィールド。

ユーザーのアクセス要求に関する情報を含むデータ構造。

### BucketFile[[huggingface_hub.BucketFile]]

#### huggingface_hub.BucketFile[[huggingface_hub.BucketFile]]

```python
huggingface_hub.BucketFile(**kwargs)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L197)

Hub上のバケット内のファイルに関する情報を含みます。このオブジェクトは[list_bucket_tree()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_bucket_tree)によって返されます。

[RepoFile](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.RepoFile)と同様に、バケット内のファイル用です。

### BucketFileMetadata[[huggingface_hub.BucketFileMetadata]]

#### huggingface_hub.BucketFileMetadata[[huggingface_hub.BucketFileMetadata]]

```python
huggingface_hub.BucketFileMetadata(size: int, xet_file_data: XetFileData)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L140)

**パラメータ:**

size (`int`) : バイト単位のファイルサイズ。

xet_file_data (`XetFileData`) : ファイルの Xet 情報（ハッシュとリフレッシュルート）。

バケット内のファイルに関する情報を含むデータ構造。

[get_bucket_file_metadata()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.get_bucket_file_metadata)によって返されます。

### BucketInfo[[huggingface_hub.BucketInfo]]

#### huggingface_hub.BucketInfo[[huggingface_hub.BucketInfo]]

```python
huggingface_hub.BucketInfo(**kwargs)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L65)

**パラメータ:**

id (`str`) : バケットのID。

private (`bool`) : バケットがプライベートかどうか。

created_at (`datetime`) : Hub上のバケットの作成日付。

size (`int`) : バケットのサイズ（バイト単位）。

total_files (`int`) : バケット内のファイルの総数。

Hub上のバケットに関する情報を含みます。このオブジェクトは[bucket_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.bucket_info)および[list_buckets()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_buckets)によって返されます。

### BucketUrl[[huggingface_hub.BucketUrl]]

#### huggingface_hub.BucketUrl[[huggingface_hub.BucketUrl]]

```python
huggingface_hub.BucketUrl(url: str, endpoint: str = '')
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L157)

**パラメータ:**

url (`str`) : バケットURLの文字列値。

endpoint (`str`, *任意*) : Hub のエンドポイント。デフォルトは です。

Hub上のバケットURLを説明します。

`BucketUrl` は [create_bucket()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_bucket) によって返されます。初期化時に、URL が解析されてプロパティが設定されます。
- endpoint (`str`)
- namespace (`str`)
- bucket_id (`str`)
- url (`str`)
- uri (`HfUri`)

### DatasetLeaderboardEntry[[huggingface_hub.DatasetLeaderboardEntry]]

#### huggingface_hub.DatasetLeaderboardEntry[[huggingface_hub.DatasetLeaderboardEntry]]

```python
huggingface_hub.DatasetLeaderboardEntry(**kwargs)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1948)

**パラメータ:**

rank (`int`) : リーダーボード上のモデルの順位（1始まり）。

model_id (`str`) : モデルのID（例: `"meta-llama/Llama-3-8b"`）。

value (`float`) : 評価スコアの値。

filename (`str`) : 評価データを含む結果ファイルの名前。

verified (`bool`) : 結果が検証済みかどうかを示します。

source (`dict[str, Any]`, *任意*) : 評価結果のソースに関する情報。`"url"`、`"name"`、`"isExternal"` などのキーが含まれます。すべてのエントリにソースがあるわけではありません。

author (`User` または `Organization`) : API レスポンスの `"type"` フィールドに基づいて解析されるモデルの作成者。

pull_request (`int`, *optional*) : リーダーボードのエントリに関連付けられた Pull request の番号（該当する場合）。

notes (`str`, *任意*) : リーダーボードのエントリに関連付けられたノート（ある場合）。

Hub上のデータセットリーダーボードの単一エントリに関する情報を含みます。

リーダーボードは、特定のベンチマークデータセットでの評価スコアに基づいてモデルをランキングします。このオブジェクトは[get_dataset_leaderboard()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.get_dataset_leaderboard)によって返されます。特定のモデルのベンチマーク全体での評価結果を取得するには、[model_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.model_info)（`expand=["evalResults"]`を指定）を介した`ModelInfo.eval_results`および[EvalResultEntry](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.EvalResultEntry)を参照してください。

### EvalResultEntry[[huggingface_hub.EvalResultEntry]]

#### huggingface_hub.EvalResultEntry[[huggingface_hub.EvalResultEntry]]

```python
huggingface_hub.EvalResultEntry(dataset_id: str, task_id: str, value: typing.Any, dataset_revision: str | None = None, verify_token: str | None = None, date: str | None = None, source_url: str | None = None, source_name: str | None = None, source_user: str | None = None, source_org: str | None = None, notes: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_eval_results.py#L17)

**パラメータ:**

dataset_id (`str`) : HubからのベンチマークデータセットID。例: "cais/hle", "Idavidrein/gpqa"。

task_id (`str`) : ベンチマーク内のタスク識別子。例: "gpqa_diamond"。

value (`Any`) : メトリックの値。例: 20.90。

dataset_revision (`str`, *任意*) : ベンチマークデータの Git SHA。

verify_token (`str`、*任意*) : 評価が監査可能かつ再現可能であることを証明するために使用できるシグネチャ。

date (`str`, *任意*) : 評価が実行された日時（ISO-8601形式の日時）。デフォルトでは、gitコミット時刻が使用されます。

source_url (`str`, *任意*) : 評価ソースへのリンク（例: https://huggingface.co/spaces/SaylorTwift/smollm3-mmlu-pro）。`source_name`、`source_user`、または `source_org` が指定されている場合は必須です。

source_name (`str`, *任意*) : ソースの表示名です。例: "Eval Logs"。

source_user (`str`, *任意*) : 帰属表示用の HF ユーザー名。例: "celinah"。

source_org (`str`, *任意*) : 帰属表示用の HF 組織名。例: "cais"。

notes (`str`, *optional*) : Details about the evaluation setup. Example: "tools", "no-tools", "chain-of-thought".

`.eval_results/*.yaml`形式の評価結果エントリ。

モデルリポジトリに保存され、モデルページとベンチマークデータセットのリーダーボードに自動的に表示される評価スコアを表します。

`README.md`のレガシーな`model-index`形式には、代わりに[EvalResult](/docs/huggingface_hub/v2.4.0/ja/package_reference/cards#huggingface_hub.EvalResult)を使用してください。

詳細については、https://huggingface.co/docs/hub/eval-results を参照してください。

例:
```python
>>> from huggingface_hub import EvalResultEntry
>>> # Minimal example with required fields only
>>> result = EvalResultEntry(
...     dataset_id="Idavidrein/gpqa",
...     task_id="gpqa_diamond",
...     value=0.412,
... )
>>> # Full example with all fields
>>> result = EvalResultEntry(
...     dataset_id="cais/hle",
...     task_id="default",
...     value=20.90,
...     dataset_revision="5503434ddd753f426f4b38109466949a1217c2bb",
...     verify_token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
...     date="2025-01-15T10:30:00Z",
...     source_url="https://huggingface.co/datasets/cais/hle",
...     source_name="CAIS HLE",
...     source_org="cais",
...     notes="no-tools",
... )

```

### SyncOperation[[huggingface_hub.SyncOperation]]

#### huggingface_hub.SyncOperation[[huggingface_hub.SyncOperation]]

```python
huggingface_hub.SyncOperation(action: typing.Literal['upload', 'download', 'delete', 'skip'], path: str, size: int | None = None, reason: str = '', local_mtime: str | None = None, remote_mtime: str | None = None, bucket_file: huggingface_hub._buckets.BucketFile | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L289)

実行される同期操作を表します。

### SyncPlan[[huggingface_hub.SyncPlan]]

#### huggingface_hub.SyncPlan[[huggingface_hub.SyncPlan]]

```python
huggingface_hub.SyncPlan(source: str, dest: str, timestamp: str, operations: list = <factory>)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L302)

完全な同期計画を表します。

### CommitInfo[[huggingface_hub.CommitInfo]]

#### huggingface_hub.CommitInfo[[huggingface_hub.CommitInfo]]

```python
huggingface_hub.CommitInfo(commit_url: str, *args, **kwargs)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L362)

**パラメータ:**

commit_url (`str`) : コミットを見つけるための URL。

commit_message (`str`) : 作成されたコミットのサマリー（最初の行）です。

commit_description (`str`) : 作成されたコミットの説明。空でも構いません。

oid (`str`) : コミットハッシュID。例: `"91c54ad1727ee830252e457677f467be0bfd8a57"`。

pr_url (`str`, *任意*) : 作成された PR の URL（該当する場合）。`create_pr=True` が渡された場合に設定されます。

pr_revision (`str`, *任意*) : 作成された PR のリビジョン（存在する場合）。`create_pr=True` が渡された場合に設定されます。例: `"refs/pr/1"`。

pr_num (`int`, *optional*) : 作成された PR ディスカッションの番号（該当する場合）。`create_pr=True` が渡された場合に設定されます。[get_discussion_details()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.get_discussion_details) で `discussion_num` として渡すことができます。例: `1`。

repo_url (`RepoUrl`) : リポジトリ ID、リポジトリタイプなどの情報を含む、コミットのリポジトリ URL

新しく作成されたコミットに関する情報を含むデータ構造。

Hub上でコミットを作成するすべてのメソッドによって返されます: [create_commit()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_commit)、[upload_file()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.upload_file)、[upload_folder()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.upload_folder)、[delete_file()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.delete_file)、[delete_folder()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.delete_folder)。後方互換性のために`str`を継承していますが、`str`固有のメソッドの使用は非推奨です。

### DatasetInfo[[huggingface_hub.DatasetInfo]]

#### huggingface_hub.DatasetInfo[[huggingface_hub.DatasetInfo]]

```python
huggingface_hub.DatasetInfo(**kwargs)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1013)

**パラメータ:**

id (`str`) : データセットのID。

author (`str`) : データセットの作成者。

card_data (`DatasetCardData`、*任意*) : [huggingface_hub.repocard_data.DatasetCardData](/docs/huggingface_hub/v2.4.0/ja/package_reference/cards#huggingface_hub.DatasetCardData) オブジェクトとしての Dataset Card Metadata。

citation (`str`, *任意*) : データセットの引用情報。

created_at (`datetime`, *任意*) : Hub 上のリポジトリの作成日付です。なお、最小値は `2022-03-02T23:29:04.000Z` であり、これは作成日付の保存を開始した日付に対応しています。

description (`str`, *任意*) : データセットの説明。

disabled (`bool`, *任意*) : リポジトリが無効化されているかどうか。

downloads (`int`) : 過去30日間のデータセットのダウンロード数。

downloads_all_time (`int`) : データセットの作成以降の累計ダウンロード数。

gated (`Literal["auto", "manual", False]`, *任意*) : リポジトリがゲート付きかどうか。ゲート付きの場合、承認が手動か自動かを指定します。

last_modified (`datetime`, *任意*) : リポジトリへの最終コミットの日付。

likes (`int`) : データセットの「いいね」数。

main_size (`int`, *任意*) : データセットのメインブランチのバイト数。

paperswithcode_id (`str`, *任意*) : データセットの Papers with code ID。

private (`bool`) : リポジトリがプライベートかどうか。

resource_group (`dict`, *任意*) : データセットのリソースグループ情報。

sha (`str`) : この特定のリビジョンのリポジトリSHA。

siblings (`list[RepoSibling]`) : データセットを構成する[huggingface_hub.hf_api.RepoSibling](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.hf_api.RepoSibling)オブジェクトのリスト。

tags (`list[str]`) : データセットのタグのリスト。

trending_score (`int`, *任意*) : データセットのトレンドスコア。

used_storage (`int`, *任意*) : Hub上のデータセットのサイズ（バイト単位）。

Hub上のデータセットに関する情報を含みます。このオブジェクトは[dataset_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.dataset_info)および[list_datasets()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_datasets)によって返されます。

> [!TIP]
> このクラスのほとんどの属性はオプションです。これは、Hubが返すデータは発行されたクエリに依存するためです。一般的に、クエリが具体的であればあるほど、より多くの情報が返されます。一方、[list_datasets()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_datasets)を使用してデータセットをリスト表示する場合、属性のサブセットのみが返されます。

### DryRunFileInfo[[huggingface_hub.DryRunFileInfo]]

#### huggingface_hub.DryRunFileInfo[[huggingface_hub.DryRunFileInfo]]

```python
huggingface_hub.DryRunFileInfo(commit_hash: str, file_size: int | None, filename: str, local_path: str, is_cached: bool, will_download: bool)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/file_download.py#L182)

**パラメータ:**

commit_hash (`str`) : ファイルに関連する commit_hash。

file_size (`int`, *任意*) : ファイルサイズ（既知の場合）。LFSファイルの場合、ポインタではなく実際のLFSファイルのサイズが含まれます。

filename (`str`) : リポジトリ内のファイル名。

is_cached (`bool`) : ファイルがローカルにキャッシュ済みかどうか。

will_download (`bool`) : `hf_hub_download` が `dry_run=False` で呼び出された場合、ファイルがダウンロードされるかどうかを示します。実際には、ファイルがキャッシュされていない場合、または `force_download=True` の場合、will_download は `True` になります。

ファイルのダウンロードのドライランを実行した際に返される情報。

`dry_run=True`の場合、[hf_hub_download()](/docs/huggingface_hub/v2.4.0/ja/package_reference/file_download#huggingface_hub.hf_hub_download)によって返されます。

### DuplicatedRepoUrl[[huggingface_hub.DuplicatedRepoUrl]]

#### huggingface_hub.DuplicatedRepoUrl[[huggingface_hub.DuplicatedRepoUrl]]

```python
huggingface_hub.DuplicatedRepoUrl(url: Any, endpoint: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L594)

**パラメータ:**

files_copy_pending (`bool`) : 新しいリポジトリのLFS/Xetファイルがバックグラウンドでコピー中である場合は`True`。コピーが完了するまで、これらのファイルのダウンロードが失敗する可能性があります。

[duplicate_repo()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.duplicate_repo) が返す [RepoUrl](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.RepoUrl)。

### GitRefInfo[[huggingface_hub.GitRefInfo]]

#### huggingface_hub.GitRefInfo[[huggingface_hub.GitRefInfo]]

```python
huggingface_hub.GitRefInfo(name: str, ref: str, target_commit: str)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1444)

**パラメータ:**

name (`str`) : 参照の名前（例：タグ名やブランチ名）。

ref (`str`) : Hub 上の完全な git ref（例: `"refs/heads/main"` または `"refs/tags/v1.0"`）。

target_commit (`str`) : ref の対象コミットの OID (例: `"e7da7f221d5bf496a48136c0cd264e630fe9fcc8"`)

Hub上のリポジトリのgit参照に関する情報を含みます。

### GitCommitInfo[[huggingface_hub.GitCommitInfo]]

#### huggingface_hub.GitCommitInfo[[huggingface_hub.GitCommitInfo]]

```python
huggingface_hub.GitCommitInfo(commit_id: str, authors: list[str], created_at: datetime, title: str, message: str, formatted_title: str | None, formatted_message: str | None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1489)

**パラメータ:**

commit_id (`str`) : コミットの OID (例: `"e7da7f221d5bf496a48136c0cd264e630fe9fcc8"`)

authors (`list[str]`) : コミットの著者のリスト。

created_at (`datetime`) : コミットが作成された日時。

title (`str`) : コミットのタイトルです。これは著者が入力する自由形式のテキスト値です。

message (`str`) : コミットの説明。これは著者が入力する自由形式のテキスト値です。

formatted_title (`str`) : HTML形式で整形されたコミットのタイトル。`formatted=True`が設定されている場合のみ返されます。

formatted_message (`str`) : HTML形式でフォーマットされたコミットの説明。`formatted=True`が設定されている場合のみ返されます。

Hub上のリポジトリのgitコミットに関する情報を含みます。詳細については、[list_repo_commits()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_repo_commits)を参照してください。

### GitRefs[[huggingface_hub.GitRefs]]

#### huggingface_hub.GitRefs[[huggingface_hub.GitRefs]]

```python
huggingface_hub.GitRefs(branches: list[GitRefInfo], converts: list[GitRefInfo], tags: list[GitRefInfo], pull_requests: list[GitRefInfo] | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1463)

**パラメータ:**

branches (`list[GitRefInfo]`) : リポジトリのブランチに関する情報を含む[GitRefInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.GitRefInfo)のリスト。

converts (`list[GitRefInfo]`) : リポジトリ上の "convert" リファレンスに関する情報が含まれる [GitRefInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.GitRefInfo) のリスト。Convert は、Dataset リポジトリにおいて前処理済みデータをプッシュするために（内部的に）使用されるリファレンスです。

tags (`list[GitRefInfo]`) : リポジトリのタグに関する情報を含む[GitRefInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.GitRefInfo)のリスト。

pull_requests (`list[GitRefInfo]`, *optional*) : リポジトリのプルリクエストに関する情報が含まれる[GitRefInfo](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.GitRefInfo)のリスト。`include_prs=True`が設定されている場合のみ返されます。

Hub上のリポジトリのすべてのgit参照に関する情報を含みます。

オブジェクトは、[list_repo_refs()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_repo_refs)によって返されます。

### InferenceProviderMapping[[huggingface_hub.hf_api.InferenceProviderMapping]]

#### huggingface_hub.hf_api.InferenceProviderMapping[[huggingface_hub.hf_api.InferenceProviderMapping]]

```python
huggingface_hub.hf_api.InferenceProviderMapping(**kwargs)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L773)

### KernelInfo[[huggingface_hub.KernelInfo]]

#### huggingface_hub.KernelInfo[[huggingface_hub.KernelInfo]]

```python
huggingface_hub.KernelInfo(**kwargs)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1285)

**パラメータ:**

id (`str`) : カーネルリポジトリのID。

author (`str`, *任意*) : カーネルリポジトリの作成者。

downloads (`int`, *任意*) : 過去30日間のカーネルリポジトリのダウンロード数。

gated (`Literal["auto", "manual", False]`, *任意*) : リポジトリがゲート付きかどうか。ゲート付きの場合、承認が手動か自動かを指定します。

last_modified (`datetime`, *任意*) : リポジトリへの最終コミットの日付。

likes (`int`, *任意*) : カーネルリポジトリの「いいね」数。

private (`bool`, *任意*) : リポジトリがプライベートかどうか。

sha (`str`, *任意*) : この特定のリビジョンのリポジトリSHA。

Hub上のカーネルリポジトリに関する情報を含みます。このオブジェクトは[kernel_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.kernel_info)によって返されます。

### LFSFileInfo[[huggingface_hub.hf_api.LFSFileInfo]]

#### huggingface_hub.hf_api.LFSFileInfo[[huggingface_hub.hf_api.LFSFileInfo]]

```python
huggingface_hub.hf_api.LFSFileInfo(**kwargs)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1887)

**パラメータ:**

file_oid (`str`) : ファイルのSHA-256オブジェクトIDです。ファイルを恒久的に削除する際に渡す識別子です。

filename (`str`) : LFSオブジェクトのファイル名候補です。詳細は上記の注記を参照してください。

oid (`str`) : LFSオブジェクトのOID。

pushed_at (`datetime`) : LFSオブジェクトがリポジトリにプッシュされた日付。

ref (`str`, *任意*) : LFSオブジェクトがプッシュされたリポジトリ（該当する場合）。

size (`int`) : LFSオブジェクトのサイズ。

Hub上のリポジトリにLFSとして保存されているファイルに関する情報を含みます。

リポジトリからLFSファイルをリスト表示し、恒久的に削除して空き領域を確保する文脈で使用されます。詳細については、[list_lfs_files()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_lfs_files)および[permanently_delete_lfs_files()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.permanently_delete_lfs_files)を参照してください。

Git LFS ファイルは、パフォーマンスを最適化するために、ファイルパスではなく SHA-256 オブジェクト ID で追跡されます。このアプローチが必要な理由は、1 つのオブジェクトが異なるコミット間で複数のパスから参照され得るため、これらの接続を探索して解決することが非現実的だからです。各 SHA にどのファイル名が関連付けられているかを確認する方法については、[ドキュメント](https://huggingface.co/docs/hub/storage-limits#advanced-track-lfs-file-references)をご覧ください。

例:
```py
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> lfs_files = api.list_lfs_files("username/my-cool-repo")

# Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`.
# e.g. select only LFS files in the "checkpoints" folder
>>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/"))

# Permanently delete LFS files
>>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete)
```

### ModelInfo[[huggingface_hub.ModelInfo]]

#### huggingface_hub.ModelInfo[[huggingface_hub.ModelInfo]]

```python
huggingface_hub.ModelInfo(**kwargs)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L798)

**パラメータ:**

id (`str`) : モデルのID。

author (`str`, *任意*) : モデルの作成者。

base_models (`list[str]`, *任意*) : このモデルが派生したベースモデルのリスト。

card_data (`ModelCardData`、*任意*) : [huggingface_hub.repocard_data.ModelCardData](/docs/huggingface_hub/v2.4.0/ja/package_reference/cards#huggingface_hub.ModelCardData) オブジェクトとしてのモデルカードのメタデータ。

children_model_count (`int`, *任意*) : このモデルから派生した子モデルの数。

config (`dict`, *任意*) : モデルの設定。

created_at (`datetime`, *任意*) : Hub 上のリポジトリの作成日付です。なお、最小値は `2022-03-02T23:29:04.000Z` であり、これは作成日付の保存を開始した日付に対応しています。

disabled (`bool`, *任意*) : リポジトリが無効化されているかどうか。

downloads (`int`) : 過去30日間のモデルのダウンロード数。

downloads_all_time (`int`) : モデルの作成以降のダウンロード総数。

eval_results (`list[EvalResultEntry]`、*optional*) : モデルの評価結果。

gated (`Literal["auto", "manual", False]`, *任意*) : リポジトリがゲート付きかどうか。ゲート付きの場合、承認が手動か自動かを指定します。

gguf (`dict`, *任意*) : モデルのGGUF情報。

inference (`Literal["warm"]`, *任意*) : Inference Providers におけるモデルのステータス。少なくとも 1 つのプロバイダーによって提供されている場合、Warm となります。

inference_provider_mapping (`list[InferenceProviderMapping]`、*optional*) : ユーザーのプロバイダーの順序に従って並べられた`InferenceProviderMapping`のリスト。

last_modified (`datetime`, *任意*) : リポジトリへの最終コミットの日付。

library_name (`str`, *任意*) : モデルに関連付けられているライブラリ。

likes (`int`) : モデルの「いいね」数。

mask_token (`str`, *任意*) : モデルで使用されるマスクトークン。

model_index (`dict`, *任意*) : 評価用のモデルインデックス。

pipeline_tag (`str`, *任意*) : モデルに関連付けられたパイプラインタグ。

private (`bool`) : リポジトリがプライベートかどうか。

resource_group (`dict`, *任意*) : モデルのリソースグループ情報。

safetensors (`SafeTensorsInfo`, *任意*) : モデルのsafetensors情報。

security_repo_status (`dict`, *任意*) : モデルのセキュリティスキャンのステータス。

sha (`str`, *任意*) : この特定のリビジョンのリポジトリSHA。

siblings (`list[RepoSibling]`) : モデルを構成する[huggingface_hub.hf_api.RepoSibling](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.hf_api.RepoSibling)オブジェクトのリスト。

spaces (`list[str]`, *任意*) : モデルを使用しているスペースのリスト。

tags (`list[str]`) : モデルのタグのリスト。`card_data.tags` とは異なり、Hub によって計算される追加のタグ（サポートされているライブラリ、モデルの arXiv など）が含まれます。

transformers_info (`TransformersInfo`, *任意*) : モデルに関連付けられた Transformers 固有の情報（auto クラス、プロセッサーなど）。

trending_score (`int`, *任意*) : モデルのトレンドスコア。

used_storage (`int`, *任意*) : Hub 上のモデルのサイズ（バイト単位）。

widget_data (`Any`, *任意*) : モデルに関連付けられたウィジェットデータ。

Hub上のモデルに関する情報を含みます。このオブジェクトは[model_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.model_info)および[list_models()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_models)によって返されます。

> [!TIP]
> このクラスのほとんどの属性はオプションです。これは、Hubが返すデータは発行されたクエリに依存するためです。一般的に、クエリが具体的であればあるほど、より多くの情報が返されます。一方、[list_models()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_models)を使用してモデルをリスト表示する場合、属性のサブセットのみが返されます。

### RepoSibling[[huggingface_hub.hf_api.RepoSibling]]

#### huggingface_hub.hf_api.RepoSibling[[huggingface_hub.hf_api.RepoSibling]]

```python
huggingface_hub.hf_api.RepoSibling(rfilename: str, size: int | None = None, blob_id: str | None = None, lfs: BlobLfsInfo | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L648)

**パラメータ:**

rfilename (str) : リポジトリのルートからの相対パスのファイル名。

size (`int`, *optional*) : ファイルのサイズ（バイト単位）です。この属性は、[repo_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.repo_info)の`files_metadata`引数が`True`に設定されている場合に定義されます。それ以外の場合は`None`です。

blob_id (`str`, *任意*) : ファイルの git OID です。この属性は、[repo_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.repo_info) の `files_metadata` 引数が `True` に設定されている場合に定義されます。それ以外の場合は `None` です。

lfs (`BlobLfsInfo`, *任意*) : ファイルのLFSメタデータです。この属性は、[repo_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.repo_info)の`files_metadata`引数が`True`に設定されており、かつファイルがGit LFSで保存されている場合に定義されます。それ以外の場合は`None`です。

Hub上のリポジトリ内のリポジトリファイルに関する基本的な情報を含みます。

> [!TIP]
> このクラスの属性は、`rfilename`を除いてすべてオプションです。これは、Hub上のリポジトリをリスト表示する際（[list_models()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_models)、[list_datasets()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_datasets)または[list_spaces()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_spaces)を使用する場合）には、ファイル名のみが返されるためです。ファイルサイズ、blob ID、LFSの詳細などの追加情報が必要な場合は、バックエンドサーバーにこれらの情報を取得させる際に制約が増えるため、リポジトリを1つずつ特定して（[model_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.model_info)、[dataset_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.dataset_info)または[space_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.space_info)を使用して）明示的にリクエストする必要があります。

### RepoFile[[huggingface_hub.RepoFile]]

#### huggingface_hub.RepoFile[[huggingface_hub.RepoFile]]

```python
huggingface_hub.RepoFile(**kwargs)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L680)

**パラメータ:**

path (str) : リポジトリのルートからの相対パス。

size (`int`) : ファイルのサイズ（バイト単位）。

blob_id (`str`) : ファイルの git OID。

lfs (`BlobLfsInfo`, *任意*) : ファイルのLFSメタデータ。

xet_hash (`str`, *任意*) : ファイルの Xet ハッシュ。

last_commit (`LastCommitInfo`, *任意*) : ファイルの最終コミットメタデータです。[list_repo_tree()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_repo_tree) と [get_paths_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.get_paths_info) が `expand=True` を指定して呼び出された場合のみ定義されます。

security (`BlobSecurityInfo`, *任意*) : ファイルのセキュリティスキャンに関するメタデータです。[list_repo_tree()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_repo_tree) および [get_paths_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.get_paths_info) が `expand=True` を指定して呼び出された場合のみ定義されます。

Hub上のファイルに関する情報を含みます。

### RepoUrl[[huggingface_hub.RepoUrl]]

#### huggingface_hub.RepoUrl[[huggingface_hub.RepoUrl]]

```python
huggingface_hub.RepoUrl(url: Any, endpoint: str | None = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L527)

**パラメータ:**

url (`Any`) : リポジトリURLの文字列値。

endpoint (`str`, *任意*) : Hub のエンドポイント。デフォルトは です。

**例外:** `HfUriError`

- `HfUriError` -- URLを解析できない場合（例：正規化された単一セグメントのリポジトリ、または不明な`repo_type`）。

Hub上のリポジトリURLを記述する`str`のサブクラス。

`RepoUrl` は `HfApi.create_repo` によって返されます。後方互換性のために `str` を継承しています。初期化時に URL が解析され、プロパティが設定されます。
- endpoint (`str`)
- namespace (`str`)
- repo_name (`str`)
- repo_id (`str`)
- repo_type (`Literal["model", "dataset", "space"]`)
- url (`str`)

例:
```py
>>> RepoUrl('https://huggingface.co/openai-community/gpt2')
RepoUrl('https://huggingface.co/openai-community/gpt2', endpoint='https://huggingface.co', repo_type='model', repo_id='openai-community/gpt2')

>>> RepoUrl('https://hub-ci.huggingface.co/datasets/dummy_user/dummy_dataset', endpoint='https://hub-ci.huggingface.co')
RepoUrl('https://hub-ci.huggingface.co/datasets/dummy_user/dummy_dataset', endpoint='https://hub-ci.huggingface.co', repo_type='dataset', repo_id='dummy_user/dummy_dataset')

>>> RepoUrl('hf://datasets/my-user/my-dataset')
RepoUrl('hf://datasets/my-user/my-dataset', endpoint='https://huggingface.co', repo_type='dataset', repo_id='user/dataset')

>>> HfApi.create_repo("dummy_model")
RepoUrl('https://huggingface.co/Wauplin/dummy_model', endpoint='https://huggingface.co', repo_type='model', repo_id='Wauplin/dummy_model')
```

### SafetensorsRepoMetadata[[huggingface_hub.utils.SafetensorsRepoMetadata]]

#### huggingface_hub.utils.SafetensorsRepoMetadata[[huggingface_hub.utils.SafetensorsRepoMetadata]]

```python
huggingface_hub.utils.SafetensorsRepoMetadata(metadata: dict | None, sharded: bool, weight_map: dict, files_metadata: dict)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/utils/_safetensors.py#L74)

**パラメータ:**

metadata (`dict`, *任意*) : 'model.safetensors.index.json' ファイルが存在する場合、その中に含まれるメタデータです。シャード化されたモデルの場合のみ設定されます。

sharded (`bool`) : リポジトリにシャードされたモデルが含まれているかどうか。

weight_map (`dict[str, str]`) : すべての重みのマップです。キーはテンソル名、値はテンソルを含むファイルのファイル名です。

files_metadata (`dict[str, SafetensorsFileMetadata]`) : 全ファイルのメタデータのマップです。キーはファイル名、値は対応するファイルのメタデータであり、`SafetensorsFileMetadata`オブジェクトとして表されます。

parameter_count (`dict[str, int]`) : データタイプごとのパラメータ数のマップです。キーはデータタイプ、値はそのデータタイプのパラメータ数です。

Safetensorsリポジトリのメタデータ。

リポジトリのルートに、model.safetensors ウェイトファイル（非共有モデル）または model.safetensors.index.json インデックスファイル（シャーディングされたモデル）のいずれかが含まれている場合、そのリポジトリは Safetensors リポジトリとみなされます。

このクラスは、[get_safetensors_metadata()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.get_safetensors_metadata)によって返されます。

safetensors形式の詳細については、https://huggingface.co/docs/safetensors/index#format をご覧ください。

### SafetensorsFileMetadata[[huggingface_hub.utils.SafetensorsFileMetadata]]

#### huggingface_hub.utils.SafetensorsFileMetadata[[huggingface_hub.utils.SafetensorsFileMetadata]]

```python
huggingface_hub.utils.SafetensorsFileMetadata(metadata: dict, tensors: dict)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/utils/_safetensors.py#L44)

**パラメータ:**

metadata (`dict`) : ファイルに含まれるメタデータ。

tensors (`dict[str, TensorInfo]`) : すべてのテンソルのマップです。キーはテンソル名、値は対応するテンソルの情報であり、`TensorInfo`オブジェクトとして表されます。

parameter_count (`dict[str, int]`) : データタイプごとのパラメータ数のマップです。キーはデータタイプ、値はそのデータタイプのパラメータ数です。

Hub上でホストされているSafetensorsファイルのメタデータ。

このクラスは、[parse_safetensors_file_metadata()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.parse_safetensors_file_metadata)によって返されます。

safetensors形式の詳細については、https://huggingface.co/docs/safetensors/index#format をご覧ください。

### SpaceInfo[[huggingface_hub.SpaceInfo]]

#### huggingface_hub.SpaceInfo[[huggingface_hub.SpaceInfo]]

```python
huggingface_hub.SpaceInfo(**kwargs)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1147)

**パラメータ:**

id (`str`) : Space の ID。

author (`str`, *任意*) : Space の作成者。

card_data (`SpaceCardData`, *任意*) : [huggingface_hub.repocard_data.SpaceCardData](/docs/huggingface_hub/v2.4.0/ja/package_reference/cards#huggingface_hub.SpaceCardData) オブジェクトとしての Space Card メタデータ。

created_at (`datetime`, *任意*) : Hub 上のリポジトリの作成日付です。なお、最小値は `2022-03-02T23:29:04.000Z` であり、これは作成日付の保存を開始した日付に対応しています。

datasets (`list[str]`, *任意*) : Spaceで使用されるデータセットのリスト。

disabled (`bool`, *任意*) : Space が無効化されているかどうかを示します。

gated (`Literal["auto", "manual", False]`, *任意*) : リポジトリがゲート付きかどうか。ゲート付きの場合、承認が手動か自動かを指定します。

host (`str`, *任意*) : Space のホスト URL。

last_modified (`datetime`, *任意*) : リポジトリへの最終コミットの日付。

likes (`int`) : Spaceの「いいね」数。

models (`list[str]`, *任意*) : Spaceで使用されるモデルのリスト。

private (`bool`) : リポジトリがプライベートかどうか。

region (`Literal["us", "eu"]`, *任意*) : Space が保存されているクラウドリージョン。

resource_group (`dict`, *任意*) : Spaceのリソースグループ情報。

runtime (`SpaceRuntime`、*任意*) : [huggingface_hub.hf_api.SpaceRuntime](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceRuntime) オブジェクトとしての Space ランタイム情報。

sdk (`str`, *任意*) : Spaceで使用されるSDK。

sha (`str`, *任意*) : この特定のリビジョンのリポジトリSHA。

siblings (`list[RepoSibling]`) : Spaceを構成する[huggingface_hub.hf_api.RepoSibling](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.hf_api.RepoSibling)オブジェクトのリスト。

subdomain (`str`, *任意*) : Space のサブドメイン。

tags (`list[str]`) : Spaceのタグのリスト。

trending_score (`int`, *任意*) : Space のトレンドスコア。

used_storage (`int`, *任意*) : Hub 上の Space のサイズ（バイト単位）。

Hub上のSpaceに関する情報を含みます。このオブジェクトは[space_info()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.space_info)および[list_spaces()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_spaces)によって返されます。

> [!TIP]
> このクラスのほとんどの属性はオプションです。これは、Hubが返すデータは発行されたクエリに依存するためです。一般的に、クエリが具体的であればあるほど、より多くの情報が返されます。一方、[list_spaces()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.list_spaces)を使用してスペースをリスト表示する場合、属性のサブセットのみが返されます。

### SpaceSearchResult[[huggingface_hub.SpaceSearchResult]]

#### huggingface_hub.SpaceSearchResult[[huggingface_hub.SpaceSearchResult]]

```python
huggingface_hub.SpaceSearchResult(data: dict)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_space_api.py#L309)

**パラメータ:**

id (`str`) : Space の ID（例: `"username/repo-name"`）。

author (`str`) : Spaceの作成者。

title (`str`) : Space の表示タイトル。

emoji (`str` または `None`) : Space の絵文字アイコン。

sdk (`str` または `None`) : Space で使用されている SDK（例: `"gradio"`、`"docker"`、`"static"`）。

likes (`int`) : いいねの数。

private (`bool`) : Space がプライベートかどうかを示します。

tags (`list[str]` または `None`) : タグのリスト。

runtime ([SpaceRuntime](/docs/huggingface_hub/v2.4.0/ja/package_reference/space_runtime#huggingface_hub.SpaceRuntime) または `None`) : ランタイム情報（ステージ、ハードウェアなど）。

ai_short_description (`str` または `None`) : AI によって生成された短い説明。

ai_category (`str` または `None`) : AI によって生成されたカテゴリ（例: `"Image Generation"`）。

semantic_relevancy_score (`float` または `None`) : 検索クエリに対するセマンティックな関連性スコア（0〜1）。

trending_score (`int` または `None`) : トレンドスコア。

Spacesセマンティック検索APIからの単一の結果。

[HfApi.search_spaces()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.search_spaces)によって返されます。

### TensorInfo[[huggingface_hub.utils.TensorInfo]]

#### huggingface_hub.utils.TensorInfo[[huggingface_hub.utils.TensorInfo]]

```python
huggingface_hub.utils.TensorInfo(dtype: typing.Literal['F64', 'F32', 'F16', 'BF16', 'I64', 'I32', 'I16', 'I8', 'U8', 'U3', 'BOOL'], shape: list, data_offsets: tuple)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/utils/_safetensors.py#L14)

**パラメータ:**

dtype (`str`) : テンソルのデータ型（"F64"、"F32"、"F16"、"BF16"、"I64"、"I32"、"I16"、"I8"、"U8"、"U3"、"BOOL"）。

shape (`list[int]`) : テンソルの形状。

data_offsets (`tuple[int, int]`) : ファイル内のデータのオフセットを`[BEGIN, END]`のタプルとして表したものです。

parameter_count (`int`) : テンソル内のパラメータ数。

テンソルに関する情報。

safetensors形式の詳細については、https://huggingface.co/docs/safetensors/index#format をご覧ください。

### ユーザー[[huggingface_hub.User]]

#### huggingface_hub.User[[huggingface_hub.User]]

```python
huggingface_hub.User(**kwargs)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1658)

**パラメータ:**

username (`str`) : Hub 上のユーザー名（一意）。

fullname (`str`) : ユーザーの氏名。

avatar_url (`str`) : ユーザーのアバター画像のURL。

details (`str`, *任意*) : ユーザーの詳細。

is_following (`bool`, *任意*) : 認証済みユーザーがこのユーザーをフォローしているかどうかを示します。

is_pro (`bool`, *任意*) : ユーザーがプロユーザーかどうかを示します。

num_models (`int`, *任意*) : ユーザーが作成したモデルの数。

num_datasets (`int`, *任意*) : ユーザーが作成したデータセットの数。

num_spaces (`int`, *任意*) : ユーザーが作成したスペースの数。

num_discussions (`int`, *任意*) : ユーザーが開始したディスカッションの数。

num_papers (`int`, *任意*) : ユーザーが著者として執筆した論文の数。

num_upvotes (`int`, *任意*) : ユーザーが獲得した「いいね」の数。

num_likes (`int`, *任意*) : ユーザーが与えた「いいね」の数。

num_following (`int`, *任意*) : このユーザーがフォローしているユーザー数。

num_followers (`int`, *任意*) : このユーザーをフォローしているユーザー数。

orgs (`Organization`のリスト) : ユーザーが所属している組織のリスト。

Hub上のユーザーに関する情報を含みます。

### UserLikes[[huggingface_hub.UserLikes]]

#### huggingface_hub.UserLikes[[huggingface_hub.UserLikes]]

```python
huggingface_hub.UserLikes(user: str, total: int, datasets: list[str], kernels: list[str], models: list[str], spaces: list[str])
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1522)

**パラメータ:**

user (`str`) : いいねを取得したユーザーの名前。

total (`int`) : いいねの総数。

datasets (`list[str]`) : ユーザーが「いいね」したデータセットのリスト（repo_ids として）。

kernels (`list[str]`) : ユーザーが「いいね」したカーネルのリスト（repo_ids として）。

models (`list[str]`) : ユーザーが「いいね」したモデルのリスト（repo_id として）。

spaces (`list[str]`) : ユーザーが「いいね」したスペースのリスト（repo_ids として）。

Hub におけるユーザーの「いいね」に関する情報を含みます。

### WebhookInfo[[huggingface_hub.WebhookInfo]]

#### huggingface_hub.WebhookInfo[[huggingface_hub.WebhookInfo]]

```python
huggingface_hub.WebhookInfo(id: str, url: str | None, job: JobSpec | None, watched: list[WebhookWatchedItem], domains: list[constants.WEBHOOK_DOMAIN_T], secret: str | None, disabled: bool)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L496)

**パラメータ:**

id (`str`) : WebhookのID。

url (`str`, *任意*) : Webhook の URL。

job (`JobSpec`, *任意*) : トリガーする Job の仕様。

watched (`list[WebhookWatchedItem]`) : Webhookが監視しているアイテムのリスト。[WebhookWatchedItem](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.WebhookWatchedItem)を参照してください。

domains (`list[WEBHOOK_DOMAIN_T]`) : Webhookが監視しているドメインのリスト。`["repo", "discussion"]`のいずれかになります。

secret (`str`, *任意*) : Webhookのシークレット。

disabled (`bool`) : Webhookが無効化されているかどうか。

Webhookに関する情報を含むデータ構造。

`url`または`job`のいずれかが指定されていますが、両方が指定されているわけではありません。

### WebhookWatchedItem[[huggingface_hub.WebhookWatchedItem]]

#### huggingface_hub.WebhookWatchedItem[[huggingface_hub.WebhookWatchedItem]]

```python
huggingface_hub.WebhookWatchedItem(type: Literal['bucket', 'dataset', 'model', 'org', 'space', 'user'], name: str)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L480)

**パラメータ:**

type (`Literal["bucket", "dataset", "model", "org", "space", "user"]`) : 監視するアイテムの種類。`["bucket", "dataset", "model", "org", "space", "user"]` のいずれかです。

name (`str`) : 監視するアイテムの名前。ユーザー名、組織名、モデル名、データセット名、スペース名、バケット名のいずれかです。

Webhookによって監視されるアイテムに関する情報を含むデータ構造。

## CommitOperation[[huggingface_hub.CommitOperationAdd]]

`CommitOperation()`でサポートされている値は以下の通りです。

#### huggingface_hub.CommitOperationAdd[[huggingface_hub.CommitOperationAdd]]

```python
huggingface_hub.CommitOperationAdd(path_in_repo: str, path_or_fileobj: str | pathlib.Path | bytes | typing.BinaryIO)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L141)

**パラメータ:**

path_in_repo (`str`) : リポジトリ内の相対ファイルパス。例: `"checkpoints/1fec34a/weights.bin"`

path_or_fileobj (`str`、`Path`、`bytes`、または `BinaryIO`) : 以下のいずれかです: - アップロードするローカルファイルへのパス（`str` または `pathlib.Path`） - アップロードするファイルの内容を保持するバイトのバッファ（`bytes`） - 「ファイルオブジェクト」（`io.BufferedIOBase` のサブクラス）。通常は `open(path, "rb")` で取得します。`seek()` と `tell()` メソッドをサポートする必要があります。

**例外:** ``ValueError``

- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- `path_or_fileobj` が `str`、`Path`、`bytes`、`io.BufferedIOBase` のいずれでもない場合。
- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- `path_or_fileobj` が`str`または`Path`であるが、既存のファイルへのパスではない場合。
- [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- `path_or_fileobj` が `io.BufferedIOBase` であるが、`seek()` と `tell()` の両方をサポートしていない場合。

Hub上のリポジトリにファイルをアップロードするために必要な情報を保持するデータ構造。

#### as_file[[huggingface_hub.CommitOperationAdd.as_file]]

```python
as_file(with_tqdm: bool = False)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L223)

**パラメータ:**

with_tqdm (`bool`、*任意*、デフォルトは`False`) : True の場合、ファイルオブジェクトを反復すると進捗バーが表示されます。ファイルライクオブジェクトがファイルへのパスである場合にのみ動作します。純粋なバイト列やバッファはサポートされていません。

`path_or_fileobj`の背後にある基礎データを、ファイルのようなオブジェクトとして読み取れるようにするコンテキストマネージャーです。

例:

```python
>>> operation = CommitOperationAdd(
...        path_in_repo="remote/dir/weights.h5",
...        path_or_fileobj="./local/weights.h5",
... )
CommitOperationAdd(path_in_repo='remote/dir/weights.h5', path_or_fileobj='./local/weights.h5')

>>> with operation.as_file() as file:
...     content = file.read()

>>> with operation.as_file(with_tqdm=True) as file:
...     while True:
...         data = file.read(1024)
...         if not data:
...              break
config.json: 100%|█████████████████████████| 8.19k/8.19k [00:02<00:00, 3.72kB/s]

>>> with operation.as_file(with_tqdm=True) as file:
...     httpx2.put(..., data=file)
config.json: 100%|█████████████████████████| 8.19k/8.19k [00:02<00:00, 3.72kB/s]
```

#### b64content[[huggingface_hub.CommitOperationAdd.b64content]]

```python
b64content()
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L275)

`path_or_fileobj` の base64 エンコードされた内容

戻り値: `bytes`

#### huggingface_hub.CommitOperationDelete[[huggingface_hub.CommitOperationDelete]]

```python
huggingface_hub.CommitOperationDelete(path_in_repo: str, is_folder: typing.Union[bool, typing.Literal['auto']] = 'auto')
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L56)

**パラメータ:**

path_in_repo (`str`) : リポジトリ内の相対ファイルパス。ファイルの場合は `"checkpoints/1fec34a/weights.bin"`、フォルダの場合は `"checkpoints/1fec34a/"` のように指定します。

is_folder (`bool` または `Literal["auto"]`、*省略可能*) : Delete Operation がフォルダに適用されるかどうかを指定します。"auto" の場合、パスが "/" で終わるかどうか（フォルダ）を調べることで、パスの種類（ファイルまたはフォルダ）が自動的に推測されます。パスの種類を明示的に設定するには、`is_folder=True` または `is_folder=False` を設定できます。

Hub上のリポジトリからファイルまたはフォルダを削除するために必要な情報を保持するデータ構造。

#### huggingface_hub.CommitOperationCopy[[huggingface_hub.CommitOperationCopy]]

```python
huggingface_hub.CommitOperationCopy(src_path_in_repo: str, path_in_repo: str, src_revision: str | None = None, src_repo_id: str | None = None, src_repo_type: str | None = None, _src_oid: str | None = None, _dest_oid: str | None = None, _is_duplicated: bool = False)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L87)

**パラメータ:**

src_path_in_repo (`str`) : コピー対象のファイルのリポジトリ内の相対ファイルパス。例: `"checkpoints/1fec34a/weights.bin"`

path_in_repo (`str`) : ファイルをコピーするリポジトリ内の相対ファイルパス。例: `"checkpoints/1fec34a/weights_copy.bin"`

src_revision (`str`, *任意*) : コピー対象のファイルの git リビジョンです。有効な git リビジョンであれば何でも指定できます。デフォルトでは、ターゲットのコミットリビジョンが使用されます。

src_repo_id (`str`, *optional*) : コピー元のソースリポジトリ（例: `"username/source-model"`）。デフォルトでは、コピー先のリポジトリが使用されます（リポジトリ内コピー）。

src_repo_type (`str`, *任意*) : ソースリポジトリのタイプ (`"model"`、`"dataset"` または `"space"`)。`src_repo_id` が設定されている場合は必須です。

Hub上のリポジトリでファイルをコピーするために必要な情報を保持するデータ構造。

LFSファイルと通常のファイルの両方がサポートされています。LFSファイルはサーバー側でコピーされ、通常のファイルはコミットの一部としてダウンロードされ、再アップロードされます。

`src_repo_id` と `src_repo_type` を設定することで、リポジトリ間のコピーがサポートされています。リポジトリ間の LFS コピーの場合、コミットが作成される前に、LFS オブジェクトが宛先リポジトリに複製されます。これは [create_commit()](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi.create_commit) によって自動的に処理されます。なお、リポジトリ間のコピーは同じ [ストレージリージョン](https://huggingface.co/docs/hub/storage-regions) 内でのみ動作し、リージョンをまたぐコピーはサポートされていません。

注: [CommitOperationCopy](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.CommitOperationCopy)と[CommitOperationDelete](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.CommitOperationDelete)を組み合わせることで、Hub上のLFSファイルをリネームできます。

## CommitScheduler[[huggingface_hub.CommitScheduler]]

#### huggingface_hub.CommitScheduler[[huggingface_hub.CommitScheduler]]

```python
huggingface_hub.CommitScheduler(repo_id: str, folder_path: str | pathlib.Path, every: int | float = 5, path_in_repo: str | None = None, repo_type: str | None = None, revision: str | None = None, private: bool | None = None, token: str | None = None, allow_patterns: list[str] | str | None = None, ignore_patterns: list[str] | str | None = None, squash_history: bool = False, hf_api: typing.Optional[ForwardRef('HfApi')] = None)
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_scheduler.py#L30)

**パラメータ:**

repo_id (`str`) : コミット先リポジトリのID。

folder_path (`str` または `Path`) : 定期的にアップロードするローカルフォルダへのパス。

every (`int`または`float`、*省略可能*) : 各コミット間の間隔（分）。デフォルトは5分です。

path_in_repo (`str`, *任意*) : リポジトリ内のディレクトリの相対パスです。例: `"checkpoints/"`。デフォルトでは、リポジトリのルートフォルダになります。

repo_type (`str`, *任意*) : コミット先のリポジトリの種類。デフォルトは`model`です。

revision (`str`, *任意*) : コミット先リポジトリのリビジョン。デフォルトは`main`です。

private (`bool`, *optional*) : リポジトリを非公開にするかどうか。`None`（デフォルト）の場合、組織のデフォルトが非公開でない限り、リポジトリは公開になります。リポジトリが既に存在する場合、この値は無視されます。

token (`str`, *任意*) : リポジトリにコミットするために使用するトークン。デフォルトでは、マシンに保存されているトークンが使用されます。

allow_patterns (`list[str]` または `str`、*省略可能*) : 指定された場合、少なくとも1つのパターンに一致するファイルのみがアップロードされます。

ignore_patterns (`list[str]` または `str`、*省略可能*) : 指定された場合、これらのパターンのいずれかに一致するファイルはアップロードされません。

squash_history (`bool`, *任意*) : 各コミット後にリポジトリの履歴をスクワッシュするかどうか。デフォルトは`False`です。コミットをスクワッシュすることは、リポジトリが大きくなりすぎた場合のパフォーマンス低下を避けるのに役立ちます。

hf_api (`HfApi`, *任意*) : Hub にコミットするために使用する [HfApi](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.HfApi) クライアントです。カスタム設定（ユーザーエージェント、トークンなど）を設定できます。

ローカルフォルダを一定間隔（例：5分ごとに）でHubにアップロードするためのスケジューラー。

スケジューラーの推奨される使用法は、コンテキストマネージャーとして使用することです。これにより、スクリプトが終了した際にスケジューラーが適切に停止され、最後のコミットがトリガーされることが保証されます。スケジューラーは、`stop` メソッドによって手動で停止することもできます。使用方法の詳細については、[アップロードガイド](https://huggingface.co/docs/huggingface_hub/guides/upload#scheduled-uploads)を参照してください。

例:
```py
>>> from pathlib import Path
>>> from huggingface_hub import CommitScheduler

# Scheduler uploads every 10 minutes
>>> csv_path = Path("watched_folder/data.csv")
>>> CommitScheduler(repo_id="test_scheduler", repo_type="dataset", folder_path=csv_path.parent, every=10)

>>> with csv_path.open("a") as f:
...     f.write("first line")

# Some time later (...)
>>> with csv_path.open("a") as f:
...     f.write("second line")
```

コンテキストマネージャを使用した例:
```py
>>> from pathlib import Path
>>> from huggingface_hub import CommitScheduler

>>> with CommitScheduler(repo_id="test_scheduler", repo_type="dataset", folder_path="watched_folder", every=10) as scheduler:
...     csv_path = Path("watched_folder/data.csv")
...     with csv_path.open("a") as f:
...         f.write("first line")
...     (...)
...     with csv_path.open("a") as f:
...         f.write("second line")

# Scheduler is now stopped and last commit have been triggered
```

#### push_to_hub[[huggingface_hub.CommitScheduler.push_to_hub]]

```python
push_to_hub()
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_scheduler.py#L204)

フォルダを Hub にプッシュし、コミット情報を返します。

> [!WARNING]
> このメソッドは直接呼び出すことを意図していません。スケジューラによってバックグラウンドで実行され、並行コミットを避けるためのキュー機構が尊重されます。メソッドを直接呼び出すと、並行性の問題が発生する可能性があります。

`push_to_hub`のデフォルトの動作は、フォルダをappend-only(追記専用)とみなすことです。フォルダ内のすべてのファイルを列挙し、変更されたファイルのみをアップロードします。変更が見つからない場合、何もコミットせずにメソッドが返ります。この動作を変更したい場合は、[CommitScheduler](/docs/huggingface_hub/v2.4.0/ja/package_reference/hf_api#huggingface_hub.CommitScheduler)を継承して、このメソッドをオーバーライドできます。例えば、コミットする前にデータを1つのファイルに圧縮してまとめる場合に便利です。詳細と例については、[統合ガイド](https://huggingface.co/docs/huggingface_hub/main/en/guides/upload#scheduled-uploads)を参照してください。

#### stop[[huggingface_hub.CommitScheduler.stop]]

```python
stop()
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_scheduler.py#L157)

スケジューラーを停止します。

停止したスケジューラは再開できません。主にテスト目的で使用します。

#### トリガー[[huggingface_hub.CommitScheduler.trigger]]

```python
trigger()
```

[ソース](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_scheduler.py#L181)

`push_to_hub`をトリガーし、futureを返します。

このメソッドは`every`分ごとに自動的に呼び出されます。次のスケジュールされたコミットを待たずに、すぐにコミットをトリガーするために、手動で呼び出すこともできます。