huggingface_hub

Huggingface Hub の公式 Python クライアント。

英語|ドイツ語 | हिंदी | 한국어 | 中文（简体）

---

ドキュメント: https://hf.co/docs/huggingface_hub

ソースコード: https://github.com/huggingface/huggingface_hub

---

ハグフェイスハブライブラリへようこそ

huggingface_hubライブラリを使用すると、クリエイターやコラボレーター向けにオープンソースの機械学習を民主化するプラットフォームである Hugging Face Hub と対話できるようになります。プロジェクト用の事前トレーニングされたモデルとデータセットを発見したり、ハブでホストされている何千もの機械学習アプリを試してみたりできます。独自のモデル、データセット、デモを作成してコミュニティと共有することもできます。 huggingface_hubライブラリは、これらすべてを Python で実行する簡単な方法を提供します。

主な特長

• ハブからファイルをダウンロードします。
• ファイルをハブにアップロードします。
• リポジトリを管理します。
• デプロイされたモデルで推論を実行します。
• モデル、データセット、スペースを検索します。
• モデルカードを共有してモデルを文書化します。
• PR やコメントを通じてコミュニティと関わりましょう。

インストール

pip を使用して、 huggingface_hubパッケージをインストールします。

pip install huggingface_hub

必要に応じて、conda を使用してインストールすることもできます。

デフォルトでパッケージを最小限に保つために、 huggingface_hubには、一部のユースケースに役立つオプションの依存関係が付属しています。たとえば、推論を完全に体験したい場合は、次を実行します。

pip install huggingface_hub[inference]

インストールとオプションの依存関係の詳細については、インストール ガイドを参照してください。

クイックスタート

ファイルをダウンロードする

単一のファイルをダウンロードする

 from huggingface_hub import hf_hub_download

hf_hub_download ( repo_id = "tiiuae/falcon-7b-instruct" , filename = "config.json" )

またはリポジトリ全体

 from huggingface_hub import snapshot_download

snapshot_download ( "stabilityai/stable-diffusion-2-1" )

ファイルはローカル キャッシュ フォルダーにダウンロードされます。詳細については、このガイドをご覧ください。

ログイン

Hugging Face Hub はトークンを使用してアプリケーションを認証します (ドキュメントを参照)。マシンにログインするには、次の CLI を実行します。

huggingface-cli login
# or using an environment variable
huggingface-cli login --token $HUGGINGFACE_TOKEN

リポジトリを作成する

 from huggingface_hub import create_repo

create_repo ( repo_id = "super-cool-model" )

ファイルをアップロードする

単一のファイルをアップロードする

 from huggingface_hub import upload_file

upload_file (
    path_or_fileobj = "/home/lysandre/dummy-test/README.md" ,
    path_in_repo = "README.md" ,
    repo_id = "lysandre/test-model" ,
)

またはフォルダー全体

 from huggingface_hub import upload_folder

upload_folder (
    folder_path = "/path/to/local/space" ,
    repo_id = "username/my-cool-space" ,
    repo_type = "space" ,
)

詳細についてはアップロードガイドをご覧ください。

ハブへの統合。

私たちはクールなオープンソース ML ライブラリと提携して、無料のモデルのホスティングとバージョン管理を提供しています。既存の統合はここで見つけることができます。

利点は次のとおりです。

• 図書館とそのユーザーのための無料のモデルまたはデータセットのホスティング。
• git ベースのアプローチにより、非常に大きなファイルであってもファイルのバージョン管理が組み込まれています。
• すべてのモデルのサーバーレス推論 API が公開されています。
• アップロードされたモデルを操作するためのブラウザ内ウィジェット。
• 誰でもライブラリの新しいモデルをアップロードできます。モデルを検出できるようにするには、対応するタグを追加するだけです。
• 高速ダウンロード！ Cloudfront (CDN) を使用してダウンロードを地理的にレプリケートするため、世界中のどこからでも高速にダウンロードできます。
• 使用状況の統計やその他の機能も追加予定です。

ライブラリを統合したい場合は、お気軽に問題を開いて議論を始めてください。この統合を行う方法を示すステップバイステップのガイドを ❤️ で作成しました。

貢献 (機能リクエスト、バグなど) は大歓迎です ????❤️

誰もが貢献することを歓迎しており、私たちは全員の貢献を尊重します。コードだけがコミュニティを助ける唯一の方法ではありません。質問に答え、他の人を助け、情報を提供し、ドキュメントを改善することは、コミュニティにとって非常に価値があります。私たちは、このリポジトリへの貢献を開始する方法をまとめた貢献ガイドを作成しました。