# リファレンス

# Jobs コマンドラインインターフェース (CLI)

`huggingface_hub` Pythonパッケージには、`hf` という組み込みCLIが付属しています。このツールを使用すると、ターミナルから直接Hugging Face Hubとやり取りできます。例えば、アカウントへのログイン、リポジトリの作成、ファイルのアップロードとダウンロードなどが可能です。また、マシンの設定やキャッシュの管理、Jobsの開始と管理を行うための便利な機能も備わっています。

`hf jobs` のインストール手順、ガイド、リファレンスは、`huggingface_hub` のドキュメントのこちらから確認できます:

* [インストール](https://huggingface.co/docs/huggingface_hub/en/guides/cli#getting-started)
* [ジョブの実行と管理](https://huggingface.co/docs/huggingface_hub/en/guides/cli#hf-jobs)
* [JobsのCLIリファレンス](https://huggingface.co/docs/huggingface_hub/en/package_reference/cli#hf-jobs)

## Pythonクライアント

`huggingface_hub` Pythonパッケージには、`HfApi` というクライアントが同梱されています。このクライアントを使用すると、Pythonから直接Hugging Face Hubとやり取りできます。例えば、アカウントへのログイン、リポジトリの作成、ファイルのアップロードとダウンロードなどが可能です。また、マシンの設定やキャッシュの管理、Jobsの開始と管理を行うための便利な機能も備わっています。

`huggingface_hub`のドキュメントで、インストール手順とガイドを確認してください:

* [インストール](https://huggingface.co/docs/huggingface_hub/en/installation)
* [ジョブの実行と管理](https://huggingface.co/docs/huggingface_hub/en/guides/jobs)

## HTTP API

Jobs HTTP API エンドポイントは `https://huggingface.co/api/jobs` 配下で利用できます。

自分の名前空間（アカウントまたは組織）内で Jobs を開始および管理する権限を持つ Hugging Face トークンを使用して認証します。ヘッダー `"Authorization: Bearer {token}"` に Bearer トークンとしてトークンを渡します。

利用可能なエンドポイントと引数のリストを以下に示します。

* [View Jobs OpenAPI](https://huggingface-openapi.hf.space/#tag/jobs)