Hugging Face's logo

Hub Python Library documentation

Klien HfApi

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Klien HfApi

Berikut adalah dokumentasi untuk kelas HfApi, yang berfungsi sebagai wrapper Python untuk API Hugging Face Hub.

Semua metode dari HfApi juga dapat diakses langsung dari akar paket. Kedua pendekatan tersebut dijelaskan di bawah ini.

Menggunakan metode root lebih langsung, tetapi kelas HfApi memberikan fleksibilitas lebih. Secara khusus, Anda dapat meneruskan token yang akan digunakan kembali di semua panggilan HTTP. Ini berbeda dari hf auth login atau login() karena token tidak disimpan di mesin. Anda juga dapat menyediakan endpoint yang berbeda atau mengonfigurasi user-agent khusus.

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

kelas huggingface_hub.HfApi

< >

( endpoint: str | None = Nonetoken: str | bool | None = Nonelibrary_name: str | None = Nonelibrary_version: str | None = Noneuser_agent: dict | str | None = Noneheaders: dict[str, str] | None = None )

Parameter

  • endpoint (str, opsional) — Endpoint dari Hub. Defaultnya adalah https://huggingface.co.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • library_name (str, opsional) — Nama pustaka yang membuat permintaan HTTP. Akan ditambahkan ke header user-agent. Contoh: "transformers".
  • library_version (str, opsional) — Versi pustaka yang membuat permintaan HTTP. Akan ditambahkan ke header user-agent. Contoh: "4.24.0".
  • user_agent (str, dict, opsional) — Informasi user agent dalam bentuk dictionary atau string tunggal. Informasi ini akan dilengkapi dengan data mengenai paket yang terinstal.
  • headers (dict, opsional) — Header tambahan yang akan dikirim bersama setiap permintaan. Contoh: {"X-My-Header": "value"}. Header yang diteruskan di sini memiliki prioritas lebih tinggi daripada header bawaan.

Klien untuk berinteraksi dengan Hugging Face Hub melalui HTTP.

Klien diinisialisasi dengan beberapa pengaturan tingkat tinggi yang digunakan dalam semua permintaan yang dibuat ke Hub (endpoint HF, autentikasi, user agents…). Penggunaan klien HfApi lebih disarankan, tetapi tidak wajib, karena semua metode publiknya diekspos langsung di akar huggingface_hub.

accept_access_request

< >

( repo_id: struser: str | None = Nonerequest_id: str | None = Nonerepo_type: str | None = Nonetoken: bool | str | None = None )

Parameter

  • repo_id (str) — ID repo untuk menerima permintaan akses.
  • user (str, opsional) — Nama pengguna dari pengguna yang permintaan aksesnya harus diterima. Tepat satu dari user atau request_id harus disediakan.
  • request_id (str, opsional) — ID dari permintaan akses yang akan diterima (lihat AccessRequest). Wajib diisi ketika repo dikonfigurasi untuk tidak membagikan nama pengguna peminta. Tepat satu dari user atau request_id harus disediakan.
  • repo_type (str, opsional) — Jenis repo untuk menerima permintaan akses. Harus salah satu dari model, dataset atau space. Bawaan adalah model.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 jika repo tidak gated.
  • HfHubHTTPError — HTTP 403 jika Anda hanya memiliki akses baca-saja ke repo. Hal ini dapat terjadi jika Anda tidak memiliki peran write atau admin di organisasi tempat repo tersebut berada, atau jika Anda menggunakan token read.
  • HfHubHTTPError — HTTP 404 jika pengguna tidak ada di Hub.
  • HfHubHTTPError — HTTP 404 jika permintaan akses pengguna tidak dapat ditemukan.
  • HfHubHTTPError — HTTP 404 jika permintaan akses pengguna sudah ada dalam daftar yang diterima.

Terima permintaan akses dari pengguna untuk repositori bergerbang tertentu.

Setelah permintaan diterima, pengguna akan dapat mengunduh file apa pun dari repo dan mengakses tab komunitas. Jika mode persetujuan adalah otomatis, Anda tidak perlu menerima permintaan secara manual. Permintaan yang telah diterima dapat dibatalkan atau ditolak kapan saja menggunakan cancel_access_request() dan reject_access_request().

Untuk informasi lebih lanjut tentang repositori bergerbang, lihat https://huggingface.co/docs/hub/models-gated.

add_collection_item

< >

( collection_slug: stritem_id: stritem_type: CollectionItemType_Tnote: str | None = Noneexists_ok: bool = Falsetoken: bool | str | None = None )

Parameter

  • collection_slug (str) — Slug dari koleksi yang akan diperbarui. Contoh: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • item_id (str) — Id dari item yang akan ditambahkan ke koleksi. Gunakan repo_id untuk repos/spaces/datasets, id paper untuk papers, slug dari koleksi lain (mis. "moonshotai/kimi-k2") atau id bucket (mis. "namespace/bucket-name").
  • item_type (str) — Jenis item yang akan ditambahkan. Bisa berupa salah satu dari "model", "dataset", "space", "paper", "collection" atau "bucket".
  • note (str, opsional) — Catatan untuk dilampirkan pada item dalam koleksi. Ukuran maksimum untuk catatan adalah 500 karakter.
  • exists_ok (bool, opsional) — Jika True, jangan lempar error jika item sudah ada.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 403 jika Anda hanya memiliki akses baca-saja ke repo. Hal ini dapat terjadi jika Anda tidak memiliki peran write atau admin di organisasi tempat repo tersebut berada, atau jika Anda menggunakan token read.
  • HfHubHTTPError — HTTP 404 jika item yang Anda coba tambahkan ke koleksi tidak ada di Hub.
  • HfHubHTTPError — HTTP 409 jika item yang Anda coba tambahkan ke koleksi sudah ada di dalam koleksi (dan exists_ok=False)

Tambahkan item ke koleksi di Hub.

Mengembalikan: Koleksi

Contoh:

>>> 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

< >

( repo_id: strkey: strvalue: strdescription: str | None = Nonetoken: bool | str | None = None )

Parameter

  • repo_id (str) — ID repo yang akan diperbarui. Contoh: "bigcode/in-the-stack".
  • key (str) — Kunci rahasia. Contoh: "GITHUB_API_KEY"
  • value (str) — Nilai rahasia. Contoh: "your_github_api_key".
  • description (str, opsional) — Deskripsi rahasia. Contoh: "Github API key to access the Github API".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Menambahkan atau memperbarui rahasia di Space.

Secrets memungkinkan Anda mengatur kunci atau token rahasia ke sebuah Space tanpa perlu menuliskannya secara langsung dalam kode. Untuk detail lebih lanjut, lihat https://huggingface.co/docs/hub/spaces-overview#managing-secrets.

add_space_variable

< >

( repo_id: strkey: strvalue: strdescription: str | None = Nonetoken: bool | str | None = None )

Parameter

  • repo_id (str) — ID repo yang akan diperbarui. Contoh: "bigcode/in-the-stack".
  • key (str) — Kunci variabel. Contoh: "MODEL_REPO_ID"
  • value (str) — Nilai variabel. Contoh: "the_model_repo_id".
  • description (str) — Deskripsi variabel. Contoh: "Model Repo ID of the implemented model".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Menambahkan atau memperbarui variabel di Space.

Variabel memungkinkan Anda mengatur variabel lingkungan untuk sebuah Space tanpa perlu menuliskannya secara langsung dalam kode. Untuk detail lebih lanjut, lihat https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables

auth_check

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = Nonewrite: bool = False )

Parameter

  • repo_id (str) — Repositori yang akan diperiksa aksesnya. Formatnya harus "user/repo_name". Contoh: "user/my-cool-model".
  • repo_type (str, opsional) — Jenis repositori. Harus salah satu dari "model", "dataset", atau "space". Jika tidak ditentukan, nilai defaultnya adalah "model".
  • token (Union[bool, str, None], opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.
  • write (bool, opsional) — Jika True, memeriksa apakah pengguna memiliki izin penulisan konten pada repositori. Jika False (default), hanya memeriksa akses baca.

Membuang

RepositoryNotFoundError atau GatedRepoError

  • RepositoryNotFoundError — Dilempar jika repositori tidak ada, bersifat privat, atau pengguna tidak memiliki akses. Hal ini dapat terjadi jika repo_id atau repo_type salah, atau jika repositori bersifat privat tetapi pengguna tidak terautentikasi.

  • GatedRepoError — Dilempar jika repositori ada tetapi bersifat gated dan pengguna tidak berwenang untuk mengaksesnya.

Periksa apakah token pengguna yang diberikan memiliki akses ke repositori tertentu di Hugging Face Hub.

Metode ini memverifikasi apakah pengguna, yang telah terautentikasi melalui token yang disediakan, memiliki akses ke repositori yang ditentukan. Jika repositori tidak ditemukan atau jika pengguna tidak memiliki izin yang diperlukan untuk mengaksesnya, metode ini akan melempar pengecualian yang sesuai.

Contoh:

Periksa apakah pengguna memiliki akses ke repositori:

>>> 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.")

Pada contoh ini:

  • Jika pengguna memiliki akses, metode tersebut selesai dengan sukses.
  • Jika repositori bersifat gated atau tidak ada, pengecualian yang sesuai akan dilempar, memungkinkan pengguna untuk menanganinya secara memadai.

batch_bucket_files

< >

( bucket_id: stradd: list[tuple[str | Path | bytes, str]] | None = Nonecopy: list[tuple[str, str, str, str]] | None = Nonedelete: list[str] | None = Nonetoken: str | bool | None = None )

Parameter

  • bucket_id (str) — ID dari bucket (mis. "username/my-bucket").
  • add (list of tuple, opsional) — File yang akan diunggah. Setiap elemen adalah tuple (source, destination) di mana source adalah path ke file lokal (str atau Path) atau konten bytes mentah, dan destination adalah path di dalam bucket.
  • copy (list dari tuple, opsional) — File yang akan disalin berdasarkan hash xet. Setiap elemen adalah (source_repo_type, source_repo_id, xet_hash, destination) tuple di mana:
    • source_repo_type adalah tipe dari repositori sumber: "model", "dataset", "space", atau "bucket".
    • source_repo_id adalah ID dari repositori atau bucket sumber (misalnya "username/my-model").
    • xet_hash adalah hash xet dari file yang akan disalin.
    • destination adalah jalur tujuan di dalam bucket. Ini adalah operasi sisi server — tidak ada data yang diunduh atau diunggah ulang.
  • delete (list of str, opsional) — Path file yang akan dihapus dari bucket.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Membuang

BucketBatchError

  • BucketBatchError — Jika server melaporkan bahwa beberapa operasi gagal. Error ini dilempar setelah semua operasi telah dikirim, sehingga operasi lain dalam batch telah diterapkan.

Tambahkan, salin, dan/atau hapus file di dalam bucket.

Ini adalah operasi non-transaksional. Jika terjadi kesalahan dalam prosesnya, beberapa file mungkin sudah diunggah, disalin, atau dihapus, sementara yang lain belum.

Contoh:

>>> 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

< >

( bucket_id: strtoken: bool | str | None = None ) → BucketInfo

Parameter

  • bucket_id (str) — ID dari bucket (mis. "username/my-bucket").
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

BucketInfo

Informasi bucket.

Membuang

BucketNotFoundError atau or

  • BucketNotFoundError — Jika bucket tidak dapat ditemukan. Hal ini mungkin karena bucket tersebut tidak ada,
  • or — karena disetel ke private dan Anda tidak memiliki akses.

Dapatkan informasi tentang bucket tertentu di Hub.

Contoh:

>>> 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

< >

( repo_id: struser: str | None = Nonerequest_id: str | None = Nonerepo_type: str | None = Nonetoken: bool | str | None = None )

Parameter

  • repo_id (str) — ID repo untuk membatalkan permintaan akses.
  • user (str, opsional) — Nama pengguna dari pengguna yang permintaan aksesnya harus dibatalkan. Tepat satu dari user atau request_id harus disediakan.
  • request_id (str, opsional) — ID dari permintaan akses yang akan dibatalkan (lihat AccessRequest). Wajib diisi ketika repo dikonfigurasi untuk tidak membagikan nama pengguna peminta. Tepat satu dari user atau request_id harus disediakan.
  • repo_type (str, opsional) — Jenis repo untuk membatalkan permintaan akses. Harus salah satu dari model, dataset atau space. Bawaan adalah model.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 jika repo tidak gated.
  • HfHubHTTPError — HTTP 403 jika Anda hanya memiliki akses baca-saja ke repo. Hal ini dapat terjadi jika Anda tidak memiliki peran write atau admin di organisasi tempat repo tersebut berada, atau jika Anda menggunakan token read.
  • HfHubHTTPError — HTTP 404 jika pengguna tidak ada di Hub.
  • HfHubHTTPError — HTTP 404 jika permintaan akses pengguna tidak dapat ditemukan.
  • HfHubHTTPError — HTTP 404 jika permintaan akses pengguna sudah ada dalam daftar pending.

Batalkan permintaan akses dari pengguna untuk repo bergerbang tertentu.

Permintaan yang dibatalkan akan kembali ke daftar tertunda dan pengguna akan kehilangan akses ke repo.

Untuk informasi lebih lanjut tentang repositori bergerbang, lihat https://huggingface.co/docs/hub/models-gated.

cancel_job

< >

( job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parameter

  • job_id (str) — ID dari Job.
  • namespace (str, opsional) — Namespace tempat Job berjalan. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Batalkan Job komputasi pada infrastruktur Hugging Face.

change_discussion_status

< >

( repo_id: strdiscussion_num: intnew_status: Literal['open', 'closed']token: bool | str | None = Nonecomment: str | None = Nonerepo_type: str | None = None ) → DiscussionStatusChange

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • discussion_num (int) — Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif.
  • new_status (str) — Status baru untuk diskusi, yaitu "open" atau "closed".
  • comment (str, opsional) — Komentar opsional untuk diposting bersama perubahan status.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

DiscussionStatusChange

peristiwa perubahan status

Menutup atau membuka kembali Diskusi atau Pull Request.

Contoh:

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

Membuang kesalahan berikut:

  • HTTPError jika API HuggingFace mengembalikan error
  • ValueError jika nilai beberapa parameter tidak valid
  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.

diskusi_komentar

< >

( repo_id: strdiscussion_num: intcomment: strtoken: bool | str | None = Nonerepo_type: str | None = None ) → DiscussionComment

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • discussion_num (int) — Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif.
  • comment (str) — Isi komentar yang akan dibuat. Komentar mendukung format markdown.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

KomentarDiskusi

komentar yang baru dibuat

Membuat komentar baru pada Diskusi yang diberikan.

Contoh:


>>> 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', ...)

Membuang kesalahan berikut:

  • HTTPError jika API HuggingFace mengembalikan error
  • ValueError jika nilai beberapa parameter tidak valid
  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.

copy_files

< >

( source: strdestination: strtoken: str | bool | None = None )

Parameter

  • source (str) — Lokasi sumber sebagai URI hf://. Bisa berupa jalur bucket (mis. "hf://buckets/my-bucket/path/to/file") atau jalur repo (mis. "hf://username/my-model/weights.bin", "hf://datasets/username/my-dataset/data/").
  • destination (str) — Lokasi tujuan sebagai URI hf:// yang menunjuk ke bucket (mis. "hf://buckets/my-bucket/target/path") atau repositori (mis. "hf://username/my-model/target/path").
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Membuang

ValueError

  • ValueError — Jika URI sumber/destinasi tidak valid atau jika menyalin dari bucket ke repo.

Salin file di antara lokasi di Hub.

Salin file dari bucket atau repositori (model, dataset, space) ke bucket atau repositori lain. File individual dan folder utuh didukung.

Saat menyalin folder, / di akhir path sumber menggunakan semantik gaya rsync: menyalin isi folder ke tujuan, tanpa menelusuri folder sumber itu sendiri. Tanpa / di akhir, folder sumber akan ditelusuri di dalam tujuan (seperti cp -r).

Saat menyalin dari repositori ke bucket, file .gitattributes secara otomatis dikecualikan karena merupakan metadata khusus git dan tidak relevan dalam konteks bucket.

Salinan antar-repo menggunakan CommitOperationCopy di balik layar dan membuat commit pada repositori tujuan. Salinan dari bucket ke repo tidak didukung.

Salinan sisi server hanya berfungsi di dalam region penyimpanan yang sama.

Contoh:

>>> 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

< >

( repo_id: strbranch: strrevision: str | None = Nonetoken: bool | str | None = Nonerepo_type: str | None = Noneexist_ok: bool = False )

Parameter

  • repo_id (str) — Repositori tempat cabang akan dibuat. Contoh: "user/my-cool-model".
  • branch (str) — Nama branch yang akan dibuat.
  • revision (str, opsional) — Revisi git untuk membuat cabang dari. Bisa berupa nama cabang atau OID/SHA dari commit, sebagai string heksadesimal. Bawaan adalah head dari cabang "main".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika membuat branch pada dataset atau space, None atau "model" jika memberi tag pada model. Default adalah None.
  • exist_ok (bool, opsional, default False) — Jika True, jangan lempar error jika cabang sudah ada.

Membuang

RepositoryNotFoundError atau BadRequestError atau HfHubHTTPError

  • RepositoryNotFoundError — Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada.
  • BadRequestError — Jika referensi untuk branch tidak valid. Contoh: refs/pr/5 atau ‘refs/foo/bar’.
  • HfHubHTTPError — Jika cabang sudah ada di repo (error 409) dan exist_ok diatur ke False.

Buat cabang baru untuk repositori di Hub, dimulai dari revisi yang ditentukan (defaultnya main). Untuk menemukan revisi yang sesuai dengan kebutuhan Anda, Anda dapat menggunakan list_repo_refs() atau list_repo_commits().

create_bucket

< >

( bucket_id: strprivate: bool | None = Nonevisibility: Literal['public', 'private'] | None = Noneresource_group_id: str | None = Noneregion: REPO_REGIONS | None = Noneexist_ok: bool = Falsetoken: bool | str | None = None ) → BucketUrl

Parameter

  • bucket_id (str) — Namespace (pengguna atau organisasi) dan nama bucket yang dipisahkan oleh /. Jika namespace tidak diberikan, bucket akan dibuat di namespace pengguna saat ini.
  • private (bool, opsional) — Apakah membuat bucket menjadi privat. Jika None (default), bucket akan menjadi publik kecuali default organisasi adalah privat. Tidak dapat dilewatkan bersamaan dengan visibility.
  • visibility (Literal["public", "private"], opsional) — Visibilitas bucket. Bisa berupa "public" atau "private". Jika None (default), bucket akan bersifat publik kecuali default organisasi adalah privat.
  • resource_group_id (str, opsional) — Grup sumber daya tempat bucket akan dibuat. Grup sumber daya hanya tersedia untuk organisasi Enterprise Hub dan memungkinkan Anda mendefinisikan anggota organisasi mana yang dapat mengakses sumber daya tersebut. ID grup sumber daya dapat ditemukan di URL halaman sumber daya di Hub (mis. "66670e5163145ca562cb1988"). Untuk mempelajari lebih lanjut tentang grup sumber daya, lihat https://huggingface.co/docs/hub/en/security-resource-groups.
  • region (Literal["us", "eu"], opsional) — Wilayah cloud tempat bucket akan dibuat. Bisa berupa "us" atau "eu". Jika tidak ditentukan, bucket akan dibuat di wilayah default. Memerlukan paket Team atau di atasnya.
  • exist_ok (bool, opsional, defaultnya False) — Jika True, jangan lempar error jika bucket sudah ada.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

BucketUrl

URL ke bucket yang baru dibuat yang berisi atribut seperti endpoint, namespace, dan bucket_id.

Buat bucket di Hub.

Contoh:

>>> 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

< >

( title: strnamespace: str | None = Nonedescription: str | None = Noneprivate: bool = Falseresource_group_id: str | None = Noneexists_ok: bool = Falsetoken: bool | str | None = None )

Parameter

  • title (str) — Judul koleksi yang akan dibuat. Contoh: "Recent models".
  • namespace (str, opsional) — Namespace dari koleksi yang akan dibuat (nama pengguna atau organisasi). Secara default akan menggunakan nama pemilik.
  • description (str, opsional) — Deskripsi dari koleksi yang akan dibuat. Ukuran maksimum untuk deskripsi adalah 150 karakter.
  • private (bool, opsional) — Apakah koleksi harus bersifat privat atau tidak. Bawaan adalah False (yaitu koleksi publik).
  • resource_group_id (str, opsional) — Tugaskan koleksi ke grup sumber daya organisasi pemilik. Hanya valid untuk koleksi yang dimiliki organisasi. ID grup sumber daya adalah string heksadesimal 24 karakter.
  • exists_ok (bool, opsional) — Jika True, jangan lempar error jika koleksi sudah ada.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Buat Collection baru di Hub.

Mengembalikan: Koleksi

Contoh:

>>> 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

< >

( repo_id: stroperations: Iterable[CommitOperation]commit_message: strcommit_description: str | None = Nonetoken: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecreate_pr: bool | None = Nonenum_threads: int = 5parent_commit: str | None = Nonerun_as_future: bool = False_hot_reload: bool | None = None ) → CommitInfo or Future

Parameter

  • repo_id (str) — Repositori tempat commit akan dibuat, misalnya: "username/custom_transformers"
  • operations (Iterable dari ~hf_api.CommitOperation) — Iterable operasi yang akan disertakan dalam commit, yaitu:
    • ~hf_api.CommitOperationAdd untuk mengunggah file
    • ~hf_api.CommitOperationDelete untuk menghapus file
    • ~hf_api.CommitOperationCopy untuk menyalin file

    Objek operasi akan dimutasi untuk menyertakan informasi yang berkaitan dengan unggahan. Jangan gunakan objek yang sama untuk beberapa commit.

  • commit_message (str) — Ringkasan (baris pertama) dari commit yang akan dibuat.
  • commit_description (str, opsional) — Deskripsi dari commit yang akan dibuat
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • repo_type (str, opsional) — Atur ke "dataset", "space" atau "kernel" jika mengunggah ke repo dataset, space, atau kernel; None atau "model" jika mengunggah ke model. Default adalah None.
  • revision (str, opsional) — Revisi git untuk di-commit. Secara default menggunakan head dari cabang "main".
  • create_pr (boolean, opsional) — Apakah akan membuat Pull Request dengan commit tersebut. Defaultnya False. Jika revision tidak diset, PR dibuka terhadap cabang "main". Jika revision diset dan merupakan cabang, PR dibuka terhadap cabang ini. Jika revision diset dan bukan nama cabang (contoh: oid commit), RevisionNotFoundError dikembalikan oleh server.
  • num_threads (int, opsional) — Jumlah thread konkuren untuk mengunggah file. Defaultnya 5. Mengaturnya ke 2 berarti maksimal 2 file akan diunggah secara bersamaan.
  • parent_commit (str, opsional) — OID / SHA dari commit induk, sebagai string heksadesimal. Bentuk singkat (7 karakter pertama) juga didukung. Jika ditentukan dan create_pr adalah False, commit akan gagal jika revision tidak menunjuk ke parent_commit. Jika ditentukan dan create_pr adalah True, pull request akan dibuat dari parent_commit. Menentukan parent_commit memastikan repo tidak berubah sebelum perubahan di-commit, dan dapat sangat berguna jika repo diperbarui / di-commit secara bersamaan.
  • run_as_future (bool, opsional) — Apakah metode ini akan dijalankan di latar belakang. Tugas latar belakang dijalankan secara berurutan tanpa memblokir utas utama. Mengirimkan run_as_future=True akan mengembalikan objek Future. Bawaan adalah False.

Mengembalikan

CommitInfo atau Future

Instance of CommitInfo yang berisi informasi tentang commit yang baru dibuat (commit hash, commit url, pr url, commit message,…). Jika run_as_future=True diteruskan, mengembalikan objek Future yang akan berisi hasil saat dieksekusi.

Membuang

ValueError atau RepositoryNotFoundError

  • ValueError — Jika pesan commit kosong.
  • ValueError — Jika parent commit bukan commit OID yang valid.
  • ValueError — Jika file README.md dengan bagian metadata yang tidak valid di-commit. Dalam kasus ini, commit akan gagal sebelumnya, sebelum mencoba mengunggah file apa pun.
  • ValueError — Jika create_pr adalah True dan revisi bukan None maupun "main".
  • RepositoryNotFoundError — Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada.

Membuat commit di repo yang diberikan, menghapus & mengunggah file sesuai kebutuhan.

Daftar input CommitOperation akan dimutasi selama proses commit. Jangan gunakan objek yang sama untuk beberapa commit.

create_commit mengasumsikan bahwa repo sudah ada di Hub. Jika Anda mendapatkan Client error 404, pastikan Anda sudah terautentikasi, token Anda memiliki izin yang diperlukan, dan repo_id serta repo_type diatur dengan benar. Jika repo belum ada, buat terlebih dahulu menggunakan create_repo().

create_commit dibatasi hingga 25k file LFS dan payload 1GB untuk file reguler.

create_discussion

< >

( repo_id: strtitle: strtoken: bool | str | None = Nonedescription: str | None = Nonerepo_type: str | None = Nonepull_request: bool = False )

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • title (str) — Judul diskusi. Panjangnya maksimal 200 karakter, dan minimal 3 karakter. Spasi di awal dan akhir akan dihapus.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • description (str, opsional) — Deskripsi opsional untuk Pull Request. Nilai defaultnya adalah "Discussion opened with the huggingface_hub Python library"
  • pull_request (bool, opsional) — Apakah akan membuat Pull Request atau diskusi. Jika True, membuat Pull Request. Jika False, membuat diskusi. Bawaan adalah False.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model. Default adalah None.

Membuat Diskusi atau Pull Request.

Pull Requests yang dibuat secara programatik akan berstatus "draft".

Membuat Pull Request dengan perubahan juga dapat dilakukan sekaligus menggunakan HfApi.create_commit().

Mengembalikan: DiscussionWithDetails

Membuang kesalahan berikut:

  • HTTPError jika API HuggingFace mengembalikan error
  • ValueError jika nilai beberapa parameter tidak valid
  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.

create_inference_endpoint

< >

( name: strrepository: strframework: straccelerator: strinstance_size: strinstance_type: strregion: strvendor: straccount_id: str | None = Noneprivate_link_account_id: str | None = Noneprivate_link_region: str | None = Nonemin_replica: int = 1max_replica: int = 1scaling_metric: InferenceEndpointScalingMetric | None = Nonescaling_threshold: float | None = Nonescale_to_zero_timeout: int | None = Nonerevision: str | None = Nonetask: str | None = Nonecustom_image: dict | None = Nonecontainer_registry_username: str | None = Nonecontainer_registry_password: str | None = Nonecontainer_command: list[str] | None = Nonecontainer_args: list[str] | None = Noneenv: dict[str, str] | None = Nonesecrets: dict[str, str] | None = Nonetype: InferenceEndpointType | str = <InferenceEndpointType.AUTHENTICATED: 'authenticated'>domain: str | None = Nonepath: str | None = Nonecache_http_responses: bool | None = Nonetags: list[str] | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Parameter

  • name (str) — Nama unik untuk Inference Endpoint baru.
  • repository (str) — Nama repositori model yang terkait dengan Inference Endpoint (misalnya "gpt2").
  • framework (str) — Framework machine learning yang digunakan untuk model (misalnya "custom").
  • accelerator (str) — Akselerator perangkat keras yang akan digunakan untuk inferensi (misalnya "cpu").
  • instance_size (str) — Ukuran atau tipe instance yang akan digunakan untuk hosting model (mis. "x4").
  • instance_type (str) — Jenis instance cloud tempat Inference Endpoint akan di-deploy (misalnya "intel-icl").
  • region (str) — Wilayah cloud tempat Inference Endpoint akan dibuat (mis. "us-east-1").
  • vendor (str) — Penyedia cloud atau vendor tempat Inference Endpoint akan dihosting (misalnya "aws").
  • account_id (str, opsional) — Tidak lagi digunakan dan diabaikan. Gunakan private_link_account_id dan private_link_region untuk mengonfigurasi AWS PrivateLink.
  • private_link_account_id (str, opsional) — ID akun AWS yang diizinkan untuk mencapai Inference Endpoint melalui AWS PrivateLink. Memerlukan private_link_region.
  • private_link_region (str, opsional) — Region AWS dari titik masuk PrivateLink ("us-east-1" atau "eu-west-1"), tempat endpoint VPC dari private_link_account_id akan terhubung. Tidak bergantung pada region dan vendor komputasi.
  • min_replica (int, opsional) — Jumlah minimum replika (instans) yang harus tetap berjalan untuk Inference Endpoint. Untuk mengaktifkan scaling ke nol, atur nilai ini ke 0 dan sesuaikan scale_to_zero_timeout secara sesuai. Nilai default adalah 1.
  • max_replica (int, opsional) — Jumlah maksimum replika (instans) untuk diskalakan pada Inference Endpoint. Nilai defaultnya adalah 1.
  • scaling_metric (str atau InferenceEndpointScalingMetric , opsional) — Referensi metrik untuk scaling. Yaitu “pendingRequests” atau “hardwareUsage” saat diberikan. Defaultnya None (artinya: biarkan layanan HF Endpoints yang menentukan metriknya).
  • scaling_threshold (float, opsional) — Ambang batas metrik penskalaan yang digunakan untuk memicu peningkatan skala. Diabaikan jika metrik penskalaan tidak diberikan. Nilai default adalah None (artinya: biarkan layanan HF Endpoints yang menentukan ambang batasnya).
  • scale_to_zero_timeout (int, opsional) — Durasi dalam menit sebelum endpoint yang tidak aktif diskalakan menjadi nol, atau tidak ada penskalaan ke nol jika diatur ke None dan min_replica bukan 0. Defaultnya adalah None.
  • revision (str, opsional) — Revisi model spesifik yang akan di-deploy pada Inference Endpoint (mis. "6c0e6080953db56375760c0471a8c5f2929baf11").
  • task (str, opsional) — Tugas di mana model akan di-deploy (misalnya "text-classification").
  • custom_image (dict, opsional) — Gambar container yang akan dijalankan. Bisa berupa dict yang dikey berdasarkan varian gambar (mis. {"vLLM": {"url": "vllm/vllm-openai:v0.23.0", "port": 8000}‌}, juga sGLang, tgi, tei, llamacpp, hfServe, …), yang diteruskan apa adanya, atau dict datar yang menggambarkan container kustom (mis. {"url": ..., "port": ...}), yang dikirim sebagai {"custom": ...} (lihat contoh). Secara default menggunakan gambar yang dikelola Hugging Face.
  • container_registry_username (str, opsional) — Nama pengguna yang digunakan untuk autentikasi dengan registry yang menampung gambar container kustom.
  • container_registry_password (str, opsional) — Kata sandi yang digunakan untuk autentikasi dengan registry yang menampung gambar container kustom. Memerlukan container_registry_username. Diabaikan dari payload API jika tidak disediakan.
  • container_command (list[str], opsional) — Timpa perintah entrypoint kontainer (dipetakan ke model.command dalam payload API). Berfungsi dengan baik pada gambar mesin yang dikelola (mis. vLLM, SGLang) maupun gambar kustom.
  • container_args (list[str], opsional) — Argumen yang ditambahkan ke entrypoint container (dipetakan ke model.args dalam payload API). Berfungsi dengan baik pada gambar engine yang dikelola (misalnya vLLM, SGLang) maupun gambar kustom.
  • env (dict[str, str], opsional) — Variabel lingkungan non-rahasia untuk disuntikkan ke lingkungan kontainer.
  • secrets (dict[str, str], opsional) — Nilai rahasia untuk disuntikkan ke lingkungan container.
  • type ([`InferenceEndpointType], *optional*) -- The type of the Inference Endpoint, which can be “authenticated”(default),“public”or“private”`.
  • domain (str, opsional) — Domain kustom untuk deployment Inference Endpoint; jika disetel, inference endpoint akan tersedia di domain ini (mis. "my-new-domain.cool-website.woof").
  • path (str, opsional) — Path kustom ke model yang di-deploy, harus diawali dengan / (mis. "/models/google-bert/bert-base-uncased").
  • cache_http_responses (bool, opsional) — Apakah akan meng-cache respons HTTP dari Inference Endpoint. Defaultnya adalah False.
  • tags (list[str], opsional) — Daftar tag untuk dikaitkan dengan Inference Endpoint.
  • namespace (str, opsional) — Namespace tempat Inference Endpoint akan dibuat. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

InferenceEndpoint

informasi tentang Inference Endpoint yang diperbarui.

Buat Inference Endpoint baru.

Nilai accelerator, instance_size, instance_type, region, dan vendor saling bergantung; gunakan list_inference_endpoints_hardware() untuk menampilkan kombinasi yang valid.

Contoh:

>>> 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(...)
"..."
# 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"],
... )
# 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

< >

( repo_id: str | None = Nonerecipe_id: str | None = Nonename: str | None = Noneaccelerator: Literal['cpu', 'gpu', 'neuron'] | str | None = Nonegguf_file: str | None = Nonetoken: bool | str | None = Nonenamespace: str | None = None ) → InferenceEndpoint

Parameter

  • repo_id (str, opsional) — ID model di katalog yang akan di-deploy sebagai Inference Endpoint. Saling eksklusif dengan recipe_id.
  • recipe_id (str, opsional) — ID resep katalog yang akan di-deploy (lihat InferenceCatalogRecipe). Saling eksklusif dengan repo_id.
  • name (str, opsional) — Nama unik untuk Inference Endpoint baru. Jika tidak disediakan, nama acak akan dibuat.
  • accelerator (str, opsional) — Akselerator perangkat keras yang akan digunakan untuk inferensi. Nilai yang mungkin termasuk "cpu", "gpu", dan "neuron". Jika tidak disediakan, server akan menggunakan default yang sesuai untuk model. Hanya valid dengan repo_id.
  • gguf_file (str, opsional) — File GGUF yang akan di-deploy, untuk model yang memiliki satu resep per kuantisasi (mis. "Qwen2.5-Coder-32B-Instruct-Q4_K_M.gguf"). Hanya valid dengan repo_id.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication).
  • namespace (str, opsional) — Namespace tempat Inference Endpoint akan dibuat. Secara default menggunakan namespace pengguna saat ini.

Mengembalikan

InferenceEndpoint

informasi tentang Inference Endpoint baru.

Buat Inference Endpoint baru dari Hugging Face Inference Catalog.

Tujuan dari Inference Catalog adalah menyediakan daftar model yang dikurasi, yang dioptimalkan untuk inferensi dan telah diuji dengan konfigurasi default. Lihat https://endpoints.huggingface.co/catalog untuk daftar model yang tersedia di katalog.

Setiap model katalog di-deploy melalui resep: kombinasi perangkat keras dan mesin yang telah diuji untuknya. Luluskan repo_id untuk mendeploy resep default dari sebuah model, yang secara opsional dapat dipersempit dengan accelerator dan gguf_file, atau luluskan recipe_id untuk mendeploy resep persis yang terdaftar oleh list_inference_catalog().

create_inference_endpoint_from_catalog bersifat eksperimental. API-nya dapat berubah di masa depan. Silakan berikan umpan balik jika Anda memiliki saran atau permintaan.

create_pull_request

< >

( repo_id: strtitle: strtoken: bool | str | None = Nonedescription: str | None = Nonerepo_type: str | None = None )

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • title (str) — Judul diskusi. Panjangnya maksimal 200 karakter, dan minimal 3 karakter. Spasi di awal dan akhir akan dihapus.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • description (str, opsional) — Deskripsi opsional untuk Pull Request. Nilai defaultnya adalah "Discussion opened with the huggingface_hub Python library"
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model. Default adalah None.

Membuat Pull Request. Pull Request yang dibuat secara programatik akan berstatus "draft".

Membuat Pull Request dengan perubahan juga dapat dilakukan sekaligus dengan HfApi.create_commit();

Ini adalah pembungkus di sekitar HfApi.create_discussion().

Mengembalikan: DiscussionWithDetails

Membuang kesalahan berikut:

  • HTTPError jika API HuggingFace mengembalikan error
  • ValueError jika nilai beberapa parameter tidak valid
  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.

create_repo

< >

( repo_id: strtoken: str | bool | None = Noneprivate: bool | None = Nonevisibility: RepoVisibility_T | None = Nonerepo_type: str | None = Noneexist_ok: bool = Falseresource_group_id: str | None = Noneregion: REPO_REGIONS | None = Nonespace_sdk: str | None = Nonespace_hardware: SpaceHardware | None = Nonespace_sleep_time: int | None = Nonespace_secrets: list[dict[str, str]] | None = Nonespace_variables: list[dict[str, str]] | None = Nonespace_volumes: list[Volume] | None = Nonespace_template: str | None = None ) → RepoUrl

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • private (bool, opsional) — Apakah akan membuat repo menjadi privat. Jika None (default), repo akan menjadi publik kecuali default organisasi adalah privat. Nilai ini diabaikan jika repo sudah ada. Tidak dapat dilewatkan bersamaan dengan visibility.
  • visibility (Literal["public", "private", "protected"], opsional) — Visibilitas repo. Bisa berupa "public" atau "private", atau "protected" untuk Spaces. Jika None (bawaan), repo akan bersifat publik kecuali bawaan organisasi adalah privat. Nilai ini diabaikan jika repo sudah ada.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model. Default adalah None.
  • exist_ok (bool, opsional, default False) — Jika True, jangan lempar error jika repo sudah ada.
  • resource_group_id (str, opsional) — Grup sumber daya tempat repositori akan dibuat. Grup sumber daya hanya tersedia untuk organisasi Enterprise Hub dan memungkinkan Anda mendefinisikan anggota organisasi mana yang dapat mengakses sumber daya tersebut. ID grup sumber daya dapat ditemukan di URL halaman sumber daya di Hub (mis. "66670e5163145ca562cb1988"). Untuk mempelajari lebih lanjut tentang grup sumber daya, lihat https://huggingface.co/docs/hub/en/security-resource-groups.
  • region (Literal["us", "eu"], opsional) — Wilayah cloud tempat repositori akan dibuat. Bisa berupa "us" atau "eu". Jika tidak ditentukan, repositori akan dibuat di wilayah default. Memerlukan paket Team atau di atasnya.
  • space_sdk (str, opsional) — Pilihan SDK yang digunakan jika repo_type adalah “space”. Bisa berupa “streamlit”, “gradio”, “docker”, atau “static”. Spaces "static" gratis untuk semua orang. SDK lain berjalan di compute: pada hardware gratis cpu-basic, mereka memerlukan langganan (PRO untuk pengguna, Team atau Enterprise untuk organisasi), sedangkan hardware berbayar hanya memerlukan billing (metode pembayaran dan kredit prabayar).
  • space_hardware (SpaceHardware atau str, opsional) — Pilihan Hardware jika repo_type adalah “space”. Lihat SpaceHardware untuk daftar lengkap.
  • space_sleep_time (int, opsional) — Jumlah detik tidak aktif yang harus ditunggu sebelum sebuah Space masuk ke mode tidur. Atur ke -1 jika Anda tidak ingin Space Anda tidur (perilaku bawaan untuk perangkat keras yang ditingkatkan). Untuk perangkat keras gratis, Anda tidak dapat mengatur waktu tidur (nilai tetap pada 48 jam tidak aktif). Lihat https://huggingface.co/docs/hub/spaces-gpus#sleep-time untuk detail lebih lanjut.
  • space_secrets (list[dict[str, str]], opsional) — Daftar kunci rahasia untuk disetel di Space Anda. Setiap item berbentuk {"key": ..., "value": ..., "description": ...} di mana description bersifat opsional. Untuk detail lebih lanjut, lihat https://huggingface.co/docs/hub/spaces-overview#managing-secrets.
  • space_variables (list[dict[str, str]], opsional) — Daftar variabel lingkungan publik yang akan disetel di Space Anda. Setiap item berbentuk {"key": ..., "value": ..., "description": ...} di mana description bersifat opsional. Untuk detail lebih lanjut, lihat https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables.
  • space_volumes (list[Volume], opsional) — Daftar objek Volume untuk dipasang di Space saat pembuatan. Setiap volume memiliki type ("bucket", "model", "dataset", atau "space"), source (ID repo atau bucket), mount_path (jalur di dalam container), serta field opsional revision, read_only, dan path. Hanya berlaku jika repo_type adalah “space”.
  • space_template (str, opsional) — Buat Space baru dari template resmi. Bisa berupa id repo template (mis. "SpacesExamples/jupyterlab") atau nama singkatnya (mis. "JupyterLab"). Gunakan HfApi.list_space_templates() untuk melihat daftar template yang tersedia. Hanya berlaku jika repo_type adalah “space”. Jika template disarankan untuk dibuat privat dan visibility tidak diatur secara eksplisit, Space dibuat sebagai privat.

Mengembalikan

RepoUrl

URL ke repo yang baru dibuat. Nilainya adalah subclass dari str yang berisi atribut seperti endpoint, repo_type dan repo_id.

Buat repositori kosong di HuggingFace Hub.

create_scheduled_job

< >

( image: strcommand: list[str]schedule: strsuspend: bool | None = Noneconcurrency: bool | None = Noneenv: dict[str, Any] | None = Nonesecrets: dict[str, Any] | None = Noneflavor: JobHardware | str | None = Nonetimeout: int | float | str | None = Noneattempts: int | None = Nonename: str | None = Nonelabels: dict[str, str] | None = Nonevolumes: list[Volume] | None = Noneexpose: list[int] | None = Noneexpose_public: list[int] | None = Noneresource_group_id: str | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None )

Parameter

  • image (str) — Gambar Docker yang akan digunakan. Contoh: "ubuntu", "python:3.12", "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel". Contoh dengan gambar dari Space: "hf.co/spaces/lhoestq/duckdb".
  • command (list[str]) — Perintah yang akan dijalankan. Contoh: ["echo", "hello"].
  • schedule (str) — Salah satu dari “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly”, atau ekspresi jadwal CRON (misalnya, ‘0 9 * * 1’ untuk pukul 09.00 setiap Senin).
  • suspend (bool, opsional) — Jika True, Job yang dijadwalkan akan ditangguhkan (dijeda). Defaultnya False.
  • concurrency (bool, opsional) — Jika True, beberapa instans dari Job ini dapat berjalan secara bersamaan. Defaultnya False.
  • env (dict[str, Any], opsional) — Menentukan variabel lingkungan untuk Job.
  • secrets (dict[str, Any], opsional) — Menentukan variabel lingkungan rahasia untuk Job.
  • flavor (str, opsional) — Flavor untuk perangkat keras. Lihat JobHardware untuk nilai yang mungkin. Nilai default adalah "cpu-basic".
  • timeout (Union[int, float, str], opsional) — Durasi maksimum untuk Job: int dengan s (detik, default), m (menit), h (jam) atau d (hari). Contoh: 300 atau "5m" untuk 5 menit.
  • attempts (int, opsional) — Jumlah maksimum percobaan untuk setiap run, termasuk percobaan awal. Defaultnya adalah 1.
  • name (str, opsional) — Nama untuk Job yang dijadwalkan. Disimpan sebagai label name. Tidak dapat diteruskan bersamaan dengan kunci name di labels. Nama tidak harus unik. Secara default, nama diturunkan dari image dan command (dengan akhiran hash pendek).
  • labels (dict[str, str], opsional) — Label yang akan dilampirkan ke job (pasangan kunci-nilai).
  • volumes (list[Volume], opsional) — Hugging Face Buckets atau Repos yang akan dipasang sebagai volume di dalam kontainer job. Setiap volume adalah Volume dengan type ("bucket", "model", "dataset", atau "space"), source (mis. "username/my-bucket"), dan mount_path (mis. "/data").
  • expose (list[int], opsional) — Port container yang akan diekspos melalui proxy jobs. Setiap port yang terdaftar dapat diakses di domain jobs publik (mis. https://<job_id>--8000.hf.jobs). Akses selalu memerlukan token HF dengan izin baca pada namespace job tersebut. Gunakan expose_public untuk akses tanpa autentikasi.
  • expose_public (list[int], opsional) — Port yang akan diekspos melalui proxy Jobs tanpa autentikasi. Port ini tidak perlu dicantumkan dalam expose.
  • resource_group_id (str, opsional) — ID dari resource group tempat Job terjadwal akan dibuat. Digunakan untuk mengontrol akses ke sumber daya di dalam organisasi dan untuk fitur atribusi biaya/batas pengeluaran. Jika tidak disediakan, Job terjadwal akan dibuat di luar resource group mana pun.
  • namespace (str, opsional) — Namespace tempat Job akan dibuat. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Buat Jobs komputasi terjadwal pada infrastruktur Hugging Face.

Contoh:

Buat Job terjadwal pertama Anda:

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

Gunakan ekspresi jadwal CRON:

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

Buat Job GPU terjadwal:

>>> 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

< >

( script: strscript_args: list[str] | None = Noneschedule: strsuspend: bool | None = Noneconcurrency: bool | None = Nonedependencies: list[str] | None = Nonepython: str | None = Noneimage: str | None = Noneenv: dict[str, Any] | None = Nonesecrets: dict[str, Any] | None = Noneflavor: JobHardware | str | None = Nonetimeout: int | float | str | None = Noneattempts: int | None = Nonename: str | None = Nonelabels: dict[str, str] | None = Nonevolumes: list[Volume] | None = Noneexpose: list[int] | None = Noneexpose_public: list[int] | None = Noneresource_group_id: str | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None )

Parameter

  • script (str) — Path atau URL dari skrip UV, atau sebuah perintah.
  • script_args (list[str], opsional) — Argumen untuk diteruskan ke skrip, atau perintah.
  • schedule (str) — Salah satu dari “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly”, atau ekspresi jadwal CRON (misalnya, ‘0 9 * * 1’ untuk pukul 09.00 setiap Senin).
  • suspend (bool, opsional) — Jika True, Job yang dijadwalkan akan ditangguhkan (dijeda). Defaultnya False.
  • concurrency (bool, opsional) — Jika True, beberapa instans dari Job ini dapat berjalan secara bersamaan. Defaultnya False.
  • dependencies (list[str], opsional) — Dependensi yang digunakan untuk menjalankan skrip UV.
  • python (str, opsional) — Gunakan versi Python tertentu. Default adalah 3.12.
  • image (str, opsional, default “ghcr.io/astral-sh/uv —python3.12-bookworm”): Gunakan image Docker kustom dengan uv yang sudah terpasang.
  • env (dict[str, Any], opsional) — Menentukan variabel lingkungan untuk Job.
  • secrets (dict[str, Any], opsional) — Menentukan variabel lingkungan rahasia untuk Job.
  • flavor (str, opsional) — Flavor untuk perangkat keras. Lihat JobHardware untuk nilai yang mungkin. Nilai default adalah "cpu-basic".
  • timeout (Union[int, float, str], opsional) — Durasi maksimum untuk Job: int dengan s (detik, default), m (menit), h (jam) atau d (hari). Contoh: 300 atau "5m" untuk 5 menit.
  • attempts (int, opsional) — Jumlah maksimum percobaan untuk setiap run, termasuk percobaan awal. Defaultnya adalah 1.
  • name (str, opsional) — Nama untuk Job yang dijadwalkan. Disimpan sebagai label name. Tidak dapat diteruskan bersamaan dengan kunci name di labels. Nama tidak harus unik. Secara default, nama diturunkan dari skrip dan argumennya (dengan akhiran hash pendek).
  • labels (dict[str, str], opsional) — Label yang akan dilampirkan ke job (pasangan kunci-nilai).
  • volumes (list[Volume], opsional) — Hugging Face Buckets atau Repos yang akan dipasang sebagai volume di dalam kontainer job. Setiap volume adalah Volume dengan type ("bucket", "model", "dataset", atau "space"), source (mis. "username/my-bucket"), dan mount_path (mis. "/data").
  • expose (list[int], opsional) — Port container yang akan diekspos melalui proxy jobs. Setiap port yang terdaftar dapat diakses di domain jobs publik (mis. https://<job_id>--8000.hf.jobs). Akses selalu memerlukan token HF dengan izin baca pada namespace job tersebut. Gunakan expose_public untuk akses tanpa autentikasi.
  • expose_public (list[int], opsional) — Port yang akan diekspos melalui proxy Jobs tanpa autentikasi. Port ini tidak perlu dicantumkan dalam expose.
  • resource_group_id (str, opsional) — ID dari resource group tempat Job terjadwal akan dibuat. Digunakan untuk mengontrol akses ke sumber daya di dalam organisasi dan untuk fitur atribusi biaya/batas pengeluaran. Jika tidak disediakan, Job terjadwal akan dibuat di luar resource group mana pun.
  • namespace (str, opsional) — Namespace tempat Job akan dibuat. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Jalankan tugas skrip UV pada infrastruktur Hugging Face.

Berbeda dengan hf jobs uv run, metode ini mengabaikan tabel opsional [tool.hf-jobs] yang dapat dibawa oleh skrip UV di header PEP 723-nya (lihat panduan Jobs): konfigurasi peluncuran harus diberikan secara eksplisit di sini.

Contoh:

Jadwalkan skrip dari URL:

>>> 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")

Jadwalkan skrip lokal:

>>> 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")

Jadwalkan perintah:

>>> 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

< >

( repo_id: strtag: strtag_message: str | None = Nonerevision: str | None = Nonetoken: bool | str | None = Nonerepo_type: str | None = Noneexist_ok: bool = False )

Parameter

  • repo_id (str) — Repositori tempat commit akan diberi tag. Contoh: "user/my-cool-model".
  • tag (str) — Nama tag yang akan dibuat.
  • tag_message (str, opsional) — Deskripsi tag yang akan dibuat.
  • revision (str, opsional) — Revisi git yang akan diberi tag. Bisa berupa nama branch atau OID/SHA dari sebuah commit, sebagai string heksadesimal. Singkatan (7 karakter pertama) juga didukung. Secara default, menggunakan head dari branch "main".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika memberi tag pada dataset atau space, None atau "model" jika memberi tag pada model. Default adalah None.
  • exist_ok (bool, opsional, default False) — Jika True, jangan lempar error jika tag sudah ada.

Membuang

RepositoryNotFoundError atau RevisionNotFoundError atau HfHubHTTPError

  • RepositoryNotFoundError — Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada.
  • RevisionNotFoundError — Jika revisi tidak ditemukan (error 404) di repo.
  • HfHubHTTPError — Jika cabang sudah ada di repo (error 409) dan exist_ok diatur ke False.

Beri tag pada commit tertentu dari repo di Hub.

create_webhook

< >

( url: str | None = Nonejob_id: str | None = Nonewatched: list[dict | WebhookWatchedItem]domains: list[constants.WEBHOOK_DOMAIN_T] | None = Nonesecret: str | None = Nonesecrets: dict[str, str] | None = Nonetoken: bool | str | None = None ) → WebhookInfo

Parameter

  • url (str) — URL untuk mengirim payload.
  • job_id (str) — ID dari Job sumber yang akan dipicu dengan webhook payload di variabel lingkungan WEBHOOK_PAYLOAD. Variabel lingkungan tambahan tersedia untuk kenyamanan: WEBHOOK_REPO_ID, WEBHOOK_REPO_TYPE dan WEBHOOK_SECRET.
  • watched (list[WebhookWatchedItem]) — Daftar WebhookWatchedItem yang akan dipantau oleh webhook. Isinya dapat berupa users, orgs, models, datasets, spaces, atau buckets. Item yang dipantau juga dapat diberikan sebagai dictionary biasa.
  • domains (list[Literal["repo", "discussion"]], opsional) — Daftar domain yang akan dipantau. Nilainya bisa “repo”, “discussion”, atau keduanya. Secara default, keduanya dipantau.
  • secret (str, opsional) — Secret untuk menandatangani payload.
  • secrets (dict[str, str], opsional) — Variabel lingkungan rahasia untuk Job yang dipicu oleh webhook (mis. {"HF_TOKEN": "hf_***"}). Hanya valid dengan job_id. Secrets dari Job sumber tidak disalin ke webhook, sehingga Anda perlu meneruskannya di sini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

WebhookInfo

Informasi tentang webhook yang baru dibuat.

Buat webhook baru.

Webhook dapat mengirim payload ke URL, atau memicu Job untuk dijalankan di infrastruktur Hugging Face. Fungsi ini harus dipanggil dengan salah satu dari url atau job_id, tetapi tidak keduanya.

Contoh:

Buat webhook yang mengirim payload ke URL

>>> 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,
)

Jalankan sebuah Job lalu buat webhook yang memicu Job ini

>>> 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

< >

( repo_id: strrevision: str | None = Nonetimeout: float | None = Nonefiles_metadata: bool = Falseexpand: list[ExpandDatasetProperty_T] | None = Nonetoken: bool | str | None = None ) → hf_api.DatasetInfo

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • revision (str, opsional) — Revisi repositori dataset yang digunakan untuk mengambil informasi.
  • timeout (float, opsional) — Apakah akan mengatur batas waktu (timeout) untuk permintaan ke Hub.
  • files_metadata (bool, opsional) — Apakah akan mengambil metadata untuk file di repositori (ukuran, metadata LFS, dll). Bawaan adalah False.
  • expand (list[ExpandDatasetProperty_T], opsional) — Daftar properti yang akan dikembalikan dalam respons. Jika digunakan, hanya properti yang ada dalam daftar tersebut yang akan dikembalikan. Parameter ini tidak dapat digunakan jika files_metadata diteruskan. Nilai yang mungkin adalah "author", "cardData", "citation", "createdAt", "disabled", "description", "downloads", "downloadsAllTime", "gated", "lastModified", "likes", "mainSize", "paperswithcode_id", "private", "siblings", "sha", "tags", "trendingScore", "usedStorage", dan "resourceGroup".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

hf_api.DatasetInfo

Informasi repositori dataset.

Dapatkan informasi tentang satu dataset tertentu di huggingface.co.

Dataset dapat bersifat privat jika Anda meneruskan token yang dapat diterima.

Membuang kesalahan berikut:

  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.
  • RevisionNotFoundError Jika revisi yang akan diunduh tidak dapat ditemukan.

delete_branch

< >

( repo_id: strbranch: strtoken: bool | str | None = Nonerepo_type: str | None = None )

Parameter

  • repo_id (str) — Repositori tempat cabang akan dihapus. Contoh: "user/my-cool-model".
  • branch (str) — Nama branch yang akan dihapus.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika membuat branch pada dataset atau space, None atau "model" jika memberi tag pada model. Default adalah None.

Membuang

RepositoryNotFoundError atau HfHubHTTPError

  • RepositoryNotFoundError — Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada.
  • HfHubHTTPError — Jika mencoba menghapus cabang yang dilindungi. Contoh: main tidak dapat dihapus.
  • HfHubHTTPError — Jika mencoba menghapus cabang yang tidak ada.

Hapus cabang dari repositori di Hub.

delete_bucket

< >

( bucket_id: strmissing_ok: bool = Falsetoken: bool | str | None = None )

Parameter

  • bucket_id (str) — ID dari bucket (mis. "username/my-bucket").
  • missing_ok (bool, opsional, defaultnya False) — Jika True, jangan lempar error jika bucket tidak ada.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Membuang

BucketNotFoundError

  • BucketNotFoundError — Jika bucket tidak dapat ditemukan dan missing_ok diatur ke False (default).

Hapus bucket dari Hub.

Contoh:

>>> 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

< >

( collection_slug: strmissing_ok: bool = Falsetoken: bool | str | None = None )

Parameter

  • collection_slug (str) — Slug dari koleksi yang akan dihapus. Contoh: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • missing_ok (bool, opsional) — Jika True, jangan lempar error jika koleksi tidak ada.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Hapus koleksi di Hub.

Contoh:

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

Ini adalah tindakan yang tidak dapat dibatalkan. Koleksi yang dihapus tidak dapat dipulihkan.

delete_collection_item

< >

( collection_slug: stritem_object_id: strmissing_ok: bool = Falsetoken: bool | str | None = None )

Parameter

  • collection_slug (str) — Slug dari koleksi yang akan diperbarui. Contoh: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • item_object_id (str) — ID item dalam koleksi. Ini bukan id item di Hub (repo_id atau paper id). Harus diambil dari objek CollectionItem. Contoh: collection.items[0].item_object_id.
  • missing_ok (bool, opsional) — Jika True, jangan lempar error jika item tidak ada.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Hapus item dari koleksi.

Contoh:

>>> 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

< >

( path_in_repo: strrepo_id: strtoken: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = None )

Parameter

  • path_in_repo (str) — Path file relatif di repo, misalnya: "checkpoints/1fec34a/weights.bin"
  • repo_id (str) — Repositori tempat file akan dihapus, misalnya: "username/custom_transformers"
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika file berada di dataset atau space, None atau "model" jika berada di model. Default adalah None.
  • revision (str, opsional) — Revisi git untuk di-commit. Secara default menggunakan head dari cabang "main".
  • commit_message (str, opsional) — Ringkasan / judul / baris pertama dari commit yang dihasilkan. Nilainya secara default adalah f"Delete {path_in_repo} with huggingface_hub".
  • commit_description (str, opsional) — Deskripsi dari commit yang dihasilkan
  • create_pr (boolean, opsional) — Apakah akan membuat Pull Request dengan commit tersebut. Defaultnya False. Jika revision tidak diset, PR dibuka terhadap cabang "main". Jika revision diset dan merupakan cabang, PR dibuka terhadap cabang ini. Jika revision diset dan bukan nama cabang (contoh: oid commit), RevisionNotFoundError dikembalikan oleh server.
  • parent_commit (str, opsional) — OID / SHA dari commit induk, sebagai string heksadesimal. Singkatan (7 karakter pertama) juga didukung. Jika ditentukan dan create_pr adalah False, commit akan gagal jika revision tidak menunjuk ke parent_commit. Jika ditentukan dan create_pr adalah True, pull request akan dibuat dari parent_commit. Menentukan parent_commit memastikan repo tidak berubah sebelum perubahan di-commit, dan dapat sangat berguna jika repo diperbarui / di-commit secara bersamaan.

Menghapus file di repo yang diberikan.

Membuang kesalahan berikut:

  • HTTPError jika API HuggingFace mengembalikan error
  • ValueError jika nilai beberapa parameter tidak valid
  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.
  • RevisionNotFoundError Jika revisi yang akan diunduh tidak dapat ditemukan.
  • EntryNotFoundError Jika file yang akan diunduh tidak dapat ditemukan.

delete_files

< >

( repo_id: strdelete_patterns: list[str]token: bool | str | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = None )

Parameter

  • repo_id (str) — Repositori tempat folder akan dihapus, misalnya: "username/custom_transformers"
  • delete_patterns (list[str]) — Daftar file atau folder yang akan dihapus. Setiap string dapat berupa jalur file, jalur folder, atau pola wildcard. Pola-pola ini adalah Standard Wildcards (pola globbing) yang didokumentasikan di sini. Pencocokan pola didasarkan pada fnmatch. Perhatikan bahwa fnmatch mencocokkan * melintasi batas jalur, berbeda dengan globbing shell Unix tradisional. Contoh: ["file.txt", "folder/", "data/*.parquet"]
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang disarankan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False. ke token yang disimpan.
  • repo_type (str, opsional) — Jenis repo tempat file akan dihapus. Bisa berupa "model", "dataset" atau "space". Bawaan adalah "model".
  • revision (str, opsional) — Revisi git untuk di-commit. Secara default menggunakan head dari cabang "main".
  • commit_message (str, opsional) — Ringkasan (baris pertama) dari commit yang dihasilkan. Nilainya secara default adalah f"Delete files using huggingface_hub".
  • commit_description (str, opsional) — Deskripsi dari commit yang dihasilkan.
  • create_pr (boolean, opsional) — Apakah akan membuat Pull Request dengan commit tersebut. Defaultnya False. Jika revision tidak diset, PR dibuka terhadap cabang "main". Jika revision diset dan merupakan cabang, PR dibuka terhadap cabang ini. Jika revision diset dan bukan nama cabang (contoh: oid commit), RevisionNotFoundError dikembalikan oleh server.
  • parent_commit (str, opsional) — OID / SHA dari commit induk, sebagai string heksadesimal. Singkatan (7 karakter pertama) juga didukung. Jika ditentukan dan create_pr adalah False, commit akan gagal jika revision tidak menunjuk ke parent_commit. Jika ditentukan dan create_pr adalah True, pull request akan dibuat dari parent_commit. Menentukan parent_commit memastikan repo tidak berubah sebelum perubahan di-commit, dan dapat sangat berguna jika repo diperbarui / di-commit secara bersamaan.

Hapus file dari repositori di Hub.

Jika jalur folder diberikan, seluruh folder beserta semua file yang dikandungnya akan dihapus.

delete_folder

< >

( path_in_repo: strrepo_id: strtoken: bool | str | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = None )

Parameter

  • path_in_repo (str) — Path folder relatif di repo, misalnya: "checkpoints/1fec34a".
  • repo_id (str) — Repositori tempat folder akan dihapus, misalnya: "username/custom_transformers"
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang disarankan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False. ke token yang disimpan.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika folder berada di dataset atau space, None atau "model" jika berada di model. Default adalah None.
  • revision (str, opsional) — Revisi git untuk di-commit. Secara default menggunakan head dari cabang "main".
  • commit_message (str, opsional) — Ringkasan / judul / baris pertama dari commit yang dihasilkan. Bawaan adalah f"Delete folder {path_in_repo} with huggingface_hub".
  • commit_description (str, opsional) — Deskripsi dari commit yang dihasilkan.
  • create_pr (boolean, opsional) — Apakah akan membuat Pull Request dengan commit tersebut. Defaultnya False. Jika revision tidak diset, PR dibuka terhadap cabang "main". Jika revision diset dan merupakan cabang, PR dibuka terhadap cabang ini. Jika revision diset dan bukan nama cabang (contoh: oid commit), RevisionNotFoundError dikembalikan oleh server.
  • parent_commit (str, opsional) — OID / SHA dari commit induk, sebagai string heksadesimal. Singkatan (7 karakter pertama) juga didukung. Jika ditentukan dan create_pr adalah False, commit akan gagal jika revision tidak menunjuk ke parent_commit. Jika ditentukan dan create_pr adalah True, pull request akan dibuat dari parent_commit. Menentukan parent_commit memastikan repo tidak berubah sebelum perubahan di-commit, dan dapat sangat berguna jika repo diperbarui / di-commit secara bersamaan.

Menghapus folder di repo yang diberikan.

Wrapper sederhana di sekitar metode create_commit().

delete_inference_endpoint

< >

( name: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parameter

  • name (str) — Nama Inference Endpoint yang akan dihapus.
  • namespace (str, opsional) — Namespace tempat Inference Endpoint berada. Secara default, namespace milik pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Hapus Inference Endpoint.

Operasi ini tidak dapat dibatalkan. Jika Anda tidak ingin dikenakan biaya untuk Inference Endpoint, lebih baik untuk menjeda-nya dengan pause_inference_endpoint() atau menoloknya hingga nol dengan scale_to_zero_inference_endpoint().

Untuk kenyamanan, Anda juga dapat menghapus Inference Endpoint menggunakan InferenceEndpoint.delete().

delete_repo

< >

( repo_id: strtoken: str | bool | None = Nonerepo_type: str | None = Nonemissing_ok: bool = False )

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model.
  • missing_ok (bool, opsional, defaultnya False) — Jika True, jangan lempar error jika repo tidak ada.

Membuang

RepositoryNotFoundError

  • RepositoryNotFoundError — Jika repositori yang akan dihapus tidak dapat ditemukan dan missing_ok diset ke False (default).

Hapus repo dari HuggingFace Hub. PERHATIAN: tindakan ini tidak dapat dibatalkan.

delete_scheduled_job

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parameter

  • scheduled_job_id (str) — ID dari Job terjadwal.
  • namespace (str, opsional) — Namespace tempat Job terjadwal berada. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hapus Job komputasi terjadwal di infrastruktur Hugging Face.

delete_space_secret

< >

( repo_id: strkey: strtoken: bool | str | None = None )

Parameter

  • repo_id (str) — ID repo yang akan diperbarui. Contoh: "bigcode/in-the-stack".
  • key (str) — Kunci rahasia. Contoh: "GITHUB_API_KEY".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Menghapus secret dari Space.

Secrets memungkinkan Anda mengatur kunci atau token rahasia ke sebuah Space tanpa perlu menuliskannya secara langsung dalam kode. Untuk detail lebih lanjut, lihat https://huggingface.co/docs/hub/spaces-overview#managing-secrets.

delete_space_variable

< >

( repo_id: strkey: strtoken: bool | str | None = None )

Parameter

  • repo_id (str) — ID repo yang akan diperbarui. Contoh: "bigcode/in-the-stack".
  • key (str) — Kunci variabel. Contoh: "MODEL_REPO_ID"
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Menghapus variabel dari Space.

Variabel memungkinkan Anda mengatur variabel lingkungan untuk sebuah Space tanpa perlu menuliskannya secara langsung dalam kode. Untuk detail lebih lanjut, lihat https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables

delete_space_volumes

< >

( repo_id: strtoken: bool | str | None = None )

Parameter

  • repo_id (str) — ID Space yang akan diperbarui. Contoh: "username/my-space".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Membuang

BadRequestError

  • BadRequestError — Jika Space tidak memiliki volume yang terpasang.

Hapus semua volume dari sebuah Space.

Contoh:

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

delete_tag

< >

( repo_id: strtag: strtoken: bool | str | None = Nonerepo_type: str | None = None )

Parameter

  • repo_id (str) — Repositori tempat tag akan dihapus. Contoh: "user/my-cool-model".
  • tag (str) — Nama tag yang akan dihapus.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika memberi tag pada dataset atau space, None atau "model" jika memberi tag pada model. Default adalah None.

Membuang

RepositoryNotFoundError atau RevisionNotFoundError

  • RepositoryNotFoundError — Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada.
  • RevisionNotFoundError — Jika tag tidak ditemukan.

Hapus tag dari repo di Hub.

delete_webhook

< >

( webhook_id: strtoken: bool | str | None = None ) → None

Parameter

  • webhook_id (str) — Pengidentifikasi unik dari webhook yang akan dihapus.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

None

Hapus webhook.

Contoh:

>>> from huggingface_hub import delete_webhook
>>> delete_webhook("654bbbc16f2ec14d77f109cc")

disable_space_dev_mode

< >

( repo_id: strtoken: bool | str | None = None ) → SpaceRuntime

Parameter

  • repo_id (str) — ID Space untuk menonaktifkan mode dev. Contoh: "Salesforce/BLIP2".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

SpaceRuntime

Informasi runtime tentang Space Anda.

Membuang

RepositoryNotFoundError atau HfHubHTTPError atau BadRequestError

  • RepositoryNotFoundError — Jika Space Anda tidak ditemukan (error 404). Kemungkinan besar repo_id salah atau Space Anda bersifat privat tetapi Anda belum terautentikasi.
  • HfHubHTTPError — 403 Forbidden: hanya pemilik Space yang dapat mengatur mode dev. Jika Anda ingin menangani Space yang tidak Anda miliki, mintalah kepada pemiliknya dengan membuka Discussion atau duplikat Space tersebut.
  • BadRequestError — Jika Space Anda adalah Space statis. Space statis selalu berjalan dan tidak pernah ditagih. Jika Anda ingin menyembunyikan Space statis, Anda dapat mengaturnya menjadi privat.

Nonaktifkan mode dev pada sebuah Space.

Spaces Dev Mode memudahkan proses debugging aplikasi Anda dan mempercepat iterasi pada Spaces dengan memungkinkan Anda memulai ulang aplikasi tanpa menghentikan kontainer Space itu sendiri. Mengaktifkan dev mode memerlukan langganan PRO atau Team & Enterprise, tetapi menonaktifkannya selalu diizinkan (misalnya, setelah langganan berakhir). Lihat https://huggingface.co/docs/hub/spaces-dev-mode untuk detail lebih lanjut.

disable_webhook

< >

( webhook_id: strtoken: bool | str | None = None ) → WebhookInfo

Parameter

  • webhook_id (str) — Pengidentifikasi unik dari webhook yang akan dinonaktifkan.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

WebhookInfo

Info tentang webhook yang dinonaktifkan.

Nonaktifkan webhook (menjadikannya “nonaktif”).

Contoh:

>>> 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

< >

( bucket_id: strfiles: list[tuple[str | BucketFile, str | Path]]raise_on_missing_files: bool = Falsetoken: str | bool | None = None )

Parameter

  • bucket_id (str) — ID dari bucket (mis. "username/my-bucket").
  • files (list[tuple[Union[str, BucketFile], Union[str, Path]]]) — File yang akan diunduh sebagai daftar tuple (sumber, tujuan). Lihat deskripsi di atas untuk detail format.
  • raise_on_missing_files (bool, opsional) — Jika True, lempar EntryNotFoundError ketika file yang diminta tidak ada di bucket. Jika False (default), file yang hilang akan dilewati dengan peringatan.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Unduh file dari bucket.

Input Files adalah daftar tuple (remote file, local file) di mana remote file adalah path file di bucket atau objek BucketFile, dan local file adalah path tujuan pada filesystem lokal. Saat meneruskan objek BucketFile (diperoleh dari list_bucket_tree()), metode akan melewati langkah pengambilan metadata dan langsung mengunduh file.

Contoh:

>>> 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"),
...     ],
... )
>>> 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

< >

( from_id: strto_id: str | None = Nonerepo_type: str | None = Noneprivate: bool | None = Nonevisibility: RepoVisibility_T | None = Nonetoken: bool | str | None = Noneexist_ok: bool = Falseresource_group_id: str | None = Nonespace_hardware: SpaceHardware | None = Nonespace_sleep_time: int | None = Nonespace_secrets: list[dict[str, str]] | None = Nonespace_variables: list[dict[str, str]] | None = Nonespace_volumes: list[Volume] | None = None ) → DuplicatedRepoUrl

Parameter

  • from_id (str) — ID repo yang akan diduplikasi. Contoh: "openai/gdpval".
  • to_id (str, opsional) — ID dari repo baru. Contoh: "myorg/my-gdpval". Jika tidak diberikan, repo baru akan memiliki nama yang sama dengan repo asli, tetapi di akun Anda.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika menduplikasi dataset atau Space, None atau "model" jika menduplikasi model. Default adalah None.
  • private (bool, opsional) — Apakah repo baru harus bersifat privat atau tidak. Secara default menggunakan privasi yang sama dengan repo asli. Tidak dapat dikirim bersamaan dengan visibility.
  • visibility (Literal["public", "private", "protected"], opsional) — Visibilitas repo baru. Bisa berupa "public" atau "private", atau "protected" untuk Spaces. Nilainya secara default sama dengan visibilitas repo asli.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • exist_ok (bool, opsional, default False) — Jika True, jangan lempar error jika repo sudah ada.
  • resource_group_id (str, opsional) — Grup sumber daya tempat repositori baru akan dibuat. Grup sumber daya hanya tersedia untuk organisasi Enterprise Hub dan memungkinkan Anda mendefinisikan anggota organisasi mana yang dapat mengakses sumber daya tersebut. ID grup sumber daya dapat ditemukan di URL halaman sumber daya di Hub (mis. "66670e5163145ca562cb1988"). Untuk mempelajari lebih lanjut tentang grup sumber daya, lihat https://huggingface.co/docs/hub/en/security-resource-groups.
  • space_hardware (SpaceHardware atau str, opsional) — Pilihan Hardware jika repo_type adalah “space”. Contoh: "t4-medium". Lihat SpaceHardware untuk daftar lengkap.
  • space_sleep_time (int, opsional) — Jumlah detik tidak aktif yang harus ditunggu sebelum sebuah Space dimatikan. Atur ke -1 jika Anda tidak ingin Space Anda tidur (perilaku bawaan untuk perangkat keras yang ditingkatkan). Untuk perangkat keras gratis, Anda tidak dapat mengatur waktu tidur (nilai tetap pada 48 jam tidak aktif). Hanya berlaku jika repo_type adalah “space”. Lihat https://huggingface.co/docs/hub/spaces-gpus#sleep-time untuk detail lebih lanjut.
  • space_secrets (list[dict[str, str]], opsional) — Daftar kunci rahasia untuk disetel di Space Anda. Setiap item berbentuk {"key": ..., "value": ..., "description": ...} di mana description bersifat opsional. Hanya berlaku jika repo_type adalah “space”. Untuk detail lebih lanjut, lihat https://huggingface.co/docs/hub/spaces-overview#managing-secrets.
  • space_variables (list[dict[str, str]], opsional) — Daftar variabel lingkungan publik yang akan disetel di Space Anda. Setiap item berbentuk {"key": ..., "value": ..., "description": ...} di mana description bersifat opsional. Hanya berlaku jika repo_type adalah “space”. Untuk detail lebih lanjut, lihat https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables.
  • space_volumes (list[Volume], opsional) — Daftar objek Volume untuk dipasang (mount) di Space saat duplikasi. Setiap volume memiliki type ("bucket", "model", "dataset", atau "space"), source (ID repo atau bucket), mount_path (jalur di dalam container), serta field opsional revision, read_only, dan path. Hanya berlaku jika repo_type adalah “space”.

Mengembalikan

DuplicatedRepoUrl

URL ke repo yang baru dibuat. Nilainya adalah subclass dari RepoUrl (dan dari str) yang berisi atribut seperti endpoint, repo_type, repo_id dan files_copy_pending.

Membuang

RepositoryNotFoundError atau HfHubHTTPError

  • RepositoryNotFoundError — Jika salah satu dari from_id atau to_id tidak dapat ditemukan. Hal ini mungkin terjadi karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.
  • HfHubHTTPError — Jika API HuggingFace mengembalikan error

Duplikat repositori di Hub (model, dataset, atau Space).

Ini melakukan salinan sisi server yang mempertahankan riwayat git lengkap dan objek LFS tanpa memerlukan unduhan/unggah lokal.

Riwayat git disalin segera, tetapi file LFS/Xet mungkin masih disalin di latar belakang setelah metode ini mengembalikan nilai. Dalam kasus tersebut, files_copy_pending bernilai True pada nilai yang dikembalikan, dan mengunduh file-file ini dari repo baru mungkin gagal hingga proses penyalinan selesai.

Contoh:

>>> 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

< >

( repo_id: strdiscussion_num: intcomment_id: strnew_content: strtoken: bool | str | None = Nonerepo_type: str | None = None ) → DiscussionComment

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • discussion_num (int) — Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif.
  • comment_id (str) — ID komentar yang akan diedit.
  • new_content (str) — Konten baru dari komentar. Komentar mendukung format markdown.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

KomentarDiskusi

komentar yang diedit

Mengedit komentar pada Diskusi / Pull Request.

Membuang kesalahan berikut:

  • HTTPError jika API HuggingFace mengembalikan error
  • ValueError jika nilai beberapa parameter tidak valid
  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.

enable_space_dev_mode

< >

( repo_id: strtoken: bool | str | None = None ) → SpaceRuntime

Parameter

  • repo_id (str) — ID Space untuk mengaktifkan mode dev. Contoh: "Salesforce/BLIP2".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

SpaceRuntime

Informasi runtime tentang Space Anda.

Membuang

RepositoryNotFoundError atau HfHubHTTPError atau BadRequestError

  • RepositoryNotFoundError — Jika Space Anda tidak ditemukan (error 404). Kemungkinan besar repo_id salah atau Space Anda bersifat privat tetapi Anda belum terautentikasi.
  • HfHubHTTPError — 403 Forbidden: hanya pemilik Space yang dapat mengatur mode dev. Jika Anda ingin menangani Space yang tidak Anda miliki, mintalah kepada pemiliknya dengan membuka Discussion atau duplikat Space tersebut.
  • BadRequestError — Jika Space Anda adalah Space statis. Space statis selalu berjalan dan tidak pernah ditagih. Jika Anda ingin menyembunyikan Space statis, Anda dapat mengaturnya menjadi privat.

Aktifkan mode dev pada Space.

Spaces Dev Mode memudahkan proses debugging aplikasi Anda dan mempercepat iterasi pada Spaces dengan memungkinkan Anda memulai ulang aplikasi tanpa menghentikan kontainer Space itu sendiri. Fitur ini tersedia sebagai bagian dari paket PRO atau Team & Enterprise. Lihat https://huggingface.co/docs/hub/spaces-dev-mode untuk detail lebih lanjut.

enable_webhook

< >

( webhook_id: strtoken: bool | str | None = None ) → WebhookInfo

Parameter

  • webhook_id (str) — Pengidentifikasi unik dari webhook yang akan diaktifkan.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

WebhookInfo

Info tentang webhook yang diaktifkan.

Aktifkan webhook (menjadikannya “aktif”).

Contoh:

>>> 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

< >

( job_id: strnamespace: str | None = Nonefollow: bool = Falsetail: int | None = Nonetoken: bool | str | None = None )

Parameter

  • job_id (str) — ID dari Job.
  • namespace (str, opsional) — Namespace tempat Job berjalan. Secara default menggunakan namespace pengguna saat ini.
  • follow (bool, opsional) — Jika True, alirkan log secara real-time hingga pekerjaan selesai (blocking). Jika False (default), ambil hanya log yang saat ini tersedia dan kembalikan segera (non-blocking).
  • tail (int, opsional) — Jumlah maksimum baris yang dikembalikan dari log. Saat digabungkan dengan follow=True, memulai dari N baris terakhir dan terus mengalirkan log baru. Saat follow=False, hanya mengembalikan N baris terakhir dari log yang tersedia saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Ambil semua log dari Job komputasi di infrastruktur Hugging Face.

Contoh:

>>> 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

< >

( job_id: strnamespace: str | None = Nonefollow: bool = Falsetoken: bool | str | None = None )

Parameter

  • job_id (str) — ID dari Job.
  • namespace (str, opsional) — Namespace tempat Job berjalan. Secara default menggunakan namespace pengguna saat ini.
  • follow (bool, opsional) — Jika True, alirkan metrik secara real-time hingga pekerjaan selesai (blocking). Jika False (default), ambil hanya metrik saat ini dan kembalikan (non-blocking).
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Ambil metrik langsung dari Job komputasi pada infrastruktur Hugging Face.

Contoh:

>>> 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

< >

( repo_id: strbuild: bool = Falsefollow: bool = Falsetoken: bool | str | None = None ) → Iterable[str]

Parameter

  • repo_id (str) — ID dari Space. Contoh: "bigcode/in-the-stack".
  • build (bool, opsional, default False) — Jika True, ambil log build container (berguna ketika Space terjebak di BUILD_ERROR). Jika False (default), ambil log run, yaitu stdout/stderr dari aplikasi yang sedang berjalan.
  • follow (bool, opsional, default False) — Jika True, alirkan log secara real-time (blocking) hingga server menutup aliran atau KeyboardInterrupt dilempar. Jika False (default), ambil hanya log yang saat ini dibuffer dan kembalikan segera (non-blocking, seperti docker logs).
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Secara bawaan menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Mengembalikan

Iterable[str]

Generator yang menghasilkan baris log saat tersedia.

Ambil log eksekusi atau log build dari sebuah Space di Hub.

Berguna untuk debugging Space yang gagal dibangun atau crash saat runtime, terutama dari skrip atau alur kerja agentic di mana membaca log di browser bukanlah pilihan.

Contoh:

>>> 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

< >

( repo_id: strfilename: strrepo_type: str | None = Nonerevision: str | None = Nonetoken: str | bool | None = None )

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • filename (str) — Nama file yang akan diperiksa, misalnya: "config.json"
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengambil info repositori dari dataset atau space, None atau "model" jika mengambil info repositori dari model. Default adalah None.
  • revision (str, opsional) — Revisi repositori yang menjadi sumber informasi. Secara default menggunakan cabang "main".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Memeriksa apakah file ada di repositori di Hugging Face Hub.

Contoh:

>>> 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

< >

( bucket_id: strremote_path: strtoken: str | bool | None = None ) → BucketFileMetadata

Parameter

  • bucket_id (str) — ID dari bucket (mis. "username/my-bucket").
  • remote_path (str) — Path file di dalam bucket.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

BucketFileMetadata

Metadata file yang berisi ukuran dan informasi xet.

Ambil metadata file di dalam bucket.

Contoh:

>>> 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

< >

( bucket_id: strpaths: Iterable[str]token: str | bool | None = None ) → Iterable[BucketFile]

Parameter

  • bucket_id (str) — ID dari bucket (mis. "username/my-bucket").
  • paths (Iterable[str]) — Path untuk mendapatkan informasi. Jika path tidak ada, path tersebut diabaikan tanpa memicu exception. Hanya file path yang didukung.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[BucketFile]

Informasi tentang path, sebagai iterable dari objek BucketFile.

Dapatkan informasi tentang path sebuah bucket.

Panggilan dilakukan dalam batch berisi 1000 path. Hasil diberikan saat diterima.

Contoh:

>>> 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

< >

( collection_slug: strtoken: bool | str | None = None )

Parameter

  • collection_slug (str) — Slug dari koleksi di Hub. Contoh: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mendapatkan informasi tentang Collection di Hub.

Mengembalikan: Koleksi

Contoh:

>>> 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

< >

( repo_id: strbase_model_only: bool | None = Nonetoken: bool | str | None = Nonetimeout: float | None = None ) → list[DatasetLeaderboardEntry]

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /. Contoh: "allenai/olmOCR-bench".
  • base_model_only (bool atau None, opsional) — Secara default, papan peringkat hanya mencakup model yang tidak memiliki relasi base_model yang dideklarasikan (yaitu repositori kanonik/akar), sesuai dengan tampilan papan peringkat default Hub. Repositori hasil fine-tuning atau turunan yang mendeklarasikan model induk akan dikecualikan. Berikan base_model_only=False untuk menonaktifkan filter ini dan mencakup setiap hasil yang dikirim, terlepas dari apakah model tersebut mendeklarasikan relasi base model atau tidak.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • timeout (float, opsional) — Apakah akan mengatur batas waktu (timeout) untuk permintaan ke Hub.

Mengembalikan

list[DatasetLeaderboardEntry]

Daftar objek DatasetLeaderboardEntry yang mewakili entri papan peringkat, diurutkan berdasarkan peringkat.

Dapatkan papan peringkat untuk dataset di Hub.

Papan peringkat mengurutkan model berdasarkan skor evaluasi mereka pada dataset benchmark yang diberikan. Tidak semua dataset memiliki papan peringkat — hanya dataset benchmark yang memiliki hasil evaluasi yang dikirimkan ke dalamnya. Hal ini memberikan pandangan berpusat pada dataset untuk skor; untuk pandangan berpusat pada model, gunakan model_info() dengan expand=["evalResults"].

Membuang kesalahan berikut:

  • RepositoryNotFoundError Jika repositori tidak dapat ditemukan. Hal ini mungkin karena repositori tidak ada, atau karena repositori disetel ke private dan Anda tidak memiliki akses.
  • HfHubHTTPError Jika dataset tidak memiliki papan peringkat.

Contoh:

>>> 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

< >

( )

Daftarkan semua tag dataset yang valid sebagai objek namespace bersarang.

get_discussion_details

< >

( repo_id: strdiscussion_num: intrepo_type: str | None = Nonetoken: bool | str | None = None )

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • discussion_num (int) — Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengambil detail Diskusi / Pull Request dari Hub.

Mengembalikan: DiscussionWithDetails

Membuang kesalahan berikut:

  • HTTPError jika API HuggingFace mengembalikan error
  • ValueError jika nilai beberapa parameter tidak valid
  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.

get_full_repo_name

< >

( model_id: strorganization: str | None = Nonetoken: bool | str | None = None ) → str

Parameter

  • model_id (str) — Nama model.
  • organization (str, opsional) — Jika diberikan, nama repositori akan berada di namespace organisasi alih-alih namespace pengguna.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

str

Nama repositori dalam namespace pengguna ({username}/{model_id}) jika tidak ada organisasi yang diteruskan, dan di bawah namespace organisasi ({organization}/{model_id}) jika sebaliknya.

Mengembalikan nama repositori untuk ID model tertentu dan organisasi opsional.

get_hf_file_metadata

< >

( url: strtoken: bool | str | None = Nonetimeout: float | None = 10 )

Parameter

  • url (str) — URL file, misalnya yang dikembalikan oleh hf_hub_url().
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • timeout (float, opsional, default 10) — Berapa detik yang ditunggu untuk server mengirim metadata sebelum menyerah.

Ambil metadata dari file yang di-versikan di Hub untuk url tertentu.

get_inference_endpoint

< >

( name: strnamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Parameter

  • name (str) — Nama Inference Endpoint yang informasinya akan diambil.
  • namespace (str, opsional) — Namespace tempat Inference Endpoint berada. Secara default, namespace milik pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

InferenceEndpoint

informasi tentang Inference Endpoint yang diminta.

Dapatkan informasi tentang Inference Endpoint.

Contoh:

>>> 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

< >

( )

Daftarkan semua tag model yang valid sebagai objek namespace bersarang

get_organization_overview

< >

( organization: strtoken: bool | str | None = None ) → Organization

Parameter

  • organization (str) — Nama organisasi untuk mendapatkan ringkasan.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode yang direkomendasikan untuk autentikasi (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Organization

Objek Organization dengan ringkasan organisasi.

Membuang

HTTPError

  • HTTPError — HTTP 404 Jika organisasi tidak ada di Hub.

Dapatkan gambaran umum tentang organisasi di Hub.

get_paths_info

< >

( repo_id: strpaths: list[str] | strexpand: bool = Falserevision: str | None = Nonerepo_type: str | None = Nonetoken: str | bool | None = None ) → list[Union[RepoFile, RepoFolder]]

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • paths (Union[list[str], str], opsional) — Path untuk mendapatkan informasi. Jika path tidak ada, path tersebut diabaikan tanpa memicu exception.
  • expand (bool, opsional, default False) — Apakah akan mengambil informasi lebih lanjut tentang path (misalnya commit terakhir dan hasil pemindaian keamanan file). Operasi ini lebih mahal bagi server sehingga hanya 50 hasil yang dikembalikan per halaman (bukan 1000). Karena pagination diimplementasikan di huggingface_hub, hal ini transparan bagi Anda kecuali untuk waktu yang dibutuhkan untuk mendapatkan hasil.
  • revision (str, opsional) — Revisi repositori yang menjadi sumber informasi. Secara default menggunakan cabang "main".
  • repo_type (str, opsional) — Jenis repositori yang menjadi sumber informasi ("model", "dataset" atau "space". Nilai default adalah "model".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

list[Union[RepoFile, RepoFolder]]

Informasi tentang path, sebagai daftar objek RepoFile dan RepoFolder.

Membuang

RepositoryNotFoundError atau RevisionNotFoundError

  • RepositoryNotFoundError — Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada.
  • RevisionNotFoundError — Jika revisi tidak ditemukan (error 404) di repo.

Dapatkan informasi tentang path sebuah repo.

Contoh:

>>> 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

< >

( repo_id: strauthor: str | None = Nonediscussion_type: constants.DiscussionTypeFilter | None = Nonediscussion_status: constants.DiscussionStatusFilter | None = Nonerepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterator[Discussion]

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • author (str, opsional) — Lewatkan nilai untuk memfilter berdasarkan penulis diskusi. None berarti tidak ada filter. Nilai default adalah None.
  • discussion_type (str, opsional) — Atur ke "pull_request" untuk mengambil hanya pull request, "discussion" untuk mengambil hanya diskusi. Atur ke "all" atau None untuk mengambil keduanya. Default adalah None.
  • discussion_status (str, opsional) — Atur ke "open" (atau "closed") untuk mengambil hanya diskusi yang terbuka (atau tertutup). Atur ke "all" atau None untuk mengambil keduanya. Nilai default adalah None.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengambil dari dataset atau space, None atau "model" jika mengambil dari model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterator[Discussion]

Iterator dari objek Discussion.

Mengambil Diskusi dan Pull Requests untuk repo yang diberikan.

Contoh:

Mengumpulkan semua diskusi sebuah repo dalam sebuah daftar:

>>> from huggingface_hub import get_repo_discussions
>>> discussions_list = list(get_repo_discussions(repo_id="bert-base-uncased"))

Mengiterasi diskusi dari sebuah repo:

>>> 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

< >

( repo_id: strrepo_type: str | None = Nonerevision: str | None = Nonetoken: bool | str | None = Nonetimeout: float | None = 10 ) → SafetensorsRepoMetadata

Parameter

  • repo_id (str) — Nama pengguna atau organisasi dan nama repo yang dipisahkan oleh /.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika file berada di dataset atau space, None atau "model" jika berada di model. Default adalah None.
  • revision (str, opsional) — Revisi git untuk mengambil file. Bisa berupa nama branch, tag, atau hash commit. Secara default menggunakan head dari branch "main".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • timeout (float, opsional, default 10) — Berapa detik yang ditunggu agar server mengirim data sebelum menyerah, diteruskan ke setiap permintaan yang mengambil header file safetensors. Atur ke None untuk menonaktifkan timeout (tidak disarankan, karena koneksi yang macet dapat menggantung panggilan secara tak terbatas).

Mengembalikan

SafetensorsRepoMetadata

informasi terkait repo safetensors.

Membuang

NotASafetensorsRepoError atau SafetensorsParsingError

  • NotASafetensorsRepoError — Jika repo bukan repo safetensors, yaitu tidak memiliki file model.safetensors atau model.safetensors.index.json.
  • SafetensorsParsingError — Jika header file safetensors tidak dapat diurai dengan benar.

Analisis metadata untuk repositori safetensors di Hub.

Pertama, kami memeriksa apakah repo memiliki satu file safetensors atau repo safetensors yang terbagi (sharded). Jika berupa satu file safetensors, kami memparse metadata dari file ini. Jika berupa repo safetensors yang terbagi, kami memparse metadata dari file index dan kemudian memparse metadata dari setiap shard.

Untuk mengurai metadata dari satu file safetensors, gunakan parse_safetensors_file_metadata(). Untuk mendapatkan setiap header shard dari model yang di-shard di main dalam satu permintaan, gunakan get_sharded_safetensors_metadata().

Untuk detail lebih lanjut mengenai format safetensors, lihat https://huggingface.co/docs/safetensors/index#format.

Contoh:

# 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

< >

( repo_id: strfilename: str = 'model.safetensors.index.json'token: bool | str | None = Nonetimeout: float | None = 10 ) → SafetensorsRepoMetadata

Parameter

  • repo_id (str) — Nama pengguna atau organisasi dan nama repo yang dipisahkan oleh /.
  • filename (str, opsional) — Path file indeks safetensors di repo. Defaultnya adalah "model.safetensors.index.json".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • timeout (float, opsional, default 10) — Berapa detik yang ditunggu agar server mengirim data sebelum menyerah. Atur ke None untuk menonaktifkan timeout (tidak disarankan, karena koneksi yang macet dapat menggantung panggilan secara tak terbatas).

Mengembalikan

SafetensorsRepoMetadata

metadata yang sama seperti get_safetensors_metadata().

Dapatkan metadata setiap shard dari model safetensors yang di-shard di main dari Hub dalam satu permintaan, sebagai gantinya get_safetensors_metadata() yang mem-parsing header setiap shard. Hanya Hugging Face Hub.

Contoh:

>>> metadata = get_sharded_safetensors_metadata("HuggingFaceH4/zephyr-7b-beta")
>>> len(metadata.files_metadata)
8

get_space_runtime

< >

( repo_id: strtoken: bool | str | None = None ) → SpaceRuntime

Parameter

  • repo_id (str) — ID repo yang akan diperbarui. Contoh: "bigcode/in-the-stack".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

SpaceRuntime

Informasi runtime tentang sebuah Space, termasuk tahap dan perangkat keras Space.

Mendapatkan informasi runtime tentang sebuah Space.

get_space_secrets

< >

( repo_id: strtoken: bool | str | None = None ) → dict[str, SpaceSecret]

Parameter

  • repo_id (str) — ID repo yang akan ditanyakan. Contoh: "bigcode/in-the-stack".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

dict[str, SpaceSecret]

Kamus objek SpaceSecret yang diindeks berdasarkan nama rahasia.

Mengambil semua rahasia dari sebuah Space.

Nilai rahasia bersifat hanya-tulis dan tidak dapat dibaca kembali. Hanya kunci, deskripsi, dan waktu pembaruan terakhir yang dikembalikan.

Secrets memungkinkan Anda mengatur kunci atau token rahasia ke sebuah Space tanpa perlu menuliskannya secara langsung dalam kode. Untuk detail lebih lanjut, lihat https://huggingface.co/docs/hub/spaces-overview#managing-secrets.

Contoh:

>>> 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

< >

( repo_id: strtoken: bool | str | None = None )

Parameter

  • repo_id (str) — ID repo yang akan ditanyakan. Contoh: "bigcode/in-the-stack".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengambil semua variabel dari sebuah Space.

Variabel memungkinkan Anda mengatur variabel lingkungan untuk sebuah Space tanpa perlu menuliskannya secara langsung dalam kode. Untuk detail lebih lanjut, lihat https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables

get_user_overview

< >

( username: strtoken: bool | str | None = None ) → User

Parameter

  • username (str) — Nama pengguna dari pengguna yang ingin dilihat ringkasannya.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

User

Objek User berisi ringkasan pengguna.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 Jika pengguna tidak ada di Hub.

Dapatkan ringkasan tentang pengguna di Hub.

get_webhook

< >

( webhook_id: strtoken: bool | str | None = None ) → WebhookInfo

Parameter

  • webhook_id (str) — Pengidentifikasi unik dari webhook yang akan diambil.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

WebhookInfo

Info tentang webhook.

Dapatkan webhook berdasarkan id-nya.

Contoh:

>>> 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

< >

( token: bool | str | None = None ) → ZeroGpuQuota

Parameter

  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Token fine-grained harus memiliki izin “Billing > Read billing usage and payment method status” dan token OAuth harus memiliki scope read-billing.

Mengembalikan

ZeroGpuQuota

Kuota ZeroGPU dari pengguna yang terautentikasi.

Dapatkan kuota ZeroGPU dari pengguna yang terautentikasi.

Berguna untuk melacak penggunaan ZeroGPU saat memanggil ZeroGPU Spaces secara programatik (misalnya dari aplikasi, agen, atau server MCP). Lihat https://huggingface.co/docs/hub/spaces-zerogpu untuk detail lebih lanjut.

Contoh:

>>> 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

< >

( repo_id: struser: strrepo_type: str | None = Nonetoken: bool | str | None = None )

Parameter

  • repo_id (str) — ID repo yang akan diberikan akses.
  • user (str) — Nama pengguna dari pengguna yang akan diberikan akses.
  • repo_type (str, opsional) — Jenis repo yang akan diberikan aksesnya. Harus salah satu dari model, dataset atau space. Nilai defaultnya adalah model.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 jika repo tidak gated.
  • HfHubHTTPError — HTTP 400 jika pengguna sudah memiliki akses ke repo.
  • HfHubHTTPError — HTTP 403 jika Anda hanya memiliki akses baca-saja ke repo. Hal ini dapat terjadi jika Anda tidak memiliki peran write atau admin di organisasi tempat repo tersebut berada, atau jika Anda menggunakan token read.
  • HfHubHTTPError — HTTP 404 jika pengguna tidak ada di Hub.

Beri akses kepada pengguna untuk repositori bergerbang tertentu.

Memberikan akses tidak memerlukan pengguna untuk mengirimkan permintaan akses secara mandiri. Pengguna secara otomatis ditambahkan ke daftar yang diterima, yang berarti mereka dapat mengunduh file. Anda dapat mencabut akses yang diberikan kapan saja menggunakan cancel_access_request() atau reject_access_request().

Untuk informasi lebih lanjut tentang repositori bergerbang, lihat https://huggingface.co/docs/hub/models-gated.

hf_hub_download

< >

( repo_id: strfilename: strsubfolder: str | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecache_dir: str | Path | None = Nonelocal_dir: str | Path | None = Noneforce_download: bool = Falseetag_timeout: float = 10token: bool | str | None = Nonelocal_files_only: bool = Falsetqdm_class: type[base_tqdm] | None = Nonedry_run: bool = False ) → str or DryRunFileInfo

Parameter

  • repo_id (str) — Nama pengguna atau organisasi dan nama repo yang dipisahkan oleh /.
  • filename (str) — Nama file di repo.
  • subfolder (str, opsional) — Nilai opsional yang sesuai dengan folder di dalam repositori.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunduh dari dataset atau space, None atau "model" jika mengunduh dari model. Default adalah None.
  • revision (str, opsional) — ID revisi Git opsional yang dapat berupa nama cabang, tag, atau hash commit.
  • cache_dir (str, Path, opsional) — Path ke folder tempat file cache disimpan.
  • local_dir (str atau Path, opsional) — Jika disediakan, file yang diunduh akan ditempatkan di bawah direktori ini.
  • force_download (bool, opsional, default False) — Apakah file harus diunduh meskipun sudah ada di cache lokal.
  • etag_timeout (float, opsional, default 10) — Saat mengambil ETag, berapa detik menunggu server mengirim data sebelum menyerah, yang diteruskan ke httpx2.request.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • local_files_only (bool, opsional, defaultnya False) — Jika True, hindari mengunduh file dan kembalikan path ke file cache lokal jika ada.
  • tqdm_class (tqdm, opsional) — Jika disediakan, menimpa perilaku bawaan untuk progress bar. Argumen yang diteruskan harus mewarisi dari tqdm.auto.tqdm atau setidaknya meniru perilakunya. Bawaannya adalah progress bar kustom HF yang dapat dinonaktifkan dengan mengatur variabel lingkungan HF_HUB_DISABLE_PROGRESS_BARS.
  • dry_run (bool, opsional, defaultnya False) — Jika True, lakukan dry run tanpa benar-benar mengunduh file. Mengembalikan objek DryRunFileInfo yang berisi informasi tentang apa yang akan diunduh.

Mengembalikan

str atau DryRunFileInfo

  • Jika dry_run=False: Jalur lokal file atau, jika jaringan mati, versi terakhir file yang di-cache di disk.
  • Jika dry_run=True: Objek DryRunFileInfo yang berisi informasi unduhan.

Membuang

RepositoryNotFoundError atau RevisionNotFoundError atau ~utils.RemoteEntryNotFoundError atau LocalEntryNotFoundError atau EnvironmentError atau OSError atau ValueError

  • RepositoryNotFoundError — Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.
  • RevisionNotFoundError — Jika revisi yang akan diunduh tidak dapat ditemukan.
  • ~utils.RemoteEntryNotFoundError — Jika file yang akan diunduh tidak dapat ditemukan.
  • LocalEntryNotFoundError — Jika jaringan dinonaktifkan atau tidak tersedia dan file tidak ditemukan di cache.
  • EnvironmentError — Jika token=True tetapi token tidak dapat ditemukan.
  • OSError — Jika ETag tidak dapat ditentukan.
  • ValueError — Jika nilai beberapa parameter tidak valid.

Unduh file tertentu jika belum ada di cache lokal.

Tata letak file cache baru terlihat seperti ini:

  • Direktori cache berisi satu subfolder per repo_id (dibedakan berdasarkan jenis repo)
  • di dalam setiap folder repo:
    • refs adalah daftar pasangan revisi terakhir yang diketahui => commit_hash
    • blobs berisi blob file yang sebenarnya (diidentifikasi oleh git-sha atau sha256, tergantung pada apakah file tersebut merupakan file LFS atau bukan)
    • snapshots berisi satu subfolder per commit, di mana setiap “commit” berisi subset file yang telah di-resolve pada commit tersebut. Setiap nama file adalah symlink ke blob pada commit tersebut.
[  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

Jika local_dir disediakan, struktur file dari repo akan direplikasi di lokasi ini. Saat menggunakan opsi ini, cache_dir tidak akan digunakan dan folder .cache/huggingface/ akan dibuat di akar local_dir untuk menyimpan beberapa metadata terkait file yang diunduh. Meskipun mekanisme ini tidak sekuat sistem cache utama, ini dioptimalkan untuk menarik versi terbaru dari repositori secara rutin.

sembunyikan_komentar_diskusi

< >

( repo_id: strdiscussion_num: intcomment_id: strtoken: bool | str | None = Nonerepo_type: str | None = None ) → DiscussionComment

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • discussion_num (int) — Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif.
  • comment_id (str) — ID komentar yang akan diedit.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

KomentarDiskusi

komentar tersembunyi

Menyembunyikan komentar pada Diskusi / Pull Request.

Konten komentar tersembunyi tidak dapat diambil lagi. Menyembunyikan komentar bersifat tidak dapat dibatalkan.

Membuang kesalahan berikut:

  • HTTPError jika API HuggingFace mengembalikan error
  • ValueError jika nilai beberapa parameter tidak valid
  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.

inspect_job

< >

( job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parameter

  • job_id (str) — ID dari Job.
  • namespace (str, opsional) — Namespace tempat Job berjalan. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Periksa Job komputasi pada infrastruktur Hugging Face.

Contoh:

>>> 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

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parameter

  • scheduled_job_id (str) — ID dari Job terjadwal.
  • namespace (str, opsional) — Namespace tempat Job terjadwal berada. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Periksa Job komputasi terjadwal di infrastruktur Hugging Face.

Contoh:

>>> 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

< >

( repo_id: strrevision: str | None = Nonetimeout: float | None = Nonetoken: bool | str | None = None ) → ModelInfo

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • revision (str, opsional) — Revisi dari repositori kernel yang digunakan untuk mengambil informasi.
  • timeout (float, opsional) — Apakah akan mengatur batas waktu (timeout) untuk permintaan ke Hub.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

ModelInfo

Informasi repositori kernel.

Dapatkan informasi tentang satu kernel tertentu di huggingface.co.

list_accepted_access_requests

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[AccessRequest]

Parameter

  • repo_id (str) — ID repo untuk mendapatkan permintaan akses.
  • repo_type (str, opsional) — Jenis repo untuk mendapatkan permintaan akses. Harus salah satu dari model, dataset atau space. Bawaan adalah model.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[AccessRequest]

Iterable dari objek AccessRequest. Setiap item berisi atribut username, request_id, email, status dan timestamp. Jika repo bergerbang memiliki formulir kustom, atribut fields akan terisi dengan jawaban pengguna.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 jika repo tidak gated.
  • HfHubHTTPError — HTTP 403 jika Anda hanya memiliki akses baca-saja ke repo. Hal ini dapat terjadi jika Anda tidak memiliki peran write atau admin di organisasi tempat repo tersebut berada, atau jika Anda menggunakan token read.

Dapatkan permintaan akses yang diterima untuk repositori bergerbang tertentu.

Permintaan yang diterima berarti pengguna telah meminta akses ke repo dan permintaan tersebut telah diterima. Pengguna dapat mengunduh file apa pun dari repo. Jika mode persetujuan adalah otomatis, daftar ini seharusnya secara default berisi semua permintaan. Permintaan yang diterima dapat dibatalkan atau ditolak kapan saja menggunakan cancel_access_request() dan reject_access_request(). Permintaan yang dibatalkan akan kembali ke daftar pending, sedangkan permintaan yang ditolak akan masuk ke daftar rejected. Dalam kedua kasus, pengguna akan kehilangan akses ke repo.

Untuk informasi lebih lanjut tentang repositori bergerbang, lihat https://huggingface.co/docs/hub/models-gated.

Contoh:

>>> 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

< >

( bucket_id: strprefix: str | None = Nonerecursive: bool | None = Nonetoken: str | bool | None = None ) → Iterable[Union[BucketFile, BucketFolder]]

Parameter

  • bucket_id (str) — ID dari bucket (mis. "username/my-bucket").
  • prefix (str, opsional) — Saring hasil ke file yang path-nya diawali dengan prefix ini.
  • recursive (bool, opsional) — Jika True, daftarkan file secara rekursif. Jika False (default), daftarkan file dan direktori hanya di root.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[Union[BucketFile, BucketFolder]]

Iterable dari objek BucketFile dan BucketFolder yang berisi informasi file dan direktori (path, dll.).

Daftarkan file dalam bucket.

Contoh:

>>> 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

< >

( namespace: str | None = Nonesearch: str | None = Nonetoken: bool | str | None = None ) → Iterable[BucketInfo]

Parameter

  • namespace (str, opsional) — Daftarkan bucket di bawah namespace ini (pengguna atau organisasi). Secara default, mendaftarkan bucket milik pengguna.
  • search (str, opsional) — String pencarian untuk menyaring nama bucket.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[BucketInfo]

Iterable dari objek BucketInfo.

Daftarkan bucket di Hub di bawah namespace tertentu.

Contoh:

>>> 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

< >

( owner: list[str] | str | None = Noneitem: list[str] | str | None = Nonesort: CollectionSort_T | None = Nonelimit: int | None = Nonetoken: bool | str | None = None ) → Iterable[Collection]

Parameter

  • owner (list[str] atau str, opsional) — Saring berdasarkan nama pengguna pemilik.
  • item (list[str] atau str, opsional) — Filter koleksi yang berisi item tertentu. Contoh: "models/teknium/OpenHermes-2.5-Mistral-7B", "datasets/squad" atau "papers/2311.12983".
  • sort (Literal["lastModified", "trending", "upvotes"], opsional) — Urutkan koleksi berdasarkan terakhir diubah, tren, atau upvotes.
  • limit (int, opsional) — Jumlah maksimum koleksi yang akan dikembalikan.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[Collection]

iterable dari objek Collection.

Daftarkan koleksi di Huggingface Hub, dengan beberapa filter tertentu.

Saat mendaftar koleksi, daftar item per koleksi dipangkas menjadi maksimal 4 item. Untuk mengambil semua item dari sebuah koleksi, Anda harus menggunakan get_collection().

list_daily_papers

< >

( date: str | None = Nonetoken: bool | str | None = Noneweek: str | None = Nonemonth: str | None = Nonesubmitter: str | None = Nonesort: DailyPapersSort_T | None = Nonep: int | None = Nonelimit: int | None = None ) → Iterable[PaperInfo]

Parameter

  • date (str, opsional) — Tanggal dalam format ISO (YYYY-MM-DD) untuk mengambil paper harian. Secara default, mengambil yang terbaru.
  • token (Union[bool, str, None], opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal. Untuk menonaktifkan autentikasi, berikan False.
  • week (str, opsional) — Minggu dalam format ISO (YYYY-Www) untuk mengambil paper harian. Contoh, 2025-W09.
  • month (str, opsional) — Bulan dalam format ISO (YYYY-MM) untuk mengambil paper harian. Contoh, 2025-02.
  • submitter (str, opsional) — Nama pengguna pengirim untuk memfilter paper harian.
  • sort (Literal["publishedAt", "trending"], opsional) — Urutan pengurutan untuk paper harian. Bisa berdasarkan publishedAt atau berdasarkan trending. Bawaan adalah "publishedAt"
  • p (int, opsional) — Nomor halaman untuk paginasi. Bawaan adalah 0.
  • limit (int, opsional) — Batas jumlah makalah yang diambil. Defaultnya 50.

Mengembalikan

Iterable[PaperInfo]

iterable dari objek huggingface_hub.hf_api.PaperInfo.

Daftarkan paper harian yang diterbitkan pada tanggal tertentu di Hugging Face Hub.

Contoh:

>>> from huggingface_hub import HfApi

>>> api = HfApi()
>>> list(api.list_daily_papers(date="2025-10-29"))

list_dataset_parquet_files

< >

( repo_id: strconfig: str | None = Nonetoken: bool | str | None = None ) → list[DatasetParquetEntry]

Parameter

  • repo_id (str) — ID repositori dataset (mis. "username/dataset-name").
  • config (str, opsional) — Filter berdasarkan nama config/subset tertentu. Jika diberikan, hanya file parquet untuk config tersebut yang dikembalikan.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

list[DatasetParquetEntry]

daftar objek DatasetParquetEntry yang berisi config, split, url, dan size untuk setiap file parquet.

Daftarkan file parquet yang tersedia untuk dataset di Hub.

Semua dataset yang dihosting di Hub dikonversi secara otomatis ke Parquet oleh Dataset Viewer. Metode ini mengembalikan daftar file parquet beserta URL, konfigurasi, split, dan ukurannya.

Contoh:

>>> 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

< >

( filter: str | Iterable[str] | None = Noneauthor: str | None = Nonebenchmark: Literal[True] | Literal['official'] | str | None = Nonedataset_name: str | None = Nonegated: bool | None = Nonelanguage_creators: str | list[str] | None = Nonelanguage: str | list[str] | None = Nonemultilinguality: str | list[str] | None = Nonesize_categories: str | list[str] | None = Nonetask_categories: str | list[str] | None = Nonetask_ids: str | list[str] | None = Nonesearch: str | None = Nonesort: DatasetSort_T | None = Nonelimit: int | None = Noneexpand: list[ExpandDatasetProperty_T] | None = Nonefull: bool | None = Nonetoken: bool | str | None = None ) → Iterable[DatasetInfo]

Parameter

  • filter (str atau Iterable[str], opsional) — String atau daftar string untuk memfilter dataset di hub.
  • author (str, opsional) — String yang mengidentifikasi penulis dari dataset yang dikembalikan.
  • benchmark (True, "official", str, opsional) — Saring dataset berdasarkan benchmark. Bisa berupa True atau "official" untuk mengembalikan dataset benchmark resmi. Untuk kompatibilitas di masa depan, juga bisa berupa string yang merepresentasikan nama benchmark (saat ini hanya “official” yang didukung).
  • dataset_name (str, opsional) — String atau daftar string yang dapat digunakan untuk mengidentifikasi dataset di Hub berdasarkan namanya, seperti SQAC atau wikineural
  • gated (bool, opsional) — Boolean untuk memfilter dataset di Hub yang bersifat gated atau tidak. Secara default, semua dataset dikembalikan. Jika gated=True diteruskan, hanya dataset gated yang dikembalikan. Jika gated=False diteruskan, hanya dataset non-gated yang dikembalikan.
  • language_creators (str atau List, opsional) — String atau daftar string yang dapat digunakan untuk mengidentifikasi dataset di Hub berdasarkan cara data dikurasi, seperti crowdsourced atau machine_generated.
  • language (str atau List, opsional) — String atau daftar string yang merepresentasikan bahasa dua karakter untuk memfilter dataset berdasarkan bahasa di Hub.
  • multilinguality (str atau List, opsional) — String atau daftar string yang merepresentasikan filter untuk dataset yang mengandung beberapa bahasa.
  • size_categories (str atau List, opsional) — String atau daftar string yang dapat digunakan untuk mengidentifikasi dataset di Hub berdasarkan ukuran dataset, seperti 100K<n<1M atau 1M<n<10M.
  • task_categories (str atau List, opsional) — String atau daftar string yang dapat digunakan untuk mengidentifikasi dataset di Hub berdasarkan tugas yang dirancang, seperti audio_classification atau named_entity_recognition.
  • task_ids (str atau List, opsional) — String atau daftar string yang dapat digunakan untuk mengidentifikasi dataset di Hub berdasarkan tugas tertentu seperti speech_emotion_recognition atau paraphrase.
  • search (str, opsional) — String yang akan terkandung dalam dataset yang dikembalikan.
  • sort (DatasetSort_T, opsional) — Kunci untuk mengurutkan dataset yang dihasilkan. Nilai yang mungkin adalah “created_at”, “downloads”, “last_modified”, “likes” dan “trending_score”.
  • limit (int, opsional) — Batas jumlah dataset yang diambil. Jika opsi ini dibiarkan sebagai None, semua dataset akan diambil.
  • expand (list[ExpandDatasetProperty_T], opsional) — Daftar properti yang akan dikembalikan dalam respons. Jika digunakan, hanya properti yang ada dalam daftar tersebut yang akan dikembalikan. Parameter ini tidak dapat digunakan jika full diteruskan. Nilai yang mungkin adalah "author", "cardData", "citation", "createdAt", "disabled", "description", "downloads", "downloadsAllTime", "gated", "lastModified", "likes", "mainSize", "paperswithcode_id", "private", "siblings", "sha", "tags", "trendingScore", "usedStorage", dan "resourceGroup".
  • full (bool, opsional) — Apakah akan mengambil semua data dataset, termasuk last_modified, card_data, dan file-filenya. Dapat berisi informasi berguna seperti ID PapersWithCode.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[DatasetInfo]

iterable dari objek huggingface_hub.hf_api.DatasetInfo.

Daftarkan dataset yang dihosting di Huggingface Hub, dengan beberapa filter tertentu.

Contoh penggunaan dengan argumen filter:

>>> 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")

Contoh penggunaan dengan argumen search:

>>> 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

< >

( accelerator: Literal['cpu', 'gpu', 'neuron'] | str | None = Noneengine: Literal['llamacpp', 'sglang', 'tei', 'vllm'] | str | None = Nonelicense: str | None = Nonetask: str | None = Nonesearch: str | None = Nonelimit: int | None = Nonetoken: bool | str | None = None ) → list[InferenceCatalogModel]

Parameter

  • accelerator (str, opsional) — Hanya kembalikan model yang memiliki resep untuk akselerator ini ("cpu", "gpu" atau "neuron").
  • engine (str, opsional) — Hanya kembalikan model yang memiliki resep untuk mesin inferensi ini (mis. "vllm", "llamacpp", "tei", "sglang").
  • license (str, opsional) — Hanya kembalikan model di bawah lisensi ini (mis. "Apache 2.0").
  • task (str, opsional) — Hanya kembalikan model untuk tugas ini (mis. "text-generation").
  • search (str, opsional) — Hanya kembalikan model yang cocok dengan kueri pencarian ini.
  • limit (int, opsional) — Jumlah maksimum model yang akan dikembalikan.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication).

Mengembalikan

list[InferenceCatalogModel]

Model-model yang tersedia di katalog, masing-masing dengan resep yang telah diujinya.

Daftarkan model yang tersedia di Hugging Face Inference Catalog.

Tujuan dari Inference Catalog adalah menyediakan daftar model yang dikurasi, yang dioptimalkan untuk inferensi dan telah diuji dengan konfigurasi default. Lihat https://endpoints.huggingface.co/catalog untuk daftar model yang tersedia di katalog.

Gunakan create_inference_endpoint_from_catalog() untuk mendeploy model atau resep dari katalog.

Contoh:

>>> 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']), ...]

list_inference_catalog bersifat eksperimental. API-nya dapat berubah di masa depan. Silakan berikan umpan balik jika Anda memiliki saran atau permintaan.

list_inference_endpoints

< >

( namespace: str | None = Nonetoken: bool | str | None = None ) → listInferenceEndpoint

Parameter

  • namespace (str, opsional) — Namespace untuk mendaftar endpoint. Defaultnya adalah pengguna saat ini. Atur ke "*" untuk mendaftar semua endpoint dari semua namespace (yaitu namespace pribadi dan semua org yang pengguna tersebut menjadi anggotanya).
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

listInferenceEndpoint

Daftar semua endpoint inferensi untuk namespace yang diberikan.

Mencantumkan semua endpoint inferensi untuk namespace yang diberikan.

Contoh:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.list_inference_endpoints()
[InferenceEndpoint(name='my-endpoint', ...), ...]

list_inference_endpoints_hardware

< >

( namespace: str | None = Nonetoken: bool | str | None = None ) → list[InferenceEndpointHardware]

Parameter

  • namespace (str, opsional) — Namespace yang hardware dan kuota akseleratornya tersedia untuk di daftarkan. Defaultnya adalah pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication).

Mengembalikan

list[InferenceEndpointHardware]

Perangkat keras yang tersedia di setiap vendor dan wilayah, termasuk perangkat keras yang saat ini tidak tersedia atau sudah tidak didukung lagi.

Daftarkan perangkat keras yang tersedia untuk mendeploy Inference Endpoint.

Setiap entri membawa nilai vendor, region, accelerator, instance_type, dan instance_size yang diharapkan oleh create_inference_endpoint(), beserta harga dan kuota akselerator dari namespace.

Contoh:

>>> 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

< >

( status: list[JobStage | str] | JobStage | str | None = Nonelabels: dict[str, str] | None = Nonetimeout: int | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → Iterable[JobInfo]

Parameter

  • status (JobStage, str atau list, opsional) — Hanya kembalikan Job dengan status yang diberikan, misalnya "RUNNING" atau [JobStage.RUNNING, JobStage.SCHEDULING]. Lihat JobStage untuk nilai yang mungkin.
  • labels (dict[str, str], opsional) — Hanya kembalikan Jobs yang memiliki semua label key=value yang diberikan, misalnya {"env": "prod", "team": "ml"}.
  • timeout (float, opsional) — Apakah akan mengatur batas waktu (timeout) untuk permintaan ke Hub.
  • namespace (str, opsional) — Namespace tempat daftar pekerjaan diambil. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Mengembalikan

Iterable[JobInfo]

iterable dari objek JobInfo.

Daftarkan compute Jobs pada infrastruktur Hugging Face.

list_jobs_hardware

< >

( token: bool | str | None = None ) → list[JobHardwareInfo]

Mengembalikan

list[JobHardwareInfo]

Daftar konfigurasi perangkat keras yang tersedia.

Daftarkan opsi hardware yang tersedia untuk Jobs pada infrastruktur Hugging Face.

Contoh:

>>> 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

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[LFSFileInfo]

Parameter

  • repo_id (str) — Repositori tempat Anda mendaftar file LFS.
  • repo_type (str, opsional) — Jenis repositori. Atur ke "dataset" atau "space" jika mendaftar dari dataset atau space, None atau "model" jika mendaftar dari model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[LFSFileInfo]

Iterator dari objek LFSFileInfo.

Daftarkan semua file LFS dalam repo di Hub.

Ini terutama berguna untuk menghitung berapa banyak penyimpanan yang digunakan oleh sebuah repo dan untuk membersihkan file-file besar dengan permanently_delete_lfs_files(). Perhatikan bahwa ini akan menjadi tindakan permanen yang akan memengaruhi semua commit yang merujuk pada file yang dihapus ini dan tidak dapat dibatalkan.

Contoh:

>>> 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

< >

( user: str | None = Nonetoken: bool | str | None = None ) → UserLikes

Parameter

  • user (str, opsional) — Nama pengguna yang suka-nya ingin Anda ambil.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

UserLikes

objek yang berisi nama pengguna dan 3 daftar id repo (1 untuk model, 1 untuk dataset, dan 1 untuk Spaces).

Membuang

ValueError

  • ValueError — Jika user tidak diteruskan dan tidak ada token yang ditemukan (baik dari argumen maupun dari mesin).

Daftar semua repositori publik yang disukai oleh pengguna di huggingface.co.

Daftar ini bersifat publik sehingga token bersifat opsional. Jika user tidak diberikan, nilai defaultnya adalah pengguna yang sedang masuk.

Lihat juga unlike().

Contoh:

>>> 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

< >

( filter: str | Iterable[str] | None = Noneauthor: str | None = Noneapps: str | list[str] | None = Nonegated: bool | None = Noneinference: Literal['warm'] | None = Noneinference_provider: Literal['all'] | PROVIDER_T | list[PROVIDER_T] | None = Nonetrained_dataset: str | list[str] | None = Nonesearch: str | None = Nonepipeline_tag: str | None = Nonenum_parameters: str | None = Noneemissions_thresholds: tuple[float, float] | None = Nonesort: ModelSort_T | None = Nonelimit: int | None = Noneexpand: list[ExpandModelProperty_T] | None = Nonefull: bool | None = NonecardData: bool = Falsefetch_config: bool = Falsetoken: bool | str | None = None ) → Iterable[ModelInfo]

Parameter

  • filter (str atau Iterable[str], opsional) — String atau daftar string untuk memfilter model di Hub. Model dapat difilter berdasarkan library, bahasa, tugas, tag, dan lainnya.
  • author (str, opsional) — String yang mengidentifikasi penulis (pengguna atau organisasi) dari model yang dikembalikan.
  • apps (str atau List, opsional) — String atau daftar string untuk memfilter model di Hub yang mendukung aplikasi yang ditentukan. Contoh nilai termasuk "ollama" atau ["ollama", "vllm"].
  • gated (bool, opsional) — Boolean untuk memfilter model di Hub yang bersifat gated atau tidak. Secara default, semua model dikembalikan. Jika gated=True diteruskan, hanya model gated yang dikembalikan. Jika gated=False diteruskan, hanya model non-gated yang dikembalikan.
  • inference (Literal["warm"], opsional) — Jika “warm”, saring model di Hub yang saat ini dilayani oleh setidaknya satu penyedia.
  • inference_provider (Literal["all"] atau str, opsional) — String untuk memfilter model di Hub yang disajikan oleh penyedia tertentu. Lewati "all" untuk mendapatkan semua model yang disajikan oleh setidaknya satu penyedia.
  • trained_dataset (str atau List, opsional) — Tag string atau daftar tag string dari dataset terlatih untuk model di Hub.
  • search (str, opsional) — String yang akan terkandung dalam id model yang dikembalikan.
  • pipeline_tag (str, opsional) — String tag pipeline untuk memfilter model di Hub berdasarkan tag tersebut, seperti summarization.
  • num_parameters (str, opsional) — Saring model berdasarkan jumlah parameter. Menerima sintaks rentang yang sama dengan UI dan API Hub, misalnya "min:6B,max:128B", "min:6B" atau "max:128B".
  • emissions_thresholds (Tuple, opsional) — Tupel dari dua int atau float yang mewakili jejak karbon minimum dan maksimum untuk memfilter model yang dihasilkan, dalam gram.
  • sort (ModelSort_T, opsional) — Kunci untuk mengurutkan model yang dihasilkan. Nilai yang mungkin adalah “created_at”, “downloads”, “last_modified”, “likes” dan “trending_score”.
  • limit (int, opsional) — Batas jumlah model yang diambil. Membiarkan opsi ini sebagai None akan mengambil semua model.
  • expand (list[ExpandModelProperty_T], opsional) — Daftar properti yang akan dikembalikan dalam respons. Jika digunakan, hanya properti yang ada dalam daftar tersebut yang akan dikembalikan. Parameter ini tidak dapat digunakan jika full, cardData atau fetch_config diteruskan. Nilai yang mungkin adalah "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", dan "resourceGroup".
  • full (bool, opsional) — Apakah akan mengambil semua data model, termasuk last_modified, sha, file, dan tags. Ini diatur ke True secara default saat menggunakan filter.
  • cardData (bool, opsional) — Apakah metadata untuk model juga akan diambil. Dapat berisi informasi berguna seperti emisi karbon, metrik, dan dataset yang digunakan untuk pelatihan.
  • fetch_config (bool, opsional) — Apakah akan mengambil konfigurasi model juga. Ini tidak termasuk di full karena ukurannya.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[ModelInfo]

iterable dari objek huggingface_hub.hf_api.ModelInfo.

Daftarkan model yang dihosting di Huggingface Hub, dengan beberapa filter tertentu.

Contoh:

>>> 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

< >

( organization: strtoken: bool | str | None = None ) → Iterable[User]

Parameter

  • organization (str) — Nama organisasi yang pengikutnya akan diambil.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[User]

Daftar objek User dengan pengikut organisasi.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 Jika organisasi tidak ada di Hub.

Daftarkan pengikut sebuah organisasi di Hub.

list_organization_members

< >

( organization: strtoken: bool | str | None = None ) → Iterable[User]

Parameter

  • organization (str) — Nama organisasi untuk mendapatkan anggotanya.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[User]

Daftar objek User dengan anggota organisasi.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 Jika organisasi tidak ada di Hub.

Daftar anggota organisasi di Hub.

list_papers

< >

( query: str | None = Nonelimit: int | None = Nonetoken: bool | str | None = None ) → Iterable[PaperInfo]

Parameter

  • query (str, opsional) — String kueri pencarian untuk menemukan makalah. Jika diberikan, mengembalikan makalah yang cocok dengan kueri.
  • limit (int, opsional) — Jumlah maksimum makalah yang akan dikembalikan.
  • token (Union[bool, str, None], opsional) — Token akses pengguna yang valid (string). Secara bawaan menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[PaperInfo]

iterable dari objek huggingface_hub.hf_api.PaperInfo.

Daftarkan paper harian di Hugging Face Hub berdasarkan kueri pencarian.

Contoh:

>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all papers with "attention" in their title
>>> api.list_papers(query="attention")

list_pending_access_requests

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[AccessRequest]

Parameter

  • repo_id (str) — ID repo untuk mendapatkan permintaan akses.
  • repo_type (str, opsional) — Jenis repo untuk mendapatkan permintaan akses. Harus salah satu dari model, dataset atau space. Bawaan adalah model.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[AccessRequest]

Iterable dari objek AccessRequest. Setiap item berisi atribut username, request_id, email, status dan timestamp. Jika repo bergerbang memiliki formulir kustom, atribut fields akan terisi dengan jawaban pengguna.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 jika repo tidak gated.
  • HfHubHTTPError — HTTP 403 jika Anda hanya memiliki akses baca-saja ke repo. Hal ini dapat terjadi jika Anda tidak memiliki peran write atau admin di organisasi tempat repo tersebut berada, atau jika Anda menggunakan token read.

Dapatkan permintaan akses yang tertunda untuk repositori bergerbang tertentu.

Permintaan yang tertunda berarti pengguna telah meminta akses ke repo tetapi permintaan tersebut belum diproses. Jika mode persetujuan adalah otomatis, daftar ini seharusnya kosong. Permintaan yang tertunda dapat diterima atau ditolak menggunakan accept_access_request() dan reject_access_request().

Untuk informasi lebih lanjut tentang repositori bergerbang, lihat https://huggingface.co/docs/hub/models-gated.

Contoh:

>>> 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

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[AccessRequest]

Parameter

  • repo_id (str) — ID repo untuk mendapatkan permintaan akses.
  • repo_type (str, opsional) — Jenis repo untuk mendapatkan permintaan akses. Harus salah satu dari model, dataset atau space. Bawaan adalah model.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[AccessRequest]

Iterable dari objek AccessRequest. Setiap item berisi atribut username, request_id, email, status dan timestamp. Jika repo bergerbang memiliki formulir kustom, atribut fields akan terisi dengan jawaban pengguna.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 jika repo tidak gated.
  • HfHubHTTPError — HTTP 403 jika Anda hanya memiliki akses baca-saja ke repo. Hal ini dapat terjadi jika Anda tidak memiliki peran write atau admin di organisasi tempat repo tersebut berada, atau jika Anda menggunakan token read.

Dapatkan permintaan akses yang ditolak untuk repositori bergerbang tertentu.

Permintaan yang ditolak berarti pengguna telah meminta akses ke repo dan permintaan tersebut secara eksplisit ditolak oleh pemilik repo (baik Anda maupun pengguna lain dari organisasi Anda). Pengguna tidak dapat mengunduh file apa pun dari repo. Permintaan yang ditolak dapat diterima atau dibatalkan kapan saja menggunakan accept_access_request() dan cancel_access_request(). Permintaan yang dibatalkan akan kembali ke daftar pending, sedangkan permintaan yang diterima akan masuk ke daftar accepted.

Untuk informasi lebih lanjut tentang repositori bergerbang, lihat https://huggingface.co/docs/hub/models-gated.

Contoh:

>>> 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

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = Nonerevision: str | None = Noneformatted: bool = False ) → list[GitCommitInfo]

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mendaftar commit dari dataset atau Space, None atau "model" jika mendaftar dari model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • revision (str, opsional) — Revisi git untuk di-commit. Secara default menggunakan head dari cabang "main".
  • formatted (bool) — Apakah akan mengembalikan judul dan deskripsi commit yang diformat HTML. Defaultnya False.

Mengembalikan

list[GitCommitInfo]

daftar objek yang berisi informasi tentang commit untuk repo di Hub.

Membuang

RepositoryNotFoundError atau RevisionNotFoundError

  • RepositoryNotFoundError — Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada.
  • RevisionNotFoundError — Jika revisi tidak ditemukan (error 404) di repo.

Dapatkan daftar commit dari revisi tertentu untuk repo di Hub.

Commit diurutkan berdasarkan tanggal (commit terakhir di awal).

Contoh:

>>> 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

< >

( repo_id: strrevision: str | None = Nonerepo_type: str | None = Nonetoken: str | bool | None = None ) → list[str]

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • revision (str, opsional) — Revisi repositori yang menjadi sumber informasi.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

list[str]

daftar file dalam repositori tertentu.

Dapatkan daftar file di repo tertentu.

list_repo_likers

< >

( repo_id: strrepo_type: str | None = Nonetoken: bool | str | None = None ) → Iterable[User]

Parameter

  • repo_id (str) — Repositori yang akan diambil. Contoh: "user/my-cool-model".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model. Default adalah None.

Mengembalikan

Iterable[User]

iterable dari objek huggingface_hub.hf_api.User.

Daftarkan semua pengguna yang menyukai repositori tertentu di hugging Face Hub.

Lihat juga list_liked_repos().

list_repo_refs

< >

( repo_id: strrepo_type: str | None = Noneinclude_pull_requests: bool = Falsetoken: str | bool | None = None ) → GitRefs

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • repo_type (str, opsional) — Atur ke "dataset", "space" atau "kernel" jika mendaftar refs dari dataset, Space, atau Kernel, None atau "model" jika mendaftar dari model. Default adalah None.
  • include_pull_requests (bool, opsional) — Apakah akan menyertakan refs dari pull request dalam daftar. Defaultnya adalah False.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

GitRefs

objek yang berisi semua informasi tentang cabang dan tag untuk sebuah repo di Hub.

Dapatkan daftar ref dari repo tertentu (baik tag maupun cabang).

Contoh:

>>> 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

< >

( repo_id: strpath_in_repo: str | None = Nonerecursive: bool = Falseexpand: bool = Falserevision: str | None = Nonerepo_type: str | None = Nonetoken: str | bool | None = None ) → Iterable[Union[RepoFile, RepoFolder]]

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • path_in_repo (str, opsional) — Path relatif dari tree (folder) di repo, misalnya: "checkpoints/1fec34a/results". Secara default akan menggunakan tree (folder) root dari repository.
  • recursive (bool, opsional, default False) — Apakah akan mendaftar file dan folder pohon secara rekursif.
  • expand (bool, opsional, default False) — Apakah akan mengambil informasi lebih lanjut tentang file dan folder di pohon (misalnya commit terakhir dan hasil pemindaian keamanan file). Operasi ini lebih mahal bagi server sehingga hanya 50 hasil yang dikembalikan per halaman (bukan 1000). Karena paginasi diimplementasikan di huggingface_hub, hal ini transparan bagi Anda kecuali untuk waktu yang dibutuhkan untuk mendapatkan hasil.
  • revision (str, opsional) — Revisi repositori tempat pohon diambil. Bawaan adalah cabang "main".
  • repo_type (str, opsional) — Jenis repositori yang akan diambil pohonnya ("model", "dataset", "space" atau "kernel"). Nilai defaultnya adalah "model".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[Union[RepoFile, RepoFolder]]

Informasi tentang file dan folder pohon, sebagai iterable dari objek RepoFile dan RepoFolder. Urutan file dan folder tidak dijamin.

Membuang

RepositoryNotFoundError atau RevisionNotFoundError atau ~utils.RemoteEntryNotFoundError

  • RepositoryNotFoundError — Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada.
  • RevisionNotFoundError — Jika revisi tidak ditemukan (error 404) di repo.
  • ~utils.RemoteEntryNotFoundError — Jika tree (folder) tidak ada (error 404) di repo.

Daftarkan file dan folder dari pohon repo serta dapatkan informasi tentang mereka.

Contoh:

Dapatkan informasi tentang pohon repo.

>>> 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)]
]

Dapatkan informasi lebih lanjut tentang pohon repo (commit terakhir dan hasil pemindaian keamanan file)

>>> 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

< >

( labels: dict[str, str] | None = Nonetimeout: int | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → list[ScheduledJobInfo]

Parameter

  • labels (dict[str, str], opsional) — Hanya kembalikan Job yang dijadwalkan yang memiliki semua label key=value yang diberikan, misalnya {"env": "prod", "team": "ml"}.
  • timeout (float, opsional) — Apakah akan mengatur batas waktu (timeout) untuk permintaan ke Hub.
  • namespace (str, opsional) — Namespace tempat daftar pekerjaan diambil. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Mengembalikan

list[ScheduledJobInfo]

daftar objek ScheduledJobInfo.

Daftarkan Jobs komputasi terjadwal di infrastruktur Hugging Face.

list_space_templates

< >

( token: str | bool | None = None ) → list[SpaceTemplate]

Parameter

Mengembalikan

list[SpaceTemplate]

Daftar template Space yang tersedia.

Daftarkan template Space resmi yang tersedia di Hub.

repo_id dari template yang dikembalikan (atau name singkatnya) dapat diteruskan sebagai space_template ke HfApi.create_repo() untuk membuat Space baru dari template tersebut.

Contoh:

>>> 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

< >

( filter: str | Iterable[str] | None = Noneauthor: str | None = Nonesearch: str | None = Nonedatasets: str | Iterable[str] | None = Nonemodels: str | Iterable[str] | None = Nonelinked: bool = Falsesort: SpaceSort_T | None = Nonelimit: int | None = Noneexpand: list[ExpandSpaceProperty_T] | None = Nonefull: bool | None = Nonetoken: bool | str | None = None ) → Iterable[SpaceInfo]

Parameter

  • filter (str atau Iterable, opsional) — Tag string atau daftar tag yang dapat digunakan untuk mengidentifikasi Spaces di Hub.
  • author (str, opsional) — String yang mengidentifikasi penulis dari Spaces yang dikembalikan.
  • search (str, opsional) — String yang akan terkandung dalam Spaces yang dikembalikan.
  • datasets (str atau Iterable, opsional) — Apakah akan mengembalikan Spaces yang menggunakan dataset. Nama dataset tertentu dapat diteruskan sebagai string.
  • models (str atau Iterable, opsional) — Apakah akan mengembalikan Spaces yang menggunakan model. Nama model tertentu dapat diteruskan sebagai string.
  • linked (bool, opsional) — Apakah akan mengembalikan Spaces yang menggunakan model atau dataset.
  • sort (SpaceSort_T, opsional) — Kunci untuk mengurutkan ruang yang dihasilkan. Nilai yang mungkin adalah “created_at”, “last_modified”, “likes” dan “trending_score”.
  • limit (int, opsional) — Batas jumlah Spaces yang diambil. Membiarkan opsi ini sebagai None akan mengambil semua Spaces.
  • expand (list[ExpandSpaceProperty_T], opsional) — Daftar properti yang akan dikembalikan dalam respons. Jika digunakan, hanya properti yang ada dalam daftar tersebut yang akan dikembalikan. Parameter ini tidak dapat digunakan jika full diteruskan. Nilai yang mungkin adalah "author", "cardData", "datasets", "disabled", "lastModified", "createdAt", "likes", "models", "private", "region", "runtime", "sdk", "siblings", "sha", "subdomain", "tags", "trendingScore", "usedStorage", dan "resourceGroup".
  • full (bool, opsional) — Apakah akan mengambil semua data Spaces, termasuk field last_modified, siblings dan card_data.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[SpaceInfo]

iterable dari objek huggingface_hub.hf_api.SpaceInfo.

Daftarkan ruang yang dihosting di Huggingface Hub, dengan beberapa filter tertentu.

list_spaces_hardware

< >

( token: bool | str | None = None ) → list[JobHardwareInfo]

Mengembalikan

list[JobHardwareInfo]

Daftar konfigurasi perangkat keras yang tersedia.

Daftarkan opsi hardware yang tersedia untuk Spaces.

Contoh:

>>> 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

< >

( username: strtoken: bool | str | None = None ) → Iterable[User]

Parameter

  • username (str) — Nama pengguna dari pengguna yang pengikutnya akan diambil.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[User]

Daftar objek User yang berisi pengikut dari pengguna tersebut.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 Jika pengguna tidak ada di Hub.

Dapatkan daftar pengikut pengguna di Hub.

list_user_following

< >

( username: strtoken: bool | str | None = None ) → Iterable[User]

Parameter

  • username (str) — Nama pengguna dari pengguna yang akan diambil daftar pengikutnya.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[User]

Daftar objek User berisi pengguna yang diikuti oleh pengguna tersebut.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 Jika pengguna tidak ada di Hub.

Dapatkan daftar pengguna yang diikuti oleh pengguna di Hub.

list_user_repos

< >

( namespace: str | None = Nonetoken: bool | str | None = None ) → Iterable[RepoStorageInfo]

Parameter

  • namespace (str, opsional) — Nama organisasi. Jika tidak diberikan, akan menampilkan repositori untuk pengguna yang terautentikasi.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Secara default menggunakan token yang disimpan secara lokal.

Mengembalikan

Iterable[RepoStorageInfo]

Iterable dari objek RepoStorageInfo.

Daftarkan semua repositori (model, dataset, spaces, buckets) untuk pengguna atau organisasi dengan informasi penyimpanan.

Menggunakan endpoint /api/settings/repositories untuk pengguna yang terautentikasi atau /api/organizations/{namespace}/settings/repositories untuk organisasi.

Contoh:

>>> 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

< >

( token: bool | str | None = None ) → list[WebhookInfo]

Parameter

Mengembalikan

list[WebhookInfo]

Daftar objek info webhook.

Daftarkan semua webhook yang dikonfigurasi.

Contoh:

>>> 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

< >

( repo_id: strdiscussion_num: inttoken: bool | str | None = Nonecomment: str | None = Nonerepo_type: str | None = None ) → DiscussionStatusChange

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • discussion_num (int) — Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif.
  • comment (str, opsional) — Komentar opsional untuk diposting bersama perubahan status.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

DiscussionStatusChange

peristiwa perubahan status

Menggabungkan Pull Request.

Membuang kesalahan berikut:

  • HTTPError jika API HuggingFace mengembalikan error
  • ValueError jika nilai beberapa parameter tidak valid
  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.

informasi_model

< >

( repo_id: strrevision: str | None = Nonetimeout: float | None = NonesecurityStatus: bool | None = Nonefiles_metadata: bool = Falseexpand: list[ExpandModelProperty_T] | None = Nonetoken: bool | str | None = None ) → huggingface_hub.hf_api.ModelInfo

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • revision (str, opsional) — Revisi dari repositori model tempat informasi diambil.
  • timeout (float, opsional) — Apakah akan mengatur batas waktu (timeout) untuk permintaan ke Hub.
  • securityStatus (bool, opsional) — Apakah akan mengambil status keamanan dari repositori model juga. Status keamanan akan dikembalikan pada field security_repo_status.
  • files_metadata (bool, opsional) — Apakah akan mengambil metadata untuk file di repositori (ukuran, metadata LFS, dll). Bawaan adalah False.
  • expand (list[ExpandModelProperty_T], opsional) — Daftar properti yang akan dikembalikan dalam respons. Jika digunakan, hanya properti yang ada dalam daftar tersebut yang akan dikembalikan. Parameter ini tidak dapat digunakan jika securityStatus atau files_metadata diteruskan. Nilai yang mungkin adalah "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", dan "resourceGroup".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

huggingface_hub.hf_api.ModelInfo

Informasi repositori model.

Dapatkan informasi tentang satu model tertentu di huggingface.co

Model dapat bersifat privat jika Anda meneruskan token yang dapat diterima atau sudah masuk.

Membuang kesalahan berikut:

  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.
  • RevisionNotFoundError Jika revisi yang akan diunduh tidak dapat ditemukan.

move_bucket

< >

( from_id: strto_id: strtoken: bool | str | None = None )

Parameter

  • from_id (str) — Namespace (pengguna atau organisasi) dan nama bucket yang dipisahkan oleh /. Identifikasi bucket asli (mis. "username/my-bucket").
  • to_id (str) — Namespace (pengguna atau organisasi) dan nama bucket yang dipisahkan oleh /. Identifikasi bucket akhir (mis. "username/new-bucket-name" atau "organization/my-bucket").
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Membuang

BucketNotFoundError

  • BucketNotFoundError — Jika bucket sumber tidak dapat ditemukan. Hal ini mungkin terjadi karena bucket tersebut tidak ada, atau karena bucket tersebut disetel ke private dan Anda tidak memiliki akses.

Pindahkan bucket dari “namespace1/repo_name1” ke “namespace2/repo_name2”

Perhatikan bahwa terdapat beberapa keterbatasan. Untuk informasi lebih lanjut tentang memindahkan repositori, silakan lihat https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo.

Contoh:

>>> 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

< >

( from_id: strto_id: strrepo_type: str | None = Nonetoken: str | bool | None = None )

Parameter

  • from_id (str) — Namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /. Identifikasi repository asli.
  • to_id (str) — Namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /. Identifikasi repositori akhir.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Memindahkan repositori dari namespace1/repo_name1 ke namespace2/repo_name2

Perhatikan bahwa terdapat beberapa keterbatasan. Untuk informasi lebih lanjut tentang memindahkan repositori, silakan lihat https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo.

Membuang kesalahan berikut:

  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.

paper_info

< >

( id: str ) → PaperInfo

Parameter

  • id (str, opsional) — id ArXiv dari makalah.

Mengembalikan

PaperInfo

Objek PaperInfo.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 Jika makalah tidak ada di Hub.

Dapatkan informasi untuk sebuah paper di Hub.

parse_safetensors_file_metadata

< >

( repo_id: strfilename: strrepo_type: str | None = Nonerevision: str | None = Nonetoken: bool | str | None = Nonetimeout: float | None = 10 ) → SafetensorsFileMetadata

Parameter

  • repo_id (str) — Nama pengguna atau organisasi dan nama repo yang dipisahkan oleh /.
  • filename (str) — Nama file di repo.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika file berada di dataset atau space, None atau "model" jika berada di model. Default adalah None.
  • revision (str, opsional) — Revisi git untuk mengambil file. Bisa berupa nama branch, tag, atau hash commit. Secara default menggunakan head dari branch "main".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • timeout (float, opsional, default 10) — Berapa detik yang ditunggu agar server mengirim data sebelum menyerah. Atur ke None untuk menonaktifkan timeout (tidak disarankan, karena koneksi yang macet dapat menggantung panggilan secara tak terbatas).

Mengembalikan

SafetensorsFileMetadata

informasi terkait file safetensors.

Membuang

NotASafetensorsRepoError atau SafetensorsParsingError

  • NotASafetensorsRepoError — Jika repo bukan repo safetensors, yaitu tidak memiliki file model.safetensors atau model.safetensors.index.json.
  • SafetensorsParsingError — Jika header file safetensors tidak dapat diurai dengan benar.

Parse metadata dari file safetensors di Hub.

Untuk mengurai metadata dari semua file safetensors dalam sebuah repo sekaligus, gunakan get_safetensors_metadata().

Untuk detail lebih lanjut mengenai format safetensors, lihat https://huggingface.co/docs/safetensors/index#format.

pause_inference_endpoint

< >

( name: strnamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Parameter

  • name (str) — Nama Inference Endpoint yang akan dijeda.
  • namespace (str, opsional) — Namespace tempat Inference Endpoint berada. Secara default, namespace milik pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

InferenceEndpoint

informasi tentang Inference Endpoint yang dijeda.

Jeda Endpoint Inferensi.

Inference Endpoint yang dijeda tidak akan dikenakan biaya. Endpoint ini dapat dilanjutkan kapan saja menggunakan resume_inference_endpoint(). Hal ini berbeda dengan penskalaan Inference Endpoint ke nol menggunakan scale_to_zero_inference_endpoint(), yang akan dimulai ulang secara otomatis ketika ada permintaan yang dikirim ke endpoint tersebut.

Untuk kenyamanan, Anda juga dapat menjeda Inference Endpoint menggunakan pause_inference_endpoint().

pause_space

< >

( repo_id: strtoken: bool | str | None = None ) → SpaceRuntime

Parameter

  • repo_id (str) — ID Space yang akan dijeda. Contoh: "Salesforce/BLIP2".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

SpaceRuntime

Informasi runtime tentang Space Anda, termasuk stage=PAUSED dan hardware yang diminta.

Membuang

RepositoryNotFoundError atau HfHubHTTPError atau BadRequestError

  • RepositoryNotFoundError — Jika Space Anda tidak ditemukan (error 404). Kemungkinan besar repo_id salah atau Space Anda bersifat privat tetapi Anda belum terautentikasi.
  • HfHubHTTPError — 403 Forbidden: hanya pemilik Space yang dapat menjeda Space tersebut. Jika Anda ingin mengelola Space yang bukan milik Anda, mintalah izin kepada pemiliknya dengan membuka Discussion atau duplikat Space tersebut.
  • BadRequestError — Jika Space Anda adalah Space statis. Space statis selalu berjalan dan tidak pernah ditagih. Jika Anda ingin menyembunyikan Space statis, Anda dapat mengaturnya menjadi privat.

Jeda Space Anda.

Space yang dijeda akan berhenti dieksekusi hingga diaktifkan kembali secara manual oleh pemiliknya. Ini berbeda dari status tidur yang dialami Space gratis setelah 48 jam tidak aktif. Waktu jeda tidak ditagihkan ke akun Anda, terlepas dari perangkat keras yang Anda pilih. Untuk mengaktifkan kembali Space Anda, gunakan restart_space() dan buka halaman pengaturan Space Anda.

Untuk detail lebih lanjut, silakan kunjungi dokumentasi.

permanently_delete_lfs_files

< >

( repo_id: strlfs_files: Iterable[LFSFileInfo]rewrite_history: bool = Truerepo_type: str | None = Nonetoken: bool | str | None = None )

Parameter

  • repo_id (str) — Repositori tempat Anda mendaftar file LFS.
  • lfs_files (Iterable[LFSFileInfo]) — Iterable dari item LFSFileInfo untuk dihapus permanen dari repo. Gunakan list_lfs_files() untuk mendaftar semua file LFS dari sebuah repo.
  • rewrite_history (bool, opsional, default True) — Apakah akan menulis ulang riwayat repositori untuk menghapus penunjuk file yang merujuk ke file LFS yang dihapus (disarankan).
  • repo_type (str, opsional) — Jenis repositori. Atur ke "dataset" atau "space" jika mendaftar dari dataset atau space, None atau "model" jika mendaftar dari model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Hapus file LFS secara permanen dari repositori di Hub.

Ini adalah tindakan permanen yang akan memengaruhi semua commit yang merujuk pada file yang dihapus dan dapat merusak repositori Anda. Ini adalah operasi yang tidak dapat dibatalkan. Gunakan hanya jika Anda tahu apa yang Anda lakukan.

Contoh:

>>> 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

< >

( repo_id: stradditions: Iterable[CommitOperationAdd]token: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecreate_pr: bool | None = Nonenum_threads: int = 5free_memory: bool = Truegitignore_content: str | None = None )

Parameter

  • repo_id (str) — Repositori tempat Anda akan meng-commit file, misalnya: "username/custom_transformers".
  • additions (Iterable dari CommitOperationAdd) — Daftar file yang akan diunggah. Peringatan: objek dalam daftar ini akan dimutasi untuk menyertakan informasi yang berkaitan dengan pengunggahan. Jangan gunakan objek yang sama untuk beberapa commit.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • repo_type (str, opsional) — Jenis repositori yang akan diunggah (mis. "model" -default-, "dataset", "space" atau "kernel").
  • revision (str, opsional) — Revisi git untuk di-commit. Secara default menggunakan head dari cabang "main".
  • create_pr (boolean, opsional) — Apakah Anda berencana membuat Pull Request dengan commit tersebut. Defaultnya adalah False.
  • num_threads (int, opsional) — Jumlah thread konkuren untuk mengunggah file. Defaultnya 5. Mengaturnya ke 2 berarti maksimal 2 file akan diunggah secara bersamaan.
  • free_memory (bool, opsional, default True) — Jika True, atribut path_or_fileobj dari setiap CommitOperationAdd akan diganti dengan objek bytes kosong setelah diunggah untuk menghemat memori. Atur ke False jika Anda perlu menggunakan ulang objek operasi di luar panggilan create_commit() berikutnya.
  • gitignore_content (str, opsional) — Isi dari file .gitignore untuk mengetahui file mana yang harus diabaikan. Urutan prioritasnya adalah pertama memeriksa apakah gitignore_content diberikan, kemudian memeriksa apakah file .gitignore hadir dalam daftar file yang akan di-commit, dan terakhir menggunakan file .gitignore yang sudah di-host di Hub (jika ada).

Unggah file LFS ke S3 sebelum commit untuk persiapan commit di masa depan.

Metode ini berguna jika Anda menghasilkan file untuk diunggah secara langsung dan tidak ingin menyimpannya di memori sebelum mengunggah semuanya sekaligus.

Ini adalah metode untuk pengguna tingkat lanjut. Anda tidak perlu memanggilnya secara langsung untuk membuat commit biasa. Gunakan create_commit() secara langsung sebagai gantinya.

Operasi commit akan dimutasi selama proses. Secara khusus, path_or_fileobj yang terlampir akan dihapus setelah unggahan untuk menghemat memori (dan diganti dengan objek bytes kosong). Jangan gunakan ulang objek yang sama kecuali untuk melewatkan mereka ke create_commit(). Jika Anda tidak ingin menghapus konten yang terlampir dari objek operasi commit, lewati free_memory=False.

Contoh:

>>> 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")

baca_paper

< >

( id: str ) → str

Parameter

  • id (str) — id ArXiv dari makalah.

Mengembalikan

str

Konten halaman paper sebagai markdown.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 404 Jika makalah tidak ada di Hub.

Dapatkan konten markdown dari halaman paper di Hub.

menolak_permintaan_akses

< >

( repo_id: struser: str | None = Nonerequest_id: str | None = Nonerepo_type: str | None = Nonerejection_reason: str | Nonetoken: bool | str | None = None )

Parameter

  • repo_id (str) — ID repo untuk menolak permintaan akses.
  • user (str, opsional) — Nama pengguna dari pengguna yang permintaan aksesnya harus ditolak. Tepat satu dari user atau request_id harus disediakan.
  • request_id (str, opsional) — ID dari permintaan akses yang akan ditolak (lihat AccessRequest). Wajib diisi ketika repo dikonfigurasi untuk tidak membagikan nama pengguna peminta. Tepat satu dari user atau request_id harus disediakan.
  • repo_type (str, opsional) — Jenis repo untuk menolak permintaan akses. Harus salah satu dari model, dataset atau space. Bawaan adalah model.
  • rejection_reason (str, opsional) — Alasan penolakan opsional yang akan terlihat oleh pengguna (maks. 200 karakter).
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 400 jika repo tidak gated.
  • HfHubHTTPError — HTTP 403 jika Anda hanya memiliki akses baca-saja ke repo. Hal ini dapat terjadi jika Anda tidak memiliki peran write atau admin di organisasi tempat repo tersebut berada, atau jika Anda menggunakan token read.
  • HfHubHTTPError — HTTP 404 jika pengguna tidak ada di Hub.
  • HfHubHTTPError — HTTP 404 jika permintaan akses pengguna tidak dapat ditemukan.
  • HfHubHTTPError — HTTP 404 jika permintaan akses pengguna sudah ada dalam daftar ditolak.

Tolak permintaan akses dari pengguna untuk repo bergerbang tertentu.

Permintaan yang ditolak akan masuk ke daftar ditolak. Pengguna tidak dapat mengunduh file apa pun dari repo. Permintaan yang ditolak dapat diterima atau dibatalkan kapan saja menggunakan accept_access_request() dan cancel_access_request(). Permintaan yang dibatalkan akan kembali ke daftar pending, sedangkan permintaan yang diterima akan masuk ke daftar diterima.

Untuk informasi lebih lanjut tentang repositori bergerbang, lihat https://huggingface.co/docs/hub/models-gated.

rename_discussion

< >

( repo_id: strdiscussion_num: intnew_title: strtoken: bool | str | None = Nonerepo_type: str | None = None ) → DiscussionTitleChange

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • discussion_num (int) — Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif.
  • new_title (str) — Judul baru untuk diskusi
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunggah ke dataset atau space, None atau "model" jika mengunggah ke model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

DiscussionTitleChange

peristiwa perubahan judul

Mengubah nama Diskusi.

Contoh:

>>> 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', ...)

Membuang kesalahan berikut:

  • HTTPError jika API HuggingFace mengembalikan error
  • ValueError jika nilai beberapa parameter tidak valid
  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.

repo_exists

< >

( repo_id: strrepo_type: str | None = Nonetoken: str | bool | None = None )

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengambil info repositori dari dataset atau space, None atau "model" jika mengambil info repositori dari model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Memeriksa apakah sebuah repositori ada di Hugging Face Hub.

Contoh:

>>> from huggingface_hub import repo_exists
>>> repo_exists("google/gemma-7b")
True
>>> repo_exists("google/not-a-repo")
False

repo_info

< >

( repo_id: strrevision: str | None = Nonerepo_type: str | None = Nonetimeout: float | None = Nonefiles_metadata: bool = Falseexpand: ExpandModelProperty_T | ExpandDatasetProperty_T | ExpandSpaceProperty_T | None = Nonetoken: bool | str | None = None ) → Union[SpaceInfo, DatasetInfo, ModelInfo]

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • revision (str, opsional) — Revisi repositori yang menjadi sumber informasi.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengambil info repositori dari dataset atau space, None atau "model" jika mengambil info repositori dari model. Default adalah None.
  • timeout (float, opsional) — Apakah akan mengatur batas waktu (timeout) untuk permintaan ke Hub.
  • expand (ExpandModelProperty_T atau ExpandDatasetProperty_T atau ExpandSpaceProperty_T, opsional) — Daftar properti yang akan dikembalikan dalam respons. Jika digunakan, hanya properti yang ada dalam daftar tersebut yang akan dikembalikan. Parameter ini tidak dapat digunakan jika files_metadata diteruskan. Untuk daftar lengkap properti yang tersedia, lihat model_info(), dataset_info() atau space_info().
  • files_metadata (bool, opsional) — Apakah akan mengambil metadata untuk file di repositori (ukuran, metadata LFS, dll). Bawaan adalah False.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Union[SpaceInfo, DatasetInfo, ModelInfo]

Informasi repositori, sebagai objek huggingface_hub.hf_api.DatasetInfo, huggingface_hub.hf_api.ModelInfo atau huggingface_hub.hf_api.SpaceInfo.

Dapatkan objek info untuk repositori tertentu dari tipe tertentu.

Membuang kesalahan berikut:

  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.
  • RevisionNotFoundError Jika revisi yang akan diunduh tidak dapat ditemukan.

request_space_hardware

< >

( repo_id: strhardware: SpaceHardwaretoken: bool | str | None = Nonesleep_time: int | None = None ) → SpaceRuntime

Parameter

  • repo_id (str) — ID repo yang akan diperbarui. Contoh: "bigcode/in-the-stack".
  • hardware (str atau SpaceHardware) — Hardware tempat Space dijalankan. Contoh: "t4-medium".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • sleep_time (int, opsional) — Jumlah detik tidak aktif yang harus ditunggu sebelum sebuah Space dimatikan. Atur ke -1 jika Anda tidak ingin Space Anda tidur (perilaku bawaan untuk perangkat keras yang ditingkatkan). Untuk perangkat keras gratis, Anda tidak dapat mengatur waktu tidur (nilai tetap pada 48 jam tidak aktif). Lihat https://huggingface.co/docs/hub/spaces-gpus#sleep-time untuk detail lebih lanjut.

Mengembalikan

SpaceRuntime

Informasi runtime tentang sebuah Space, termasuk tahap dan perangkat keras Space.

Minta perangkat keras baru untuk sebuah Space.

Anda juga dapat meminta perangkat keras secara langsung saat membuat repo Space! Lihat create_repo() untuk detailnya.

rerun_job

< >

( job_id: strnamespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo

Parameter

  • job_id (str) — ID dari Job yang akan dijalankan ulang.
  • namespace (str, opsional) — Namespace dari Job. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna. Bawaan ke token yang disimpan secara lokal.

Mengembalikan

JobInfo

Job yang baru dimulai.

Jalankan Job baru menggunakan spesifikasi Job yang ada, termasuk pengaturan retry dan resource-nya.

resolve_revision

< >

( repo_id: strrepo_type: str | None = Nonerevision: str | None = Nonecache_dir: str | Path | None = Nonelocal_files_only: bool = Falsetoken: bool | str | None = None ) → ResolvedRevision

Parameter

  • repo_id (str) — Nama pengguna atau organisasi dan nama repo yang dipisahkan oleh /.
  • repo_type (str, opsional) — Atur ke "dataset", "space" atau "kernel" jika repo adalah repo dataset, space, atau kernel, None atau "model" jika itu adalah model. Default adalah None.
  • revision (str, opsional) — Revisi yang akan dipecahkan. Bisa berupa nama branch, tag, PR ref, atau hash commit. Secara default menggunakan branch default. Jika ResolvedRevision diberikan, nilai tersebut dikembalikan apa adanya - kecuali jika dipecahkan terhadap repo lain, di mana revisi yang awalnya diminta akan dipecahkan kembali.
  • cache_dir (str, Path, opsional) — Path ke folder tempat file cache disimpan. Bawaan ke nilai HF_HUB_CACHE.
  • local_files_only (bool, opsional, default False) — Jika True, resolusi revisi hanya dilakukan dari cache lokal, tanpa menghubungi Hub.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

ResolvedRevision

Subkelas str yang menyimpan baik revisi yang diminta maupun hash commit yang dihasilkannya.

Membuang

RevisionResolutionError atau RevisionNotFoundError atau RepositoryNotFoundError

  • RevisionResolutionError — Jika revisi tidak dapat diselesaikan: Hub tidak dapat dihubungi dan tidak ada yang di-cache secara lokal.
  • RevisionNotFoundError — Jika revisi tidak ada di Hub.
  • RepositoryNotFoundError — Jika repositori tidak dapat ditemukan. Hal ini mungkin terjadi karena repositori tidak ada, atau karena repositori disetel ke private dan Anda tidak memiliki akses.

Selesaikan revisi (cabang, tag, ref PR) menjadi hash commit.

Ini ditujukan untuk pustaka yang mengunduh dan memuat beberapa komponen dari sebuah repo secara terpisah (config, weights, tokenizer, …). Menyelesaikan revisi sekali dan meneruskan ResolvedRevision yang dikembalikan menjamin bahwa setiap panggilan berikutnya menargetkan commit yang persis sama, bahkan jika repo diperbarui di sela-sela waktu. Hal ini juga menghemat panggilan HTTP, karena unduhan yang dilakukan dengan hash commit dapat disajikan dari cache lokal tanpa menghubungi Hub.

Pemetaan revision -> commit hash disimpan di cache pada disk (di folder refs/ dari cache) dengan basis upaya terbaik. Jika Hub tidak dapat dihubungi kemudian (mode offline, error koneksi, timeout, downtime Hub, …), nilai yang di-cache digunakan sebagai cadangan.

Jika Anda hanya perlu mengunduh snapshot repo lengkap, satu panggilan snapshot_download() sudah cukup dan sudah melakukan hal yang tepat. resolve_revision hanya berguna saat mengunduh file secara terpisah.

Contoh:

>>> 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

< >

( repo_id: strtoken: bool | str | None = Nonefactory_reboot: bool = False ) → SpaceRuntime

Parameter

  • repo_id (str) — ID Space yang akan di-restart. Contoh: "Salesforce/BLIP2".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • factory_reboot (bool, opsional) — Jika True, Space akan dibangun ulang dari awal tanpa meng-cache persyaratan apa pun.

Mengembalikan

SpaceRuntime

Informasi runtime tentang Space Anda.

Membuang

RepositoryNotFoundError atau HfHubHTTPError atau BadRequestError

  • RepositoryNotFoundError — Jika Space Anda tidak ditemukan (error 404). Kemungkinan besar repo_id salah atau Space Anda bersifat privat tetapi Anda belum terautentikasi.
  • HfHubHTTPError — 403 Forbidden: hanya pemilik Space yang dapat memulai ulang Space tersebut. Jika Anda ingin memulai ulang Space yang bukan milik Anda, mintalah pemiliknya dengan membuka Discussion atau duplikat Space tersebut.
  • BadRequestError — Jika Space Anda adalah Space statis. Space statis selalu berjalan dan tidak pernah ditagih. Jika Anda ingin menyembunyikan Space statis, Anda dapat mengaturnya menjadi privat.

Mulai ulang Space Anda.

Ini adalah satu-satunya cara untuk memulai ulang Space secara programatik jika Anda telah menjeda Space tersebut (lihat pause_space()). Anda harus menjadi pemilik Space untuk dapat memulai ulangnya. Jika Anda menggunakan perangkat keras yang ditingkatkan, akun Anda akan ditagih segera setelah Space dimulai ulang. Anda dapat memicu pembaruan ulang apa pun status saat ini dari sebuah Space.

Untuk detail lebih lanjut, silakan kunjungi dokumentasi.

resume_inference_endpoint

< >

( name: strnamespace: str | None = Nonerunning_ok: bool = Truetoken: bool | str | None = None ) → InferenceEndpoint

Parameter

  • name (str) — Nama Inference Endpoint yang akan dilanjutkan.
  • namespace (str, opsional) — Namespace tempat Inference Endpoint berada. Secara default, namespace milik pengguna saat ini.
  • running_ok (bool, opsional) — Jika True, metode tidak akan melempar error jika Inference Endpoint sudah berjalan. Defaultnya adalah True.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

InferenceEndpoint

informasi tentang Inference Endpoint yang dilanjutkan.

Lanjutkan Endpoint Inferensi.

Untuk kenyamanan, Anda juga dapat melanjutkan Inference Endpoint menggunakan InferenceEndpoint.resume().

resume_scheduled_job

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parameter

  • scheduled_job_id (str) — ID dari Job terjadwal.
  • namespace (str, opsional) — Namespace tempat Job terjadwal berada. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Lanjutkan (hentikan jeda) Job komputasi terjadwal di infrastruktur Hugging Face.

revision_exists

< >

( repo_id: strrevision: strrepo_type: str | None = Nonetoken: str | bool | None = None )

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • revision (str) — Revisi repositori yang akan diperiksa.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengambil info repositori dari dataset atau space, None atau "model" jika mengambil info repositori dari model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Memeriksa apakah revisi tertentu ada di repositori pada Hugging Face Hub.

Contoh:

>>> 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

< >

( fn: Callable[..., R]*args**kwargs ) → Future

Parameter

  • fn (Callable) — Metode yang akan dijalankan di latar belakang.
  • *args, **kwargs — Argumen yang digunakan untuk memanggil metode.

Mengembalikan

Future

sebuah instance Future untuk mendapatkan hasil dari tugas tersebut.

Jalankan metode di latar belakang dan kembalikan instance Future.

Tujuan utamanya adalah menjalankan metode tanpa memblokir thread utama (misalnya untuk mendorong data selama pelatihan). Tugas latar belakang diantrekan untuk menjaga urutan tetapi tidak dijalankan secara paralel. Jika Anda perlu mempercepat skrip Anda dengan memparalelkan banyak panggilan ke API, Anda harus mengatur dan menggunakan ThreadPoolExecutor Anda sendiri.

Catatan: Metode yang paling sering digunakan seperti upload_file(), upload_folder() dan create_commit() memiliki argumen run_as_future: bool untuk memanggilnya secara langsung di latar belakang. Ini setara dengan memanggil api.run_as_future(...) pada metode tersebut namun lebih ringkas.

Contoh:

>>> 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

< >

( image: strcommand: list[str]env: dict[str, Any] | None = Nonesecrets: dict[str, Any] | None = Noneflavor: JobHardware | str | None = Nonetimeout: int | float | str | None = Noneattempts: int | None = Nonename: str | None = Nonelabels: dict[str, str] | None = Nonevolumes: list[Volume] | None = Noneexpose: list[int] | None = Noneexpose_public: list[int] | None = Nonessh: bool = Falsenetwork_group: str | None = Nonenetwork_aliases: list[str] | None = Noneresource_group_id: str | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None )

Parameter

  • image (str) — Gambar Docker yang akan digunakan. Contoh: "ubuntu", "python:3.12", "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel". Contoh dengan gambar dari Space: "hf.co/spaces/lhoestq/duckdb".
  • command (list[str]) — Perintah yang akan dijalankan. Contoh: ["echo", "hello"].
  • env (dict[str, Any], opsional) — Menentukan variabel lingkungan untuk Job.
  • secrets (dict[str, Any], opsional) — Menentukan variabel lingkungan rahasia untuk Job.
  • flavor (str, opsional) — Flavor untuk perangkat keras. Lihat JobHardware untuk nilai yang mungkin. Nilai default adalah "cpu-basic".
  • timeout (Union[int, float, str], opsional) — Durasi maksimum untuk Job: int dengan s (detik, default), m (menit), h (jam) atau d (hari). Contoh: 300 atau "5m" untuk 5 menit.
  • attempts (int, opsional) — Jumlah maksimum percobaan, termasuk eksekusi awal. Nilainya secara default adalah 1. Sebagai contoh, 3 akan mengulang Job yang gagal hingga 2 kali.
  • name (str, opsional) — Nama untuk Job. Disimpan sebagai label name. Tidak dapat diteruskan bersamaan dengan kunci name di labels. Nama tidak harus unik. Secara default, nama diturunkan dari image dan command (dengan akhiran hash pendek).
  • labels (dict[str, str], opsional) — Label yang akan dilampirkan ke job (pasangan kunci-nilai).
  • volumes (list[Volume], opsional) — Hugging Face Buckets atau Repos yang akan dipasang sebagai volume di dalam kontainer job. Setiap volume adalah Volume dengan type ("bucket", "model", "dataset", atau "space"), source (mis. "username/my-bucket"), dan mount_path (mis. "/data").
  • expose (list[int], opsional) — Port container yang akan diekspos melalui proxy jobs. Setiap port yang terdaftar dapat diakses di domain jobs publik (mis. https://<job_id>--8000.hf.jobs). Akses selalu memerlukan token HF dengan izin baca pada namespace job tersebut. Gunakan expose_public untuk akses tanpa autentikasi.
  • expose_public (list[int], opsional) — Port yang akan diekspos melalui proxy Jobs tanpa autentikasi. Port ini tidak perlu dicantumkan dalam expose.
  • ssh (bool, opsional) — Jika True, container dari job tersebut dapat dijangkau melalui SSH di URL yang diberikan oleh job.status.ssh_url (misalnya ssh <job_id>@ssh.hf.jobs, atau hf jobs ssh <job_id> dari CLI). Koneksi memerlukan akses tulis ke namespace job dan kunci publik SSH yang terdaftar di Hub (https://huggingface.co/settings/keys). Nilai default adalah False.
  • network_group (str, opsional) — Nama grup jaringan untuk bergabung. Pekerjaan dalam namespace dan grup sumber daya yang sama yang berbagi grup akan ditempatkan bersama dan dapat saling menjangkau di setiap port. Di dalam setiap anggota, HF_NETWORK_GROUP_HOSTNAME dipecahkan ke setiap anggota grup. Huruf kecil alfanumerik dan tanda hubung, maksimal 46 karakter.
  • network_aliases (list[str], opsional) — Alias yang diklaim oleh job ini dalam grup jaringannya. Anggota dapat menjangkau job yang mengklaim alias di ${HF_NETWORK_GROUP_PREFIX}<alias>. Beberapa job dapat mengklaim alias yang sama. Huruf kecil alfanumerik dan tanda hubung, maksimal 34 karakter, unik dalam job. Memerlukan network_group.
  • resource_group_id (str, opsional) — ID dari resource group tempat Job akan dibuat. Digunakan untuk mengontrol akses ke sumber daya dalam sebuah organisasi dan untuk fitur atribusi biaya/batas pengeluaran. Jika tidak disediakan, Job akan dibuat di luar resource group mana pun.
  • namespace (str, opsional) — Namespace tempat Job akan dibuat. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Jalankan compute Jobs pada infrastruktur Hugging Face.

Contoh:

Jalankan Job pertama Anda:

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

Jalankan Tugas GPU:

>>> 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")

Jalankan Job dengan volume:

>>> 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

< >

( script: strscript_args: list[str] | None = Nonedependencies: list[str] | None = Nonepython: str | None = Noneimage: str | None = Noneenv: dict[str, Any] | None = Nonesecrets: dict[str, Any] | None = Noneflavor: JobHardware | str | None = Nonetimeout: int | float | str | None = Noneattempts: int | None = Nonename: str | None = Nonelabels: dict[str, str] | None = Nonevolumes: list[Volume] | None = Noneexpose: list[int] | None = Noneexpose_public: list[int] | None = Nonessh: bool = Falsenetwork_group: str | None = Nonenetwork_aliases: list[str] | None = Noneresource_group_id: str | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None )

Parameter

  • script (str) — Path atau URL dari skrip UV, atau sebuah perintah.
  • script_args (list[str], opsional) — Argumen untuk diteruskan ke skrip atau perintah.
  • dependencies (list[str], opsional) — Dependensi yang digunakan untuk menjalankan skrip UV.
  • python (str, opsional) — Gunakan versi Python tertentu. Default adalah 3.12.
  • image (str, opsional, default “ghcr.io/astral-sh/uv —python3.12-bookworm”): Gunakan image Docker kustom dengan uv yang sudah terpasang.
  • env (dict[str, Any], opsional) — Menentukan variabel lingkungan untuk Job.
  • secrets (dict[str, Any], opsional) — Menentukan variabel lingkungan rahasia untuk Job.
  • flavor (str, opsional) — Flavor untuk perangkat keras. Lihat JobHardware untuk nilai yang mungkin. Nilai default adalah "cpu-basic".
  • timeout (Union[int, float, str], opsional) — Durasi maksimum untuk Job: int dengan s (detik, default), m (menit), h (jam) atau d (hari). Contoh: 300 atau "5m" untuk 5 menit.
  • attempts (int, opsional) — Jumlah maksimum percobaan, termasuk eksekusi awal. Defaultnya adalah 1.
  • name (str, opsional) — Nama untuk Job. Disimpan sebagai label name. Tidak dapat diteruskan bersamaan dengan kunci name di labels. Nama tidak harus unik. Secara default, menggunakan nama yang diturunkan dari skrip dan argumennya (dengan akhiran hash pendek).
  • labels (dict[str, str], opsional) — Label yang akan dilampirkan ke job (pasangan kunci-nilai).
  • volumes (list[Volume], opsional) — Hugging Face Buckets atau Repos yang akan dipasang sebagai volume di dalam kontainer job. Setiap volume adalah Volume dengan type ("bucket", "model", "dataset", atau "space"), source (mis. "username/my-bucket"), dan mount_path (mis. "/data").
  • expose (list[int], opsional) — Port container yang akan diekspos melalui proxy jobs. Setiap port yang terdaftar dapat diakses di domain jobs publik (mis. https://<job_id>--8000.hf.jobs). Akses selalu memerlukan token HF dengan izin baca pada namespace job tersebut. Gunakan expose_public untuk akses tanpa autentikasi.
  • expose_public (list[int], opsional) — Port yang akan diekspos melalui proxy Jobs tanpa autentikasi. Port ini tidak perlu dicantumkan dalam expose.
  • ssh (bool, opsional) — Jika True, container dari job tersebut dapat dijangkau melalui SSH di URL yang diberikan oleh job.status.ssh_url (misalnya ssh <job_id>@ssh.hf.jobs, atau hf jobs ssh <job_id> dari CLI). Koneksi memerlukan akses tulis ke namespace job dan kunci publik SSH yang terdaftar di Hub (https://huggingface.co/settings/keys). Nilai default adalah False.
  • network_group (str, opsional) — Nama grup jaringan untuk bergabung. Pekerjaan dalam namespace dan grup sumber daya yang sama yang berbagi grup akan ditempatkan bersama dan dapat saling menjangkau di setiap port. Di dalam setiap anggota, HF_NETWORK_GROUP_HOSTNAME dipecahkan ke setiap anggota grup. Huruf kecil alfanumerik dan tanda hubung, maksimal 46 karakter.
  • network_aliases (list[str], opsional) — Alias yang diklaim oleh job ini dalam grup jaringannya. Anggota dapat menjangkau job yang mengklaim alias di ${HF_NETWORK_GROUP_PREFIX}<alias>. Beberapa job dapat mengklaim alias yang sama. Huruf kecil alfanumerik dan tanda hubung, maksimal 34 karakter, unik dalam job. Memerlukan network_group.
  • resource_group_id (str, opsional) — ID dari resource group tempat Job akan dibuat. Digunakan untuk mengontrol akses ke sumber daya dalam sebuah organisasi dan untuk fitur atribusi biaya/batas pengeluaran. Jika tidak disediakan, Job akan dibuat di luar resource group mana pun.
  • namespace (str, opsional) — Namespace tempat Job akan dibuat. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Jalankan tugas skrip UV pada infrastruktur Hugging Face.

Berbeda dengan hf jobs uv run, metode ini mengabaikan tabel opsional [tool.hf-jobs] yang dapat dibawa oleh skrip UV di header PEP 723-nya (lihat panduan Jobs): konfigurasi peluncuran harus diberikan secara eksplisit di sini.

Contoh:

Jalankan skrip dari URL:

>>> 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")

Jalankan skrip lokal:

>>> 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")

Jalankan perintah:

>>> 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")

Pasang volume, misalnya untuk menyimpan checkpoint model selama pelatihan:

>>> 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

< >

( name: strnamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Parameter

  • name (str) — Nama Inference Endpoint yang akan diskalakan menjadi nol.
  • namespace (str, opsional) — Namespace tempat Inference Endpoint berada. Secara default, namespace milik pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

InferenceEndpoint

informasi tentang Inference Endpoint yang diskalakan ke nol.

Skalakan Endpoint Inferensi ke nol.

Inference Endpoint yang diskalakan ke nol tidak akan dikenakan biaya. Endpoint ini akan dilanjutkan pada permintaan berikutnya, dengan penundaan cold start. Hal ini berbeda dengan menjeda Inference Endpoint menggunakan pause_inference_endpoint(), yang akan memerlukan pengaktifan manual menggunakan resume_inference_endpoint().

Untuk kenyamanan, Anda juga dapat menskalakan Inference Endpoint menjadi nol menggunakan InferenceEndpoint.scale_to_zero().

search_spaces

< >

( query: strfilter: str | Iterable[str] | None = Nonesdk: str | list[str] | None = Noneinclude_non_running: bool = Falsetoken: bool | str | None = None ) → Iterable[SpaceSearchResult]

Parameter

  • query (str) — String kueri pencarian.
  • filter (str atau Iterable[str], opsional) — Tag string atau daftar tag untuk difilter.
  • sdk (str atau list[str], opsional) — Saring berdasarkan SDK (mis. "gradio", "docker", "static").
  • include_non_running (bool, opsional) — Apakah akan menyertakan Spaces yang tidak berjalan dalam hasil. Defaultnya adalah False.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

Iterable[SpaceSearchResult]

iterable dari objek SpaceSearchResult.

Ruang Pencarian di Hub menggunakan pencarian semantik.

Endpoint ini menggunakan pencarian semantik (berbasis embedding) untuk kueri multi-kata dan pencarian teks penuh untuk kueri satu kata.

Contoh:

>>> 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

< >

( repo_id: strsleep_time: inttoken: bool | str | None = None ) → SpaceRuntime

Parameter

  • repo_id (str) — ID repo yang akan diperbarui. Contoh: "bigcode/in-the-stack".
  • sleep_time (int, opsional) — Jumlah detik tidak aktif yang harus ditunggu sebelum sebuah Space dimatikan. Atur ke -1 jika Anda tidak ingin Space Anda dijeda (perilaku bawaan untuk perangkat keras yang ditingkatkan). Untuk perangkat keras gratis, Anda tidak dapat mengatur waktu tidur (nilai tetap pada 48 jam tidak aktif). Lihat https://huggingface.co/docs/hub/spaces-gpus#sleep-time untuk detail lebih lanjut.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

SpaceRuntime

Informasi runtime tentang sebuah Space, termasuk tahap dan perangkat keras Space.

Atur waktu tidur kustom untuk Space yang berjalan di perangkat keras yang ditingkatkan.

Space Anda akan masuk ke mode tidur setelah X detik tidak aktif. Anda tidak akan dikenakan biaya saat Space Anda berada dalam mode “sleep”. Jika pengunjung baru mengakses Space Anda, Space tersebut akan “dibangunkan”. Hanya perangkat keras yang sudah di-upgrade yang dapat memiliki waktu tidur yang dapat dikonfigurasi. Untuk mengetahui lebih lanjut tentang tahap tidur, silakan merujuk ke https://huggingface.co/docs/hub/spaces-gpus#sleep-time.

Anda juga dapat mengatur waktu tidur kustom saat meminta perangkat keras dengan request_space_hardware().

set_space_volumes

< >

( repo_id: strvolumes: list[Volume]token: bool | str | None = None )

Parameter

  • repo_id (str) — ID Space yang akan diperbarui. Contoh: "username/my-space".
  • volumes (list[Volume]) — Daftar objek Volume untuk di-mount. Setiap volume memiliki type ("bucket", "model", "dataset", atau "space"), source (ID repo atau bucket), mount_path (path di dalam container), serta field opsional revision, read_only, dan path.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Membuang

BadRequestError

  • BadRequestError — Jika Space tersebut adalah Space statis (volume tidak didukung pada Space statis).

Setel volume untuk sebuah Space.

Mengatur (atau mengganti) daftar volume yang dipasang di Space. Setiap volume memberikan akses ke sumber daya Hub (model, dataset, atau storage bucket) untuk container Space.

Contoh:

>>> 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

< >

( repo_id: strrepo_type: str | None = Nonerevision: str | None = Nonecache_dir: str | Path | None = Nonelocal_dir: str | Path | None = Noneetag_timeout: float = 10force_download: bool = Falsetoken: bool | str | None = Nonelocal_files_only: bool = Falseallow_patterns: list[str] | str | None = Noneignore_patterns: list[str] | str | None = Nonemax_workers: int = 8tqdm_class: type[base_tqdm] | None = Nonedry_run: bool = False ) → str or list of DryRunFileInfo

Parameter

  • repo_id (str) — Nama pengguna atau organisasi dan nama repo yang dipisahkan oleh /.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mengunduh dari dataset atau space, None atau "model" jika mengunduh dari model. Default adalah None.
  • revision (str, opsional) — ID revisi Git opsional yang dapat berupa nama cabang, tag, atau hash commit.
  • cache_dir (str, Path, opsional) — Path ke folder tempat file cache disimpan.
  • local_dir (str atau Path, opsional) — Jika disediakan, file yang diunduh akan ditempatkan di bawah direktori ini.
  • etag_timeout (float, opsional, default 10) — Saat mengambil ETag, berapa detik menunggu server mengirim data sebelum menyerah, yang diteruskan ke httpx2.request.
  • force_download (bool, opsional, default False) — Apakah file harus diunduh meskipun sudah ada di cache lokal.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • local_files_only (bool, opsional, defaultnya False) — Jika True, hindari mengunduh file dan kembalikan path ke file cache lokal jika ada.
  • allow_patterns (list[str] atau str, opsional) — Jika disediakan, hanya file yang cocok dengan setidaknya satu pola yang akan diunduh.
  • ignore_patterns (list[str] atau str, opsional) — Jika diberikan, file yang cocok dengan salah satu pola tidak diunduh.
  • max_workers (int, opsional) — Jumlah thread konkuren untuk mengunduh file (1 thread = 1 unduhan file). Nilai defaultnya adalah 8.
  • tqdm_class (tqdm, opsional) — Jika diberikan, menimpa perilaku bawaan untuk progress bar. Argumen yang dilewatkan harus mewarisi dari tqdm.auto.tqdm atau setidaknya meniru perilakunya. Perhatikan bahwa tqdm_class tidak dilewatkan ke setiap unduhan individual. Bawaannya adalah progress bar HF khusus yang dapat dinonaktifkan dengan mengatur variabel lingkungan HF_HUB_DISABLE_PROGRESS_BARS.
  • dry_run (bool, opsional, defaultnya False) — Jika True, lakukan dry run tanpa benar-benar mengunduh file. Mengembalikan daftar objek DryRunFileInfo yang berisi informasi tentang apa yang akan diunduh.

Mengembalikan

str atau list dari DryRunFileInfo

  • Jika dry_run=False: Jalur folder dari snapshot repo.
  • Jika dry_run=True: Daftar objek DryRunFileInfo yang berisi informasi unduhan.

Membuang

RepositoryNotFoundError atau RevisionNotFoundError atau EnvironmentError atau OSError atau ValueError

  • RepositoryNotFoundError — Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.
  • RevisionNotFoundError — Jika revisi yang akan diunduh tidak dapat ditemukan.
  • EnvironmentError — Jika token=True dan token tidak dapat ditemukan.
  • OSError — jika ETag tidak dapat ditentukan.
  • ValueError — jika nilai beberapa parameter tidak valid.

Unduh file repo.

Unduh seluruh snapshot file dari repositori pada revisi yang ditentukan. Ini berguna ketika Anda menginginkan semua file dari sebuah repositori, karena Anda tidak tahu file mana yang akan Anda butuhkan secara a priori. Semua file berada di dalam folder agar nama file aslinya tetap relatif terhadap folder tersebut. Anda juga dapat memfilter file mana yang akan diunduh menggunakan allow_patterns dan ignore_patterns.

Jika local_dir disediakan, struktur file dari repo akan direplikasi di lokasi ini. Saat menggunakan opsi ini, cache_dir tidak akan digunakan dan folder .cache/huggingface/ akan dibuat di akar local_dir untuk menyimpan beberapa metadata terkait file yang diunduh. Meskipun mekanisme ini tidak sekuat sistem cache utama, ini dioptimalkan untuk menarik versi terbaru dari repositori secara rutin.

Alternatifnya adalah meng-clone repo, tetapi ini memerlukan git dan git-lfs yang terinstal dan dikonfigurasi dengan benar. Selain itu, tidak mungkin memfilter file mana yang akan diunduh saat meng-clone repositori menggunakan git.

space_info

< >

( repo_id: strrevision: str | None = Nonetimeout: float | None = Nonefiles_metadata: bool = Falseexpand: list[ExpandSpaceProperty_T] | None = Nonetoken: bool | str | None = None ) → SpaceInfo

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • revision (str, opsional) — Revisi dari repositori space yang digunakan untuk mengambil informasi.
  • timeout (float, opsional) — Apakah akan mengatur batas waktu (timeout) untuk permintaan ke Hub.
  • files_metadata (bool, opsional) — Apakah akan mengambil metadata untuk file di repositori (ukuran, metadata LFS, dll). Bawaan adalah False.
  • expand (list[ExpandSpaceProperty_T], opsional) — Daftar properti yang akan dikembalikan dalam respons. Jika digunakan, hanya properti yang ada dalam daftar tersebut yang akan dikembalikan. Parameter ini tidak dapat digunakan jika full diteruskan. Nilai yang mungkin adalah "author", "cardData", "createdAt", "datasets", "disabled", "lastModified", "likes", "models", "private", "region", "runtime", "sdk", "siblings", "sha", "subdomain", "tags", "trendingScore", "usedStorage", dan "resourceGroup".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

SpaceInfo

Informasi repositori space.

Dapatkan informasi tentang satu Space tertentu di huggingface.co.

Space dapat bersifat privat jika Anda meneruskan token yang dapat diterima.

Membuang kesalahan berikut:

  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.
  • RevisionNotFoundError Jika revisi yang akan diunduh tidak dapat ditemukan.

super_squash_history

< >

( repo_id: strbranch: str | None = Nonecommit_message: str | None = Nonerepo_type: str | None = Nonetoken: str | bool | None = None )

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • branch (str, opsional) — Cabang yang akan di-squash. Secara default, menggunakan head dari cabang "main".
  • commit_message (str, opsional) — Pesan commit yang akan digunakan untuk commit yang telah digabungkan (squashed).
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika mendaftar commit dari dataset atau Space, None atau "model" jika mendaftar dari model. Default adalah None.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Membuang

RepositoryNotFoundError atau RevisionNotFoundError atau BadRequestError

  • RepositoryNotFoundError — Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada.
  • RevisionNotFoundError — Jika cabang yang akan di-squash tidak dapat ditemukan.
  • BadRequestError — Jika referensi untuk branch tidak valid. Anda tidak dapat melakukan squash history pada tags.

Ratakan riwayat commit pada cabang untuk repositori di Hub.

Mengecilkan riwayat repo berguna ketika Anda tahu akan membuat ratusan commit dan tidak ingin riwayat menjadi berantakan. Commit hanya bisa dikecilkan dari ujung (head) sebuah branch.

Setelah di-squash, riwayat commit tidak dapat diambil kembali. Ini adalah operasi yang tidak dapat dibatalkan.

Setelah riwayat sebuah cabang di-squash, tidak mungkin lagi menggabungkannya kembali ke cabang lain karena riwayat keduanya telah bercabang.

Contoh:

>>> 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

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None )

Parameter

  • scheduled_job_id (str) — ID dari Job terjadwal.
  • namespace (str, opsional) — Namespace tempat Job terjadwal berada. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Suspend (jeda) Job komputasi terjadwal di infrastruktur Hugging Face.

sync_bucket

< >

( source: str | None = Nonedest: str | None = Nonedelete: bool = Falseignore_times: bool = Falseignore_sizes: bool = Falseexisting: bool = Falseignore_existing: bool = Falseinclude: list[str] | None = Noneexclude: list[str] | None = Nonefilter_from: str | None = Noneplan: str | None = Noneapply: str | None = Nonedry_run: bool = Falseverbose: bool = Falsequiet: bool = Falsetoken: bool | str | None = None ) → [SyncPlan]

Parameter

  • source (str, opsional) — Path sumber: direktori lokal atau hf://buckets/namespace/bucket_name(/prefix). Wajib diisi kecuali menggunakan apply.
  • dest (str, opsional) — Jalur tujuan: direktori lokal atau hf://buckets/namespace/bucket_name(/prefix). Wajib diisi kecuali menggunakan apply.
  • delete (bool, opsional, default False) — Hapus file tujuan yang tidak ada di sumber.
  • ignore_times (bool, opsional, default False) — Lewati file hanya berdasarkan ukuran, mengabaikan waktu modifikasi.
  • ignore_sizes (bool, opsional, default False) — Lewati file hanya berdasarkan waktu modifikasi, mengabaikan ukuran.
  • existing (bool, opsional, default False) — Lewati pembuatan file baru di penerima (hanya perbarui file yang sudah ada).
  • ignore_existing (bool, opsional, default False) — Lewati pembaruan file yang sudah ada di penerima (hanya buat file baru).
  • include (list[str], opsional) — Sertakan file yang cocok dengan pola (gaya fnmatch).
  • exclude (list[str], opsional) — Eksklusi file yang cocok dengan pola (gaya fnmatch).
  • filter_from (str, opsional) — Path ke file filter dengan aturan include/exclude.
  • plan (str, opsional) — Simpan rencana sinkronisasi ke file JSONL ini alih-alih mengeksekusinya.
  • apply (str, optional) — Terapkan file rencana yang sebelumnya disimpan. Jika disetel, source dan dest tidak diperlukan.
  • dry_run (bool, opsional, default False) — Cetak rencana sinkronisasi ke stdout sebagai JSONL tanpa dieksekusi.
  • verbose (bool, opsional, default False) — Tampilkan operasi per file secara detail.
  • quiet (bool, opsional, default False) — Menekan semua output dan bilah progres.
  • token (Union[bool, str, None], opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan.

Mengembalikan

[SyncPlan]

Rencana sinkronisasi yang dihitung (atau dimuat).

Sinkronkan file antara direktori lokal dan bucket.

Ini setara dengan perintah CLI hf buckets sync. Salah satu dari source atau dest harus berupa path bucket (hf://buckets/...) dan yang lainnya harus berupa path direktori lokal.

Contoh:

>>> 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()
{'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

< >

( source: str | Pathmount_path: strremote_name: str | None = Noneread_only: bool = Truenamespace: str | None = Nonetoken: bool | str | None = None ) → Volume

Parameter

  • source (str atau Path) — Path ke direktori lokal untuk disinkronkan.
  • mount_path (str) — Path mount di dalam container Job, misalnya "/inputs". Harus diawali dengan /.
  • remote_name (str, opsional) — Nama subfolder bucket yang akan disinkronkan. Secara default menggunakan nama {dirname}-{hash} yang diturunkan dari path sumber dan hostname mesin.
  • read_only (bool, opsional, default True) — Mount volume secara read-only di dalam Job. Berikan False agar Job dapat menulis kembali ke folder bucket (misalnya untuk mengambil output dengan sync_bucket() kemudian).
  • namespace (str, opsional) — Namespace yang memiliki bucket jobs-artifacts. Secara default menggunakan namespace pengguna saat ini. Gunakan namespace yang sama dengan Job yang akan memuat volume.
  • token (Union[bool, str, None], opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Mengembalikan

Volume

Volume bucket yang di-scope ke subfolder yang disinkronkan, untuk dimasukkan ke dalam daftar volumes dari run_job(), run_uv_job(), create_scheduled_job() atau create_scheduled_uv_job().

Sinkronkan direktori lokal ke bucket dan kembalikan Volume yang siap dipasang dalam Job.

File diunggah ke subfolder dari bucket {namespace}/jobs-artifacts (dibuat secara otomatis sebagai privat; peringatan akan dikeluarkan jika bucket sudah ada dan bersifat publik) menggunakan logika sinkronisasi yang sama dengan sync_bucket(): sinkronisasi ulang direktori yang sama hanya mengunggah file baru atau yang telah dimodifikasi. Secara default, nama subfolder diturunkan dari jalur direktori dan nama host mesin, sehingga pemanggilan berulang dari direktori yang sama akan menggunakan folder jauh yang sama. Berikan remote_name untuk menggunakan nama tetap sebagai gantinya.

Perhatikan bahwa data disalin ke bucket, bukan dimount secara langsung: perubahan yang dilakukan secara lokal setelah sinkronisasi tidak terlihat oleh Job (jalankan ulang sync_job_volume untuk memperbarui), dan volume dimount hanya-baca secara default. Untuk mengambil data yang ditulis oleh Job ke volume baca-tulis, sinkronkan folder bucket kembali dengan sync_bucket(). Jika direktori sumber kosong (misalnya direktori output), file placeholder .keep diunggah agar volume tetap dapat dimount.

Contoh:

>>> 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

< >

( scheduled_job_id: strnamespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo

Parameter

  • scheduled_job_id (str) — ID dari Job terjadwal.
  • namespace (str, opsional) — Namespace tempat Job terjadwal berada. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Mengembalikan

JobInfo

Info tentang run yang dipicu.

Membuang

HfHubHTTPError

  • HfHubHTTPError — HTTP 409 jika instance lain sudah berjalan dan concurrency dinonaktifkan pada job terjadwal.

Pemicu Job terjadwal untuk dijalankan segera.

Hal ini memicu satu eksekusi segera dari spesifikasi pekerjaan terjadwal. Hal ini tidak mengubah jadwal dan tidak memengaruhi eksekusi terjadwal berikutnya. Jika sebuah instans sudah berjalan dan pekerjaan terjadwal tidak mengizinkan eksekusi bersamaan, permintaan akan ditolak (HTTP 409).

berbeda dengan

< >

( repo_id: strtoken: bool | str | None = Nonerepo_type: str | None = None )

Parameter

  • repo_id (str) — Repositori yang akan dihapus dari daftar suka. Contoh: "user/my-cool-model".
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • repo_type (str, opsional) — Atur ke "dataset" atau "space" jika membatalkan tautan dataset atau space, None atau "model" jika membatalkan tautan model. Default adalah None.

Membuang

RepositoryNotFoundError

  • RepositoryNotFoundError — Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada.

Berbeda dengan repo tertentu di Hub (misalnya menghapus dari daftar favorit).

Untuk mencegah penyalahgunaan spam, tidak mungkin untuk like sebuah repositori dari skrip.

Lihat juga list_liked_repos().

Contoh:

>>> 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

< >

( bucket_id: strprivate: booltoken: bool | str | None = None )

Parameter

  • bucket_id (str) — ID dari bucket (mis. "username/my-bucket").
  • private (bool) — Apakah akan membuat bucket menjadi privat.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Membuang

BucketNotFoundError atau or

  • BucketNotFoundError — Jika bucket tidak dapat ditemukan. Hal ini mungkin karena bucket tersebut tidak ada,
  • or — karena disetel ke private dan Anda tidak memiliki akses.

Perbarui pengaturan bucket di Hub.

Saat ini, pengaturan yang didukung hanyalah visibilitas bucket.

Contoh:

>>> 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

< >

( collection_slug: stritem_object_id: strnote: str | None = Noneposition: int | None = Nonetoken: bool | str | None = None )

Parameter

  • collection_slug (str) — Slug dari koleksi yang akan diperbarui. Contoh: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • item_object_id (str) — ID item dalam koleksi. Ini bukan id item di Hub (repo_id atau paper id). Harus diambil dari objek CollectionItem. Contoh: collection.items[0].item_object_id.
  • note (str, opsional) — Catatan untuk dilampirkan pada item dalam koleksi. Ukuran maksimum untuk catatan adalah 500 karakter.
  • position (int, opsional) — Posisi baru item dalam koleksi.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Perbarui item dalam koleksi.

Contoh:

>>> 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

< >

( collection_slug: strtitle: str | None = Nonedescription: str | None = Noneposition: int | None = Noneprivate: bool | None = Nonetheme: str | None = Nonetoken: bool | str | None = None )

Parameter

  • collection_slug (str) — Slug dari koleksi yang akan diperbarui. Contoh: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • title (str) — Judul koleksi yang akan diperbarui.
  • description (str, opsional) — Deskripsi dari koleksi yang akan diperbarui. Ukuran maksimum untuk deskripsi adalah 150 karakter.
  • position (int, opsional) — Posisi baru koleksi dalam daftar koleksi pengguna.
  • private (bool, opsional) — Apakah koleksi harus bersifat privat atau tidak.
  • theme (str, opsional) — Tema koleksi di Hub.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Perbarui metadata dari sebuah koleksi di Hub.

Semua argumen bersifat opsional. Hanya metadata yang disediakan yang akan diperbarui.

Mengembalikan: Koleksi

Contoh:

>>> 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

< >

( collection_slug: strresource_group_id: str | Nonetoken: bool | str | None = None )

Parameter

  • collection_slug (str) — Slug dari koleksi yang akan diperbarui. Contoh: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • resource_group_id (str atau None) — Grup sumber daya untuk ditugaskan ke koleksi, sebagai string heksadesimal 24 karakter. Jika None, koleksi dihapus dari grup sumber daya mana pun.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Tugaskan koleksi ke grup sumber daya, atau hapus dari grup sumber daya mana pun.

Hanya berlaku untuk koleksi yang dimiliki organisasi.

Contoh:

>>> 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

< >

( name: straccelerator: str | None = Noneinstance_size: str | None = Noneinstance_type: str | None = Nonemin_replica: int | None = Nonemax_replica: int | None = Nonescale_to_zero_timeout: int | None = Nonescaling_metric: InferenceEndpointScalingMetric | None = Nonescaling_threshold: float | None = Nonerepository: str | None = Noneframework: str | None = Nonerevision: str | None = Nonetask: str | None = Nonecustom_image: dict | None = Nonecontainer_command: list[str] | None = Nonecontainer_args: list[str] | None = Nonetensor_parallel_size: int | None = Nonedata_parallel_size: int | None = Noneenv: dict[str, str] | None = Nonesecrets: dict[str, str] | None = Nonedomain: str | None = Nonepath: str | None = Nonecache_http_responses: bool | None = Nonetags: list[str] | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → InferenceEndpoint

Parameter

  • name (str) — Nama Inference Endpoint yang akan diperbarui.
  • accelerator (str, opsional) — Akselerator perangkat keras yang akan digunakan untuk inferensi (mis. "cpu").
  • instance_size (str, opsional) — Ukuran atau tipe instance yang akan digunakan untuk hosting model (mis. "x4").
  • instance_type (str, opsional) — Jenis instance cloud tempat Inference Endpoint akan di-deploy (mis. "intel-icl").
  • min_replica (int, opsional) — Jumlah minimum replika (instans) yang harus tetap berjalan untuk Inference Endpoint.
  • max_replica (int, opsional) — Jumlah maksimum replika (instans) untuk diskalakan pada Inference Endpoint.
  • scale_to_zero_timeout (int, opsional) — Durasi dalam menit sebelum endpoint yang tidak aktif diskalakan menjadi nol.
  • scaling_metric (str atau InferenceEndpointScalingMetric , opsional) — Referensi metrik untuk scaling. Yaitu “pendingRequests” atau “hardwareUsage” saat diberikan. Nilai defaultnya adalah None.
  • scaling_threshold (float, opsional) — Ambang batas metrik penskalaan yang digunakan untuk memicu peningkatan skala. Diabaikan jika metrik penskalaan tidak disediakan. Nilai defaultnya adalah None.
  • repository (str, opsional) — Nama repositori model yang terkait dengan Inference Endpoint (misalnya "gpt2").
  • framework (str, opsional) — Framework machine learning yang digunakan untuk model (misalnya "custom").
  • revision (str, opsional) — Revisi model spesifik yang akan di-deploy pada Inference Endpoint (mis. "6c0e6080953db56375760c0471a8c5f2929baf11").
  • task (str, opsional) — Tugas di mana model akan di-deploy (misalnya "text-classification").
  • custom_image (dict, opsional) — Gambar container yang akan dijalankan. Bisa berupa dict yang dikey berdasarkan varian gambar (mis. {"vLLM": {"url": "vllm/vllm-openai:v0.23.0", "port": 8000}‌}, juga sGLang, tgi, tei, llamacpp, hfServe, …), yang diteruskan apa adanya, atau dict datar yang menggambarkan container kustom (mis. {"url": ..., "port": ...}), yang dikirim sebagai {"custom": ...}.
  • container_command (list[str], opsional) — Timpa perintah entrypoint kontainer (dipetakan ke model.command dalam payload API). Berfungsi dengan baik pada gambar mesin yang dikelola (mis. vLLM, SGLang) maupun gambar kustom.
  • container_args (list[str], opsional) — Argumen yang ditambahkan ke entrypoint container (dipetakan ke model.args dalam payload API). Berfungsi dengan baik pada gambar engine yang dikelola (misalnya vLLM, SGLang) maupun gambar kustom.
  • tensor_parallel_size (int, opsional) — Jumlah akselerator untuk membagi satu salinan model (gambar vLLM dan SGLang). Ditulis di dalam konfigurasi gambar mesin. API membutuhkan model.image secara utuh, sehingga ketika custom_image tidak diberikan, gambar yang saat ini dikonfigurasi pada endpoint akan diambil dan diperbarui di tempatnya.
  • data_parallel_size (int, opsional) — Jumlah salinan model yang dijalankan, satu per akselerator (citra vLLM). Penanganannya sama dengan tensor_parallel_size.
  • env (dict[str, str], opsional) — Variabel lingkungan non-rahasia untuk disuntikkan ke lingkungan kontainer
  • secrets (dict[str, str], opsional) — Nilai rahasia untuk disuntikkan ke lingkungan container.
  • domain (str, opsional) — Domain kustom untuk deployment Inference Endpoint; jika disetel, inference endpoint akan tersedia di domain ini (mis. "my-new-domain.cool-website.woof").
  • path (str, opsional) — Path kustom ke model yang di-deploy, harus diawali dengan / (mis. "/models/google-bert/bert-base-uncased").
  • cache_http_responses (bool, opsional) — Apakah akan meng-cache respons HTTP dari Inference Endpoint.
  • tags (list[str], opsional) — Daftar tag untuk dikaitkan dengan Inference Endpoint.
  • namespace (str, opsional) — Namespace tempat Inference Endpoint akan diperbarui. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

InferenceEndpoint

informasi tentang Inference Endpoint yang diperbarui.

Perbarui Inference Endpoint.

Metode ini memungkinkan pembaruan konfigurasi komputasi, model yang di-deploy, rute, atau kombinasi apa pun dari ketiganya. Semua argumen bersifat opsional, tetapi setidaknya satu harus disediakan.

Untuk kenyamanan, Anda juga dapat memperbarui Inference Endpoint menggunakan InferenceEndpoint.update().

update_job_expose

< >

( job_id: strexpose: list[int] | None = Noneexpose_public: list[int] | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo

Parameter

  • job_id (str) — ID dari Job yang sedang berjalan.
  • expose (list[int], opsional) — Port yang akan diekspos melalui proxy Jobs. Akses memerlukan token HF dengan akses baca ke namespace Job.
  • expose_public (list[int], opsional) — Port yang akan diekspos melalui proxy Jobs tanpa autentikasi. Port ini tidak perlu dicantumkan dalam expose.
  • namespace (str, opsional) — Namespace dari Job. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna. Bawaan ke token yang disimpan secara lokal.

Mengembalikan

JobInfo

Job yang diperbarui.

Ganti port yang diekspos oleh Job yang sedang berjalan tanpa menjalankannya ulang.

expose dan expose_public bersama membentuk konfigurasi port yang lengkap: port yang tidak ada di salah satu daftar tersebut akan ditutup. Jangan berikan keduanya untuk menutup semua port yang terekspos.

update_job_labels

< >

( job_id: strlabels: dict[str, str]namespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo

Parameter

  • job_id (str) — ID dari Job.
  • labels (dict[str, str]) — Label baru yang akan disetel pada job. Menggantikan semua label yang ada. Kunci dan nilai harus maksimal 100 karakter dan hanya berisi karakter alfanumerik, tanda hubung, dan garis bawah.
  • namespace (str, opsional) — Namespace tempat Job berjalan. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Mengembalikan

JobInfo

Info Job yang diperbarui.

Perbarui label dari Job yang sudah ada.

Menggantikan semua label yang diberikan pengguna sebelumnya dengan label baru.

update_repo_settings

< >

( repo_id: strgated: Literal['auto', 'manual', False] | None = Noneprivate: bool | None = Nonevisibility: RepoVisibility_T | None = Nonetoken: str | bool | None = Nonerepo_type: str | None = None )

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • gated (Literal["auto", "manual", False], opsional) — Status gated untuk repositori. Jika diatur ke None (default), pengaturan gated dari repositori tidak akan diperbarui.
    • “auto”: Repositori bersifat gated, dan permintaan akses disetujui atau ditolak secara otomatis berdasarkan kriteria yang telah ditentukan sebelumnya.
    • “manual”: Repositori bersifat tergerbang, dan permintaan akses memerlukan persetujuan manual.
    • False : Repositori tidak bergerbang, dan siapa pun dapat mengaksesnya.
  • private (bool, opsional) — Apakah repositori harus bersifat privat. Tidak dapat dikirim bersamaan dengan visibility.
  • visibility (Literal["public", "private", "protected"], opsional) — Visibilitas repositori. Bisa berupa "public" atau "private", atau "protected" untuk Spaces.
  • token (Union[str, bool, None], opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • repo_type (str, opsional) — Jenis repositori yang akan diperbarui pengaturannya ("model", "dataset" atau "space"). Nilai defaultnya adalah "model".

Membuang

ValueError atau HfHubHTTPError atau RepositoryNotFoundError

  • ValueError — Jika gated bukan salah satu dari “auto”, “manual”, atau False.
  • ValueError — Jika repo_type bukan salah satu nilai dalam constants.REPO_TYPES.
  • HfHubHTTPError — Jika permintaan ke API Hugging Face Hub gagal.
  • RepositoryNotFoundError — Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.

Perbarui pengaturan repositori, termasuk akses bergerbang dan visibilitas.

Untuk memberikan lebih banyak kendali atas cara repositori digunakan, Hub memungkinkan penulis repositori untuk mengaktifkan permintaan akses untuk repositori mereka, serta mengubah visibilitas repositori.

update_scheduled_job_labels

< >

( scheduled_job_id: strlabels: dict[str, str]namespace: str | None = Nonetoken: bool | str | None = None ) → ScheduledJobInfo

Parameter

  • scheduled_job_id (str) — ID dari Job terjadwal.
  • labels (dict[str, str]) — Label baru yang akan disetel pada job terjadwal. Menggantikan semua label yang ada. Kunci dan nilai harus maksimal 100 karakter dan hanya berisi karakter alfanumerik, tanda hubung, dan garis bawah.
  • namespace (str, opsional) — Namespace tempat Job terjadwal berada. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Mengembalikan

ScheduledJobInfo

Info Job terjadwal yang diperbarui.

Perbarui label dari Job terjadwal yang sudah ada.

Menggantikan semua label yang diberikan pengguna sebelumnya dengan label baru.

update_scheduled_job_schedule

< >

( scheduled_job_id: strschedule: strnamespace: str | None = Nonetoken: bool | str | None = None ) → ScheduledJobInfo

Parameter

  • scheduled_job_id (str) — ID dari Job terjadwal.
  • schedule (str) — Salah satu dari “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly”, atau ekspresi jadwal CRON (misalnya, ‘0 9 * * 1’ untuk pukul 09.00 setiap Senin).
  • namespace (str, opsional) — Namespace tempat Job terjadwal berada. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Mengembalikan

ScheduledJobInfo

Info Job terjadwal yang diperbarui.

Ubah waktu eksekusi Job terjadwal yang sudah ada.

Hanya jadwal yang diperbarui: spesifikasi Job, label, dan status suspended dipertahankan. Untuk menjalankan Job terjadwal sekali sekarang tanpa mengubah jadwalnya, gunakan trigger_scheduled_job() sebagai gantinya.

Contoh:

>>> 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

< >

( webhook_id: strurl: str | None = Nonejob_id: str | None = Nonewatched: list[dict | WebhookWatchedItem] | None = Nonedomains: list[constants.WEBHOOK_DOMAIN_T] | None = Nonesecret: str | None = Nonesecrets: dict[str, str] | None = Nonetoken: bool | str | None = None ) → WebhookInfo

Parameter

  • webhook_id (str) — Pengidentifikasi unik dari webhook yang akan diperbarui.
  • url (str, opsional) — URL tempat payload akan dikirim.
  • job_id (str, opsional) — ID Job sumber yang akan dipicu dengan payload webhook. Wajib diisi saat mengatur secrets.
  • watched (list[WebhookWatchedItem], opsional) — Daftar item yang akan dipantau. Item ini dapat berupa pengguna, organisasi, model, dataset, atau ruang. Lihat WebhookWatchedItem untuk detail lebih lanjut. Item yang dipantau juga dapat disediakan sebagai kamus biasa.
  • domains (list[Literal["repo", "discussion"]], opsional) — Domain yang akan dipantau. Ini dapat mencakup “repo”, “discussion”, atau keduanya.
  • secret (str, opsional) — Secret untuk menandatangani payload, menyediakan lapisan keamanan tambahan.
  • secrets (dict[str, str], opsional) — Variabel lingkungan rahasia untuk Job yang dipicu oleh webhook. Kunci yang terdaftar menggantikan nilai yang tersimpan, string kosong menghapus rahasia tersebut, dan kunci yang diabaikan mempertahankan nilai tersimpannya. Memerlukan job_id.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

WebhookInfo

Info tentang webhook yang diperbarui.

Perbarui webhook yang sudah ada.

Contoh:

>>> 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

< >

( path: str | Pathtoken: bool | str | None = None ) → str

Parameter

  • path (str atau Path) — Path ke file yang akan diunggah. Format yang didukung adalah PNG, JPEG, GIF, WebP, MP4, MOV, WebM, MP3, dan WAV. Ukuran file harus kurang dari 10MB (50MB untuk video).
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Token tersebut memerlukan izin discussion.write. Untuk mengunggah secara anonim, berikan False.

Mengembalikan

str

URL dari file yang diunggah.

Membuang

ValueError

Mengunggah file gambar, video, atau audio ke Hub dan mengembalikan URL-nya.

Inilah yang dilakukan editor web Hub saat Anda menyeret file ke dalam kotak komentar Discussion atau Pull Request. Embed URL yang dikembalikan ke dalam deskripsi atau komentar: ![alt text](url) untuk gambar, URL polos untuk video, dan <audio controls src="url"></audio> untuk file audio.

Contoh:

>>> 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

< >

( path_or_fileobj: str | Path | bytes | BinaryIOpath_in_repo: strrepo_id: strtoken: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = Nonerun_as_future: bool = False_hot_reload: bool | None = None ) → CommitInfo or Future

Parameter

  • path_or_fileobj (str, Path, bytes, atau IO) — Path ke file di mesin lokal atau stream data biner / fileobj / buffer.
  • path_in_repo (str) — Path file relatif di repo, misalnya: "checkpoints/1fec34a/weights.bin"
  • repo_id (str) — Repositori tempat file akan diunggah, misalnya: "username/custom_transformers"
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • repo_type (str, opsional) — Atur ke "dataset", "space" atau "kernel" jika mengunggah ke repo dataset, space, atau kernel; None atau "model" jika mengunggah ke model. Default adalah None.
  • revision (str, opsional) — Revisi git untuk di-commit. Secara default menggunakan head dari cabang "main".
  • commit_message (str, opsional) — Ringkasan / judul / baris pertama dari commit yang dihasilkan
  • commit_description (str, opsional) — Deskripsi dari commit yang dihasilkan
  • create_pr (boolean, opsional) — Apakah akan membuat Pull Request dengan commit tersebut. Defaultnya False. Jika revision tidak diset, PR dibuka terhadap cabang "main". Jika revision diset dan merupakan cabang, PR dibuka terhadap cabang ini. Jika revision diset dan bukan nama cabang (contoh: oid commit), RevisionNotFoundError dikembalikan oleh server.
  • parent_commit (str, opsional) — OID / SHA dari commit induk, sebagai string heksadesimal. Singkatan (7 karakter pertama) juga didukung. Jika ditentukan dan create_pr adalah False, commit akan gagal jika revision tidak menunjuk ke parent_commit. Jika ditentukan dan create_pr adalah True, pull request akan dibuat dari parent_commit. Menentukan parent_commit memastikan repo tidak berubah sebelum perubahan di-commit, dan dapat sangat berguna jika repo diperbarui / di-commit secara bersamaan.
  • run_as_future (bool, opsional) — Apakah metode ini akan dijalankan di latar belakang. Tugas latar belakang dijalankan secara berurutan tanpa memblokir utas utama. Mengirimkan run_as_future=True akan mengembalikan objek Future. Bawaan adalah False.

Mengembalikan

CommitInfo atau Future

Instance of CommitInfo yang berisi informasi tentang commit yang baru dibuat (commit hash, commit url, pr url, commit message,…). Jika run_as_future=True diteruskan, mengembalikan objek Future yang akan berisi hasil saat dieksekusi.

Unggah file lokal (hingga 50 GB) ke repo yang diberikan. Unggahan dilakukan melalui permintaan HTTP post, dan tidak memerlukan git atau git-lfs untuk diinstal.

Membuang kesalahan berikut:

  • HTTPError jika API HuggingFace mengembalikan error
  • ValueError jika nilai beberapa parameter tidak valid
  • RepositoryNotFoundError Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke private dan Anda tidak memiliki akses.
  • RevisionNotFoundError Jika revisi yang akan diunduh tidak dapat ditemukan.

upload_file mengasumsikan bahwa repo sudah ada di Hub. Jika Anda mendapatkan Client error 404, pastikan Anda sudah terautentikasi, token Anda memiliki izin yang diperlukan, dan repo_id serta repo_type diatur dengan benar. Jika repo belum ada, buat terlebih dahulu menggunakan create_repo().

Contoh:

>>> 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

< >

( repo_id: strfolder_path: str | Pathpath_in_repo: str | None = Nonecommit_message: str | None = Nonecommit_description: str | None = Nonetoken: str | bool | None = Nonerepo_type: str | None = Nonerevision: str | None = Nonecreate_pr: bool | None = Noneparent_commit: str | None = Noneallow_patterns: list[str] | str | None = Noneignore_patterns: list[str] | str | None = Nonedelete_patterns: list[str] | str | None = Nonerun_as_future: bool = False ) → CommitInfo or Future

Parameter

  • repo_id (str) — Repositori tempat file akan diunggah, misalnya: "username/custom_transformers"
  • folder_path (str atau Path) — Path ke folder yang akan diunggah pada sistem file lokal
  • path_in_repo (str, opsional) — Path relatif direktori di repo, misalnya: "checkpoints/1fec34a/results". Secara default akan menggunakan folder root dari repository.
  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • repo_type (str, opsional) — Atur ke "dataset", "space" atau "kernel" jika mengunggah ke repo dataset, space, atau kernel; None atau "model" jika mengunggah ke model. Default adalah None.
  • revision (str, opsional) — Revisi git untuk di-commit. Secara default menggunakan head dari cabang "main".
  • commit_message (str, opsional) — Ringkasan / judul / baris pertama dari commit yang dihasilkan. Nilai default: f"Upload {path_in_repo} with huggingface_hub"
  • commit_description (str opsional) — Deskripsi dari commit yang dihasilkan
  • create_pr (boolean, opsional) — Apakah akan membuat Pull Request dengan commit tersebut. Defaultnya adalah False. PR selalu dibuka terhadap branch default: mengatur kedua create_pr=True dan revision akan memicu ValueError. Perhatikan bahwa setiap pemanggilan dengan create_pr=True membuka pull request baru: untuk melanjutkan upload yang terputus ke PR yang sudah ada, jalankan ulang dengan revision="refs/pr/N" sebagai gantinya.
  • parent_commit (str, opsional) — OID / SHA dari commit induk, sebagai string heksadesimal. Singkatan (7 karakter pertama) juga didukung. Jika ditentukan dan create_pr adalah False, commit akan gagal jika revision tidak menunjuk ke parent_commit. Menentukan parent_commit memastikan repo tidak berubah sebelum perubahan di-commit, dan dapat sangat berguna jika repo diperbarui / di-commit secara bersamaan. Jika upload dipecah menjadi beberapa commit (folder besar), parent_commit hanya berlaku untuk yang pertama.
  • allow_patterns (list[str] atau str, opsional) — Jika disediakan, hanya file yang cocok dengan setidaknya satu pola yang akan diunggah.
  • ignore_patterns (list[str] atau str, opsional) — Jika diberikan, file yang cocok dengan salah satu pola tidak diunggah.
  • delete_patterns (list[str] atau str, opsional) — Jika disediakan, file remote yang cocok dengan salah satu pola akan dihapus dari repo saat file baru dikomitm. Ini berguna jika Anda tidak tahu file mana yang sudah diunggah. Catatan: untuk menghindari ketidaksesuaian, file .gitattributes tidak dihapus meskipun cocok dengan pola.
  • run_as_future (bool, opsional) — Apakah metode ini akan dijalankan di latar belakang. Tugas latar belakang dijalankan secara berurutan tanpa memblokir utas utama. Mengirimkan run_as_future=True akan mengembalikan objek Future. Bawaan adalah False.

Mengembalikan

CommitInfo atau Future

Instance of CommitInfo yang berisi informasi tentang commit yang baru dibuat (commit hash, commit url, pr url, commit message,…). Jika run_as_future=True diteruskan, mengembalikan objek Future yang akan berisi hasil saat dieksekusi.

Unggah folder lokal ke repo yang diberikan. Unggahan dilakukan melalui permintaan HTTP, dan tidak memerlukan git atau git-lfs untuk diinstal.

Struktur folder akan dipertahankan. File dengan nama yang sama yang sudah ada di repositori akan ditimpa. File lainnya tidak akan diubah.

Gunakan argumen allow_patterns dan ignore_patterns untuk menentukan file mana yang akan diunggah. Parameter ini menerima satu pola atau daftar pola. Pola adalah Standard Wildcards (pola globbing) seperti yang didokumentasikan di sini. Jika allow_patterns dan ignore_patterns keduanya diberikan, kedua batasan tersebut berlaku. Secara default, semua file dari folder diunggah.

Gunakan argumen delete_patterns untuk menentukan file jarak jauh yang ingin dihapus. Tipe inputnya sama dengan allow_patterns (lihat di atas). Jika path_in_repo juga disediakan, pola akan dicocokkan terhadap path yang relatif terhadap folder ini. Misalnya, upload_folder(..., path_in_repo="experiment", delete_patterns="logs/*") akan menghapus file jarak jauh apa pun di bawah ./experiment/logs/. Perhatikan bahwa file .gitattributes tidak akan dihapus meskipun cocok dengan pola.

Setiap folder .git/ yang ada di subdirektori mana pun akan diabaikan. Namun, harap diperhatikan bahwa file .gitignore tidak diperhitungkan.

Ketika hf_xet terpasang (default), file diunggah melalui pipeline streaming: pengunggahan dimulai saat folder masih diperiksa terhadap Hub, file di-hash saat dipecah menjadi chunk untuk diunggah (satu kali pembacaan), dan folder besar secara otomatis dikomit dalam beberapa batch agar tetap di bawah batas server (komit lanjutan mendapat sufiks (part N) pada pesan komit). Jika pengunggahan terputus, menjalankan ulang panggilan yang sama akan melanjutkannya: file yang sudah dikomit dilewati dan data yang sudah diunggah dideduplikasi. Ketika hf_xet tidak terpasang, sistem kembali ke satu komit yang dibuat dengan create_commit().

Membuang kesalahan berikut:

  • HTTPError jika API HuggingFace mengembalikan error
  • ValueError jika nilai beberapa parameter tidak valid

upload_folder mengasumsikan bahwa repo sudah ada di Hub. Jika Anda mendapatkan Client error 404, pastikan Anda telah terautentikasi, token Anda memiliki izin yang diperlukan, dan repo_id serta repo_type diatur dengan benar. Jika repo belum ada, buat terlebih dahulu menggunakan create_repo().

Contoh:

# 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

< >

( repo_id: strrepo_type: str | None = Nonerevision: str | None = Nonelocal_dir: str | Path | None = Nonecache_dir: str | Path | None = Nonetoken: str | bool | None = None ) → FolderVerification

Parameter

  • repo_id (str) — Ruang nama (pengguna atau organisasi) dan nama repo yang dipisahkan oleh /.
  • repo_type (str, opsional) — Jenis repositori yang akan diambil pohonnya ("model", "dataset" atau "space". Nilai defaultnya adalah "model".
  • revision (str, opsional) — Revisi repositori tempat pohon diambil. Bawaan adalah cabang "main".
  • local_dir (str atau Path, opsional) — Direktori lokal untuk diverifikasi.
  • cache_dir (str atau Path, opsional) — Direktori cache untuk diverifikasi.
  • token (Union[bool, str, None], optional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.

Mengembalikan

FolderVerification

hasil terstruktur yang berisi detail verifikasi.

Membuang

RepositoryNotFoundError atau RevisionNotFoundError

  • RepositoryNotFoundError — Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada.
  • RevisionNotFoundError — Jika revisi tidak ditemukan (error 404) di repo.

Verifikasi file lokal untuk sebuah repo terhadap checksum Hub.

wait_for_job

< >

( job_id: str | list[str]timeout: float | None = Nonepoll_interval: float = 1.0stages: list[JobStage] | None = Nonenamespace: str | None = Nonetoken: bool | str | None = None ) → JobInfo or list[JobInfo]

Parameter

  • job_id (str atau list[str]) — ID dari Job, atau daftar ID Job yang akan ditunggu. Jika daftar yang diberikan, sebuah daftar JobInfo akan dikembalikan (dalam urutan yang sama).
  • timeout (float, opsional) — Waktu maksimum untuk menunggu Job selesai, dalam detik. Jika None, akan menunggu tanpa batas waktu.
  • poll_interval (float, opsional) — Waktu tunggu antara setiap pemeriksaan status, dalam detik. Bawaan 1 detik.
  • stages (list[JobStage], opsional) — Tahapan yang akan ditunggu. Secara default, menunggu hingga tahap terminal ("COMPLETED", "CANCELED", "ERROR", "DELETED"). Misalnya, berikan [JobStage.RUNNING] untuk menunggu hingga Job mulai berjalan. Tahap terminal selalu menghentikan proses tunggu terlepas dari nilai ini.
  • namespace (str, opsional) — Namespace tempat Job berjalan. Secara default menggunakan namespace pengguna saat ini.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Jika tidak disediakan, token yang disimpan secara lokal akan digunakan, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Mengembalikan

JobInfo atau list[JobInfo]

info Job akhir.

Membuang

TimeoutError

  • TimeoutError — Jika setidaknya satu Job belum mencapai salah satu tahap target setelah timeout detik.

Tunggu hingga satu atau lebih compute Jobs di infrastruktur Hugging Face mencapai tahap tertentu.

Setiap status Job dipantau (dengan inspect_job()) setiap poll_interval detik hingga tahapnya menjadi salah satu dari stages (tahap terminal secara default: "COMPLETED", "CANCELED", "ERROR" atau "DELETED"). JobInfo akhir dikembalikan dalam semua kasus: Job yang gagal atau dibatalkan tidak memicu pengecualian — periksa job.status.stage untuk bertindak berdasarkan hasilnya.

Tahap terminal selalu menghentikan proses tunggu, bahkan jika tidak tercantum dalam stages. Hal ini menghindari penantian selamanya untuk tahap yang tidak akan pernah dicapai oleh Job (misalnya menunggu "RUNNING" pada Job yang gagal saat penjadwalan).

Contoh:

>>> 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

< >

( repo_id: strtimeout: float | None = Nonepoll_interval: float = 1.0token: bool | str | None = None ) → SpaceRuntime

Parameter

  • repo_id (str) — ID Space yang akan ditunggu. Contoh: "username/my-space".
  • timeout (float, opsional) — Waktu tunggu maksimum dalam detik. Jika None, menunggu tanpa batas waktu.
  • poll_interval (float, opsional) — Detik antara pemeriksaan status. Bawaan 1 detik.
  • token (bool atau str, opsional) — Token akses pengguna yang valid. Secara bawaan menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan. Atur ke False untuk menonaktifkan autentikasi. Lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Mengembalikan

SpaceRuntime

Informasi runtime terakhir saat Space mencapai tahap terminal.

Membuang

TimeoutError

  • TimeoutError — Jika Space belum mencapai tahap terminal setelah timeout detik.

Tunggu hingga Space mencapai tahap terminal (tidak sedang membangun/mulai).

Polls get_space_runtime() setiap poll_interval detik hingga stage Space tidak lagi bersifat perantara (BUILDING, RUNNING_BUILDING, APP_STARTING, RUNNING_APP_STARTING). Mengembalikan SpaceRuntime akhir dalam semua kasus — periksa runtime.stage untuk bertindak berdasarkan hasilnya (mis. RUNNING vs BUILD_ERROR).

Contoh:

>>> 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

< >

( token: bool | str | None = Nonecache: bool = False )

Parameter

  • token (bool atau str, opsional) — Token akses pengguna yang valid (string). Secara default menggunakan token yang disimpan secara lokal, yang merupakan metode autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan False.
  • cache (bool, opsional) — Apakah akan meng-cache hasil pemanggilan whoami untuk pemanggilan berikutnya. Jika terjadi kesalahan selama pemanggilan pertama, hasilnya tidak akan di-cache. Nilai default adalah False.

Panggil API HF untuk mengetahui “whoami”.

Jika cache=True diteruskan, hasilnya akan di-cache untuk panggilan berikutnya selama proses Python berjalan. Ini berguna jika Anda berencana memanggil whoami beberapa kali karena endpoint ini sangat dibatasi laju panggilannya (rate-limited) demi alasan keamanan.

API Dataclasses

AccessRequest

kelas huggingface_hub.hf_api.AccessRequest

< >

( username: str | Nonerequest_id: strfullname: str | Noneemail: str | Nonetimestamp: datetimestatus: Literal['pending', 'accepted', 'rejected']fields: dict[str, Any] | None = None )

Parameter

  • username (str, opsional) — Nama pengguna dari pengguna yang meminta akses. None jika repo dikonfigurasi untuk tidak membagikan nama pengguna dari peminta. Dalam hal itu, gunakan request_id untuk menerima, menolak, atau membatalkan permintaan.
  • request_id (str) — ID dari permintaan akses. Selalu diset, bahkan jika nama pengguna tidak dibagikan.
  • fullname (str, opsional) — Nama lengkap pengguna yang meminta akses. None jika repo dikonfigurasi untuk tidak membagikan nama pengguna peminta.
  • email (str, opsional) — Email pengguna yang meminta akses. None jika pengguna diberikan akses secara manual atau jika repo dikonfigurasi untuk tidak membagikan email peminta.
  • timestamp (datetime) — Timestamp dari permintaan.
  • status (Literal["pending", "accepted", "rejected"]) — Status permintaan. Bisa berupa salah satu dari ["pending", "accepted", "rejected"].
  • fields (dict[str, Any], opsional) — Bidang tambahan yang diisi oleh pengguna dalam formulir gerbang.

Struktur data yang berisi informasi tentang permintaan akses pengguna.

BucketFile

kelas huggingface_hub.BucketFile

< >

( **kwargs )

Berisi informasi tentang file dalam bucket di Hub. Objek ini dikembalikan oleh list_bucket_tree().

Mirip dengan RepoFile tetapi untuk file di bucket.

BucketFileMetadata

kelas huggingface_hub.BucketFileMetadata

< >

( size: intxet_file_data: XetFileData )

Parameter

  • size (int) — Ukuran file dalam byte.
  • xet_file_data (XetFileData) — Informasi Xet untuk file (hash dan rute refresh).

Struktur data yang berisi informasi tentang file dalam bucket.

Dikembalikan oleh get_bucket_file_metadata().

BucketInfo

kelas huggingface_hub.BucketInfo

< >

( **kwargs )

Parameter

  • id (str) — ID dari bucket.
  • private (bool) — Apakah bucket bersifat privat.
  • created_at (datetime) — Tanggal pembuatan bucket di Hub.
  • size (int) — Ukuran bucket dalam byte.
  • total_files (int) — Jumlah total file dalam bucket.

Berisi informasi tentang bucket di Hub. Objek ini dikembalikan oleh bucket_info() dan list_buckets().

BucketUrl

kelas huggingface_hub.BucketUrl

< >

( url: strendpoint: str = '' )

Parameter

  • url (str) — Nilai string dari url bucket.
  • endpoint (str, opsional) — Endpoint dari Hub. Defaultnya adalah https://huggingface.co.

Menggambarkan URL bucket di Hub.

BucketUrl dikembalikan oleh create_bucket(). Saat inisialisasi, URL diurai untuk mengisi properti:

  • endpoint (str)
  • namespace (str)
  • bucket_id (str)
  • url (str)
  • uri (HfUri)

DatasetLeaderboardEntry

kelas huggingface_hub.DatasetLeaderboardEntry

< >

( **kwargs )

Parameter

  • rank (int) — Peringkat model di papan peringkat (indeks mulai dari 1).
  • model_id (str) — ID model (misalnya "meta-llama/Llama-3-8b").
  • value (float) — Nilai skor evaluasi.
  • filename (str) — Nama file hasil yang berisi data evaluasi.
  • verified (bool) — Apakah hasil telah diverifikasi.
  • source (dict[str, Any], opsional) — Informasi tentang sumber hasil evaluasi. Mengandung kunci seperti "url", "name", dan "isExternal". Tidak semua entri memiliki sumber.
  • author (User atau Organization) — Penulis model, diurai berdasarkan field "type" dalam respons API.
  • pull_request (int, opsional) — Nomor pull request yang terkait dengan entri papan peringkat, jika ada.
  • notes (str, opsional) — Catatan yang terkait dengan entri papan peringkat, jika ada.

Berisi informasi tentang satu entri dalam papan peringkat dataset di Hub.

Papan peringkat mengurutkan model berdasarkan skor evaluasi mereka pada dataset benchmark tertentu. Objek ini dikembalikan oleh get_dataset_leaderboard(). Untuk mendapatkan hasil evaluasi untuk model spesifik di berbagai benchmark, lihat ModelInfo.eval_results (melalui model_info() dengan expand=["evalResults"]) dan EvalResultEntry.

EvalResultEntry

kelas huggingface_hub.EvalResultEntry

< >

( dataset_id: strtask_id: strvalue: typing.Anydataset_revision: str | None = Noneverify_token: str | None = Nonedate: str | None = Nonesource_url: str | None = Nonesource_name: str | None = Nonesource_user: str | None = Nonesource_org: str | None = Nonenotes: str | None = None )

Parameter

  • dataset_id (str) — ID dataset benchmark dari Hub. Contoh: “cais/hle”, “Idavidrein/gpqa”.
  • task_id (str) — Pengidentifikasi tugas dalam benchmark. Contoh: “gpqa_diamond”.
  • value (Any) — Nilai metrik. Contoh: 20.90.
  • dataset_revision (str, opsional) — SHA Git dari dataset benchmark.
  • verify_token (str, opsional) — Tanda tangan yang dapat digunakan untuk membuktikan bahwa evaluasi dapat diaudit dan direproduksi secara meyakinkan.
  • date (str, opsional) — Waktu saat evaluasi dijalankan (datetime ISO-8601). Bawaan adalah waktu commit git.
  • source_url (str, opsional) — Tautan ke sumber evaluasi (misalnya, https://huggingface.co/spaces/SaylorTwift/smollm3-mmlu-pro). Wajib diisi jika source_name, source_user, atau source_org disediakan.
  • source_name (str, opsional) — Nama tampilan untuk sumber. Contoh: “Eval Logs”.
  • source_user (str, opsional) — Nama pengguna HF untuk atribusi. Contoh: “celinah”.
  • source_org (str, opsional) — Nama org HF untuk atribusi. Contoh: “cais”.
  • notes (str, opsional) — Detail tentang setup evaluasi. Contoh: “tools”, “no-tools”, “chain-of-thought”.

Entri hasil evaluasi untuk format .eval_results/*.yaml.

Mewakili skor evaluasi yang disimpan di repositori model dan secara otomatis muncul di halaman model serta papan peringkat dataset benchmark.

Untuk format model-index lama di README.md, gunakan EvalResult sebagai gantinya.

Lihat https://huggingface.co/docs/hub/eval-results untuk detail lebih lanjut.

Contoh:

>>> 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

kelas huggingface_hub.SyncOperation

< >

( action: typing.Literal['upload', 'download', 'delete', 'skip']path: strsize: int | None = Nonereason: str = ''local_mtime: str | None = Noneremote_mtime: str | None = Nonebucket_file: huggingface_hub._buckets.BucketFile | None = None )

Mewakili operasi sinkronisasi yang akan dilakukan.

SyncPlan

kelas huggingface_hub.SyncPlan

< >

( source: strdest: strtimestamp: stroperations: list = <factory> )

Mewakili rencana sinkronisasi lengkap.

CommitInfo

kelas huggingface_hub.CommitInfo

< >

( commit_url: str*args**kwargs )

Parameter

  • commit_url (str) — Url tempat commit dapat ditemukan.
  • commit_message (str) — Ringkasan (baris pertama) dari commit yang telah dibuat.
  • commit_description (str) — Deskripsi dari commit yang telah dibuat. Bisa kosong.
  • oid (str) — ID hash commit. Contoh: "91c54ad1727ee830252e457677f467be0bfd8a57".
  • pr_url (str, opsional) — Url ke PR yang telah dibuat, jika ada. Diisi ketika create_pr=True dilewatkan.
  • pr_revision (str, opsional) — Revisi PR yang telah dibuat, jika ada. Terisi ketika create_pr=True diteruskan. Contoh: "refs/pr/1".
  • pr_num (int, opsional) — Nomor diskusi PR yang telah dibuat, jika ada. Terisi ketika create_pr=True diteruskan. Dapat diteruskan sebagai discussion_num di get_discussion_details(). Contoh: 1.
  • repo_url (RepoUrl) — URL repo dari commit yang berisi info seperti repo_id, repo_type, dll.

Struktur data yang berisi informasi tentang commit yang baru dibuat.

Dikembalikan oleh metode apa pun yang membuat commit di Hub: create_commit(), upload_file(), upload_folder(), delete_file(), delete_folder(). Kelas ini mewarisi dari str untuk kompatibilitas mundur, tetapi penggunaan metode yang spesifik untuk str sudah tidak didukung lagi.

DatasetInfo

kelas huggingface_hub.DatasetInfo

< >

( **kwargs )

Parameter

  • id (str) — ID dari dataset.
  • author (str) — Penulis dataset.
  • card_data (DatasetCardData, opsional) — Metadata Dataset Card sebagai objek huggingface_hub.repocard_data.DatasetCardData.
  • citation (str, opsional) — Informasi sitasi untuk dataset.
  • created_at (datetime, opsional) — Tanggal pembuatan repo di Hub. Perhatikan bahwa nilai terendah adalah 2022-03-02T23:29:04.000Z, yang sesuai dengan tanggal saat kami mulai menyimpan tanggal pembuatan.
  • description (str, opsional) — Deskripsi dari dataset.
  • disabled (bool, opsional) — Apakah repo dinonaktifkan.
  • downloads (int) — Jumlah unduhan dataset selama 30 hari terakhir.
  • downloads_all_time (int) — Jumlah unduhan kumulatif dataset sejak dibuat.
  • gated (Literal["auto", "manual", False], opsional) — Apakah repo bersifat gated. Jika ya, apakah persetujuan bersifat manual atau otomatis.
  • last_modified (datetime, opsional) — Tanggal commit terakhir ke repo.
  • likes (int) — Jumlah like pada dataset.
  • main_size (int, opsional) — Ukuran dalam byte dari cabang utama dataset.
  • paperswithcode_id (str, opsional) — ID Papers with code dari dataset.
  • private (bool) — Apakah repo bersifat privat.
  • resource_group (dict, opsional) — Informasi grup sumber daya untuk dataset.
  • sha (str) — SHA repo pada revisi tertentu ini.
  • siblings (list[RepoSibling]) — Daftar objek huggingface_hub.hf_api.RepoSibling yang membentuk dataset.
  • tags (list[str]) — Daftar tag dari dataset.
  • trending_score (int, opsional) — Skor tren dari dataset.
  • used_storage (int, opsional) — Ukuran dataset di Hub dalam byte.

Berisi informasi tentang dataset di Hub. Objek ini dikembalikan oleh dataset_info() dan list_datasets().

Sebagian besar atribut dari kelas ini bersifat opsional. Hal ini karena data yang dikembalikan oleh Hub bergantung pada query yang dibuat. Secara umum, semakin spesifik query-nya, semakin banyak informasi yang dikembalikan. Sebaliknya, saat mendaftar dataset menggunakan list_datasets(), hanya sebagian kecil dari atribut yang dikembalikan.

DryRunFileInfo

kelas huggingface_hub.DryRunFileInfo

< >

( commit_hash: strfile_size: int | Nonefilename: strlocal_path: stris_cached: boolwill_download: bool )

Parameter

  • commit_hash (str) — commit_hash yang terkait dengan file.
  • file_size (int, opsional) — Ukuran file, jika diketahui. Untuk file LFS, berisi ukuran file LFS yang sebenarnya, bukan pointer.
  • filename (str) — Nama file di repo.
  • is_cached (bool) — Apakah file sudah di-cache secara lokal.
  • will_download (bool) — Apakah file akan diunduh jika hf_hub_download dipanggil dengan dry_run=False. Dalam praktiknya, will_download adalah True jika file tidak di-cache atau jika force_download=True.

Informasi yang dikembalikan saat melakukan dry run unduhan file.

Dikembalikan oleh hf_hub_download() ketika dry_run=True.

DuplicatedRepoUrl

kelas huggingface_hub.DuplicatedRepoUrl

< >

( url: Anyendpoint: str | None = None )

Parameter

  • files_copy_pending (bool) — True jika file LFS/Xet dari repo baru masih disalin di latar belakang. Hingga salinan selesai, pengunduhan file-file ini mungkin gagal.

RepoUrl yang dikembalikan oleh duplicate_repo().

GitRefInfo

kelas huggingface_hub.GitRefInfo

< >

( name: strref: strtarget_commit: str )

Parameter

  • name (str) — Nama dari referensi (misalnya nama tag atau nama branch).
  • ref (str) — Ref git lengkap di Hub (mis. "refs/heads/main" atau "refs/tags/v1.0").
  • target_commit (str) — OID dari commit target untuk ref (mis. "e7da7f221d5bf496a48136c0cd264e630fe9fcc8")

Berisi informasi tentang referensi git untuk repositori di Hub.

GitCommitInfo

kelas huggingface_hub.GitCommitInfo

< >

( commit_id: strauthors: list[str]created_at: datetimetitle: strmessage: strformatted_title: str | Noneformatted_message: str | None )

Parameter

  • commit_id (str) — OID dari commit (mis. "e7da7f221d5bf496a48136c0cd264e630fe9fcc8")
  • authors (list[str]) — Daftar penulis commit.
  • created_at (datetime) — Datetime saat commit dibuat.
  • title (str) — Judul commit. Ini adalah nilai teks bebas yang diisi oleh para penulis.
  • message (str) — Deskripsi commit. Ini adalah nilai teks bebas yang diisi oleh para penulis.
  • formatted_title (str) — Judul commit yang diformat sebagai HTML. Hanya dikembalikan jika formatted=True disetel.
  • formatted_message (str) — Deskripsi commit yang diformat sebagai HTML. Hanya dikembalikan jika formatted=True disetel.

Berisi informasi tentang commit git untuk repo di Hub. Lihat list_repo_commits() untuk detail lebih lanjut.

GitRefs

kelas huggingface_hub.GitRefs

< >

( branches: list[GitRefInfo]converts: list[GitRefInfo]tags: list[GitRefInfo]pull_requests: list[GitRefInfo] | None = None )

Parameter

  • branches (list[GitRefInfo]) — Daftar GitRefInfo yang berisi informasi tentang cabang pada repo.
  • converts (list[GitRefInfo]) — Daftar GitRefInfo yang berisi informasi tentang ref “convert” pada repo. Converts adalah ref yang digunakan (secara internal) untuk mendorong data yang telah diproses di repo Dataset.
  • tags (list[GitRefInfo]) — Daftar GitRefInfo yang berisi informasi tentang tag pada repo.
  • pull_requests (list[GitRefInfo], opsional) — Daftar GitRefInfo yang berisi informasi tentang pull request pada repo. Hanya dikembalikan jika include_prs=True disetel.

Berisi informasi tentang semua referensi git untuk repositori di Hub.

Object dikembalikan oleh list_repo_refs().

InferenceProviderMapping

kelas huggingface_hub.hf_api.InferenceProviderMapping

< >

( **kwargs )

KernelInfo

kelas huggingface_hub.KernelInfo

< >

( **kwargs )

Parameter

  • id (str) — ID dari repo kernel.
  • author (str, opsional) — Penulis dari repo kernel.
  • downloads (int, opsional) — Jumlah unduhan repo kernel dalam 30 hari terakhir.
  • gated (Literal["auto", "manual", False], opsional) — Apakah repo bersifat gated. Jika ya, apakah persetujuannya manual atau otomatis.
  • last_modified (datetime, opsional) — Tanggal commit terakhir ke repo.
  • likes (int, opsional) — Jumlah like pada repo kernel.
  • private (bool, opsional) — Apakah repo bersifat privat.
  • sha (str, opsional) — SHA repo pada revisi tertentu ini.

Berisi informasi tentang repo kernel di Hub. Objek ini dikembalikan oleh kernel_info().

LFSFileInfo

kelas huggingface_hub.hf_api.LFSFileInfo

< >

( **kwargs )

Parameter

  • file_oid (str) — ID objek SHA-256 dari file. Ini adalah pengenal yang harus diteruskan saat menghapus file secara permanen.
  • filename (str) — Nama file yang mungkin untuk objek LFS. Lihat catatan di atas untuk informasi lebih lanjut.
  • oid (str) — OID dari objek LFS.
  • pushed_at (datetime) — Tanggal objek LFS didorong ke repo.
  • ref (str, opsional) — Ref tempat objek LFS telah didorong (jika ada).
  • size (int) — Ukuran objek LFS.

Berisi informasi tentang file yang disimpan sebagai LFS pada repositori di Hub.

Digunakan dalam konteks daftar dan penghapusan permanen file LFS dari repo untuk mengosongkan ruang. Lihat list_lfs_files() dan permanently_delete_lfs_files() untuk detail lebih lanjut.

File Git LFS dilacak menggunakan ID objek SHA-256, bukan jalur file, untuk mengoptimalkan kinerja. Pendekatan ini diperlukan karena satu objek dapat dirujuk oleh beberapa jalur di berbagai commit, sehingga tidak praktis untuk mencari dan menyelesaikan koneksi tersebut. Lihat dokumentasi kami untuk mempelajari cara mengetahui nama file mana yang terkait dengan setiap SHA.

Contoh:

>>> 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

kelas huggingface_hub.ModelInfo

< >

( **kwargs )

Parameter

  • id (str) — ID model.
  • author (str, opsional) — Penulis model.
  • base_models (list[str], opsional) — Daftar model dasar yang menjadi asal turunan model ini.
  • card_data (ModelCardData, opsional) — Metadata Model Card sebagai objek huggingface_hub.repocard_data.ModelCardData.
  • children_model_count (int, opsional) — Jumlah model anak yang diturunkan dari model ini.
  • config (dict, opsional) — Konfigurasi model.
  • created_at (datetime, opsional) — Tanggal pembuatan repo di Hub. Perhatikan bahwa nilai terendah adalah 2022-03-02T23:29:04.000Z, yang sesuai dengan tanggal saat kami mulai menyimpan tanggal pembuatan.
  • disabled (bool, opsional) — Apakah repo dinonaktifkan.
  • downloads (int) — Jumlah unduhan model selama 30 hari terakhir.
  • downloads_all_time (int) — Jumlah unduhan kumulatif model sejak dibuat.
  • eval_results (list[EvalResultEntry], opsional) — Hasil evaluasi model.
  • gated (Literal["auto", "manual", False], opsional) — Apakah repo bersifat gated. Jika ya, apakah persetujuan bersifat manual atau otomatis.
  • gguf (dict, opsional) — Informasi GGUF dari model.
  • inference (Literal["warm"], opsional) — Status model di Inference Providers. Hangat jika model dilayani oleh setidaknya satu penyedia.
  • inference_provider_mapping (list[InferenceProviderMapping], opsional) — Daftar InferenceProviderMapping yang diurutkan sesuai urutan provider pengguna.
  • last_modified (datetime, opsional) — Tanggal commit terakhir ke repo.
  • library_name (str, opsional) — Perpustakaan yang terkait dengan model.
  • likes (int) — Jumlah like pada model.
  • mask_token (str, opsional) — Token mask yang digunakan oleh model.
  • model_index (dict, opsional) — Indeks model untuk evaluasi.
  • pipeline_tag (str, opsional) — Tag pipeline yang terkait dengan model.
  • private (bool) — Apakah repo bersifat privat.
  • resource_group (dict, opsional) — Informasi grup sumber daya untuk model.
  • safetensors (SafeTensorsInfo, opsional) — Informasi safetensors model.
  • security_repo_status (dict, opsional) — Status pemindaian keamanan model.
  • sha (str, opsional) — SHA repo pada revisi tertentu ini.
  • siblings (list[RepoSibling]) — Daftar objek huggingface_hub.hf_api.RepoSibling yang membentuk model.
  • spaces (list[str], opsional) — Daftar spaces yang menggunakan model.
  • tags (list[str]) — Daftar tag dari model. Dibandingkan dengan card_data.tags, berisi tag tambahan yang dihitung oleh Hub (misalnya pustaka yang didukung, arXiv model).
  • transformers_info (TransformersInfo, opsional) — Informasi spesifik Transformers (auto class, processor, dll.) yang terkait dengan model.
  • trending_score (int, opsional) — Skor tren dari model.
  • used_storage (int, opsional) — Ukuran model di Hub dalam byte.
  • widget_data (Any, opsional) — Data widget yang terkait dengan model.

Berisi informasi tentang model di Hub. Objek ini dikembalikan oleh model_info() dan list_models().

Sebagian besar atribut dari kelas ini bersifat opsional. Hal ini karena data yang dikembalikan oleh Hub bergantung pada query yang dibuat. Secara umum, semakin spesifik query-nya, semakin banyak informasi yang dikembalikan. Sebaliknya, saat mendaftar model menggunakan list_models() hanya sebagian kecil dari atribut yang dikembalikan.

RepoSibling

kelas huggingface_hub.hf_api.RepoSibling

< >

( rfilename: strsize: int | None = Noneblob_id: str | None = Nonelfs: BlobLfsInfo | None = None )

Parameter

  • rfilename (str) — nama file, relatif terhadap root repo.
  • size (int, opsional) — Ukuran file, dalam byte. Atribut ini didefinisikan ketika argumen files_metadata dari repo_info() diatur ke True. Jika tidak, nilainya None.
  • blob_id (str, opsional) — OID git dari file. Atribut ini didefinisikan ketika argumen files_metadata dari repo_info() diatur ke True. Jika tidak, nilainya None.
  • lfs (BlobLfsInfo, opsional) — Metadata LFS dari file. Atribut ini didefinisikan saat argumen files_metadata dari repo_info() diatur ke True dan file disimpan dengan Git LFS. Nilainya None selain itu.

Berisi informasi dasar tentang file repositori di dalam repositori di Hub.

Semua atribut dari kelas ini bersifat opsional kecuali rfilename. Hal ini karena hanya nama file yang dikembalikan saat mencantumkan repositori di Hub (dengan list_models(), list_datasets() atau list_spaces()). Jika Anda membutuhkan informasi lebih lanjut seperti ukuran file, blob id, atau detail lfs, Anda harus memintanya secara spesifik dari satu repositori pada satu waktu (menggunakan model_info(), dataset_info() atau space_info()) karena hal ini menambah lebih banyak kendala pada server backend untuk mengambil data tersebut.

RepoFile

kelas huggingface_hub.RepoFile

< >

( **kwargs )

Parameter

  • path (str) — path file relatif terhadap root repo.
  • size (int) — Ukuran file, dalam byte.
  • blob_id (str) — OID git dari file tersebut.
  • lfs (BlobLfsInfo, opsional) — Metadata LFS file.
  • xet_hash (str, opsional) — Hash Xet dari file.
  • last_commit (LastCommitInfo, opsional) — Metadata commit terakhir file. Hanya didefinisikan jika list_repo_tree() dan get_paths_info() dipanggil dengan expand=True.
  • security (BlobSecurityInfo, opsional) — Metadata pemindaian keamanan file. Hanya didefinisikan jika list_repo_tree() dan get_paths_info() dipanggil dengan expand=True.

Berisi informasi tentang file di Hub.

RepoUrl

kelas huggingface_hub.RepoUrl

< >

( url: Anyendpoint: str | None = None )

Parameter

  • url (Any) — Nilai string dari url repo.
  • endpoint (str, opsional) — Endpoint dari Hub. Defaultnya adalah https://huggingface.co.

Membuang

HfUriError

  • HfUriError — Jika URL tidak dapat diurai (misalnya repo single-segment kanonik, atau repo_type yang tidak dikenal).

Subkelas dari str yang menjelaskan URL repositori di Hub.

RepoUrl dikembalikan oleh HfApi.create_repo. Ia mewarisi dari str untuk kompatibilitas mundur. Saat inisialisasi, URL diurai untuk mengisi properti:

  • endpoint (str)
  • namespace (str)
  • repo_name (str)
  • repo_id (str)
  • repo_type (Literal["model", "dataset", "space"])
  • url (str)

Contoh:

>>> 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

kelas huggingface_hub.utils.SafetensorsRepoMetadata

< >

( metadata: dict | Nonesharded: boolweight_map: dictfiles_metadata: dict )

Parameter

  • metadata (dict, opsional) — Metadata yang terkandung dalam file ‘model.safetensors.index.json’, jika ada. Hanya terisi untuk model yang dipecah (sharded).
  • sharded (bool) — Apakah repo berisi model yang di-shard atau tidak.
  • weight_map (dict[str, str]) — Peta dari semua bobot. Kunci adalah nama tensor dan nilai adalah nama file dari file yang berisi tensor.
  • files_metadata (dict[str, SafetensorsFileMetadata]) — Peta dari semua metadata file. Kunci adalah nama file dan nilainya adalah metadata dari file yang sesuai, sebagai objek SafetensorsFileMetadata.
  • parameter_count (dict[str, int]) — Peta jumlah parameter per tipe data. Kunci adalah tipe data dan nilainya adalah jumlah parameter dari tipe data tersebut.

Metadata untuk repo Safetensors.

Sebuah repo dianggap sebagai repo Safetensors jika mengandung file bobot ‘model.safetensors’ (model non-shared) atau file indeks ‘model.safetensors.index.json’ (model sharded) di akarnya.

Kelas ini dikembalikan oleh get_safetensors_metadata().

Untuk detail lebih lanjut mengenai format safetensors, lihat https://huggingface.co/docs/safetensors/index#format.

SafetensorsFileMetadata

kelas huggingface_hub.utils.SafetensorsFileMetadata

< >

( metadata: dicttensors: dict )

Parameter

  • metadata (dict) — Metadata yang terkandung dalam file.
  • tensors (dict[str, TensorInfo]) — Peta dari semua tensor. Kunci adalah nama tensor dan nilainya adalah informasi tentang tensor yang sesuai, sebagai objek TensorInfo.
  • parameter_count (dict[str, int]) — Peta jumlah parameter per tipe data. Kunci adalah tipe data dan nilainya adalah jumlah parameter dari tipe data tersebut.

Metadata untuk file Safetensors yang dihosting di Hub.

Kelas ini dikembalikan oleh parse_safetensors_file_metadata().

Untuk detail lebih lanjut mengenai format safetensors, lihat https://huggingface.co/docs/safetensors/index#format.

SpaceInfo

kelas huggingface_hub.SpaceInfo

< >

( **kwargs )

Parameter

  • id (str) — ID dari Space.
  • author (str, opsional) — Penulis Space.
  • card_data (SpaceCardData, opsional) — Metadata Kartu Space sebagai objek huggingface_hub.repocard_data.SpaceCardData.
  • created_at (datetime, opsional) — Tanggal pembuatan repo di Hub. Perhatikan bahwa nilai terendah adalah 2022-03-02T23:29:04.000Z, yang sesuai dengan tanggal saat kami mulai menyimpan tanggal pembuatan.
  • datasets (list[str], opsional) — Daftar dataset yang digunakan oleh Space.
  • disabled (bool, opsional) — Apakah Space dinonaktifkan.
  • gated (Literal["auto", "manual", False], opsional) — Apakah repo bersifat gated. Jika ya, apakah persetujuan bersifat manual atau otomatis.
  • host (str, opsional) — URL Host dari Space.
  • last_modified (datetime, opsional) — Tanggal commit terakhir ke repo.
  • likes (int) — Jumlah like pada Space.
  • models (list[str], opsional) — Daftar model yang digunakan oleh Space.
  • private (bool) — Apakah repo bersifat privat.
  • region (Literal["us", "eu"], opsional) — Wilayah cloud tempat Space disimpan.
  • resource_group (dict, opsional) — Informasi grup sumber daya untuk Space.
  • runtime (SpaceRuntime, opsional) — Informasi runtime Space sebagai objek huggingface_hub.hf_api.SpaceRuntime.
  • sdk (str, opsional) — SDK yang digunakan oleh Space.
  • sha (str, opsional) — SHA repo pada revisi tertentu ini.
  • siblings (list[RepoSibling]) — Daftar objek huggingface_hub.hf_api.RepoSibling yang membentuk Space.
  • subdomain (str, opsional) — Subdomain dari Space.
  • tags (list[str]) — Daftar tag dari Space.
  • trending_score (int, opsional) — Skor tren dari Space.
  • used_storage (int, opsional) — Ukuran Space di Hub dalam byte.

Berisi informasi tentang Space di Hub. Objek ini dikembalikan oleh space_info() dan list_spaces().

Sebagian besar atribut dari kelas ini bersifat opsional. Hal ini karena data yang dikembalikan oleh Hub bergantung pada query yang dibuat. Secara umum, semakin spesifik query-nya, semakin banyak informasi yang dikembalikan. Sebaliknya, saat mendaftar spaces menggunakan list_spaces() hanya sebagian kecil dari atribut yang dikembalikan.

SpaceSearchResult

kelas huggingface_hub.SpaceSearchResult

< >

( data: dict )

Parameter

  • id (str) — ID dari Space (mis. "username/repo-name").
  • author (str) — Penulis Space.
  • title (str) — Judul tampilan Space.
  • emoji (str or None) — Emoji icon of the Space.
  • sdk (str atau None) — SDK yang digunakan oleh Space (misalnya "gradio", "docker", "static").
  • likes (int) — Jumlah suka.
  • private (bool) — Apakah Space bersifat privat.
  • tags (list[str] atau None) — Daftar tag.
  • runtime (SpaceRuntime atau None) — Informasi waktu berjalan (tahap, perangkat keras, dll.).
  • ai_short_description (str atau None) — Deskripsi singkat yang dihasilkan oleh AI.
  • ai_category (str atau None) — Kategori yang dihasilkan AI (mis. "Image Generation").
  • semantic_relevancy_score (float atau None) — Skor relevansi semantik (0-1) relatif terhadap kueri pencarian.
  • trending_score (int atau None) — Skor tren.

Satu hasil dari API pencarian semantik Spaces.

Dikembalikan oleh HfApi.search_spaces().

TensorInfo

kelas huggingface_hub.utils.TensorInfo

< >

( dtype: typing.Literal['F64', 'F32', 'F16', 'BF16', 'I64', 'I32', 'I16', 'I8', 'U8', 'U3', 'BOOL']shape: listdata_offsets: tuple )

Parameter

  • dtype (str) — Tipe data dari tensor (“F64”, “F32”, “F16”, “BF16”, “I64”, “I32”, “I16”, “I8”, “U8”, “U3”, “BOOL”).
  • shape (list[int]) — Bentuk dari tensor.
  • data_offsets (tuple[int, int]) — Offset data dalam file sebagai tuple [BEGIN, END].
  • parameter_count (int) — Jumlah parameter dalam tensor.

Informasi tentang tensor.

Untuk detail lebih lanjut mengenai format safetensors, lihat https://huggingface.co/docs/safetensors/index#format.

Pengguna

kelas huggingface_hub.User

< >

( **kwargs )

Parameter

  • username (str) — Nama pengguna di Hub (unik).
  • fullname (str) — Nama lengkap pengguna.
  • avatar_url (str) — URL avatar pengguna.
  • details (str, opsional) — Detail pengguna.
  • is_following (bool, opsional) — Apakah pengguna yang terautentikasi mengikuti pengguna ini.
  • is_pro (bool, opsional) — Apakah pengguna adalah pengguna pro.
  • num_models (int, opsional) — Jumlah model yang dibuat oleh pengguna.
  • num_datasets (int, opsional) — Jumlah dataset yang dibuat oleh pengguna.
  • num_spaces (int, opsional) — Jumlah ruang yang dibuat oleh pengguna.
  • num_discussions (int, opsional) — Jumlah diskusi yang diinisiasi oleh pengguna.
  • num_papers (int, opsional) — Jumlah makalah yang ditulis oleh pengguna.
  • num_upvotes (int, opsional) — Jumlah upvote yang diterima oleh pengguna.
  • num_likes (int, opsional) — Jumlah suka yang diberikan oleh pengguna.
  • num_following (int, opsional) — Jumlah pengguna yang diikuti oleh pengguna ini.
  • num_followers (int, opsional) — Jumlah pengguna yang mengikuti pengguna ini.
  • orgs (daftar Organization) — Daftar organisasi yang diikuti oleh pengguna.

Berisi informasi tentang pengguna di Hub.

UserLikes

kelas huggingface_hub.UserLikes

< >

( user: strtotal: intdatasets: list[str]kernels: list[str]models: list[str]spaces: list[str] )

Parameter

  • user (str) — Nama pengguna yang suka-sukanya telah diambil.
  • total (int) — Total number of likes.
  • datasets (list[str]) — Daftar dataset yang disukai oleh pengguna (sebagai repo_ids).
  • kernels (list[str]) — Daftar kernel yang disukai pengguna (sebagai repo_ids).
  • models (list[str]) — Daftar model yang disukai oleh pengguna (sebagai repo_ids).
  • spaces (list[str]) — Daftar spaces yang disukai oleh pengguna (sebagai repo_ids).

Berisi informasi tentang suka pengguna di Hub.

WebhookInfo

kelas huggingface_hub.WebhookInfo

< >

( id: strurl: str | Nonejob: JobSpec | Nonewatched: list[WebhookWatchedItem]domains: list[constants.WEBHOOK_DOMAIN_T]secret: str | Nonedisabled: bool )

Parameter

  • id (str) — ID dari webhook.
  • url (str, opsional) — URL dari webhook.
  • job (JobSpec, opsional) — Spesifikasi dari Job yang akan dipicu.
  • watched (list[WebhookWatchedItem]) — Daftar item yang dipantau oleh webhook, lihat WebhookWatchedItem.
  • domains (list[WEBHOOK_DOMAIN_T]) — Daftar domain yang dipantau oleh webhook. Bisa berupa salah satu dari ["repo", "discussion"].
  • secret (str, opsional) — Secret dari webhook.
  • disabled (bool) — Apakah webhook dinonaktifkan atau tidak.

Struktur data yang berisi informasi tentang webhook.

Salah satu dari url atau job ditentukan, tetapi tidak keduanya.

WebhookWatchedItem

kelas huggingface_hub.WebhookWatchedItem

< >

( type: Literal['bucket', 'dataset', 'model', 'org', 'space', 'user']name: str )

Parameter

  • type (Literal["bucket", "dataset", "model", "org", "space", "user"]) — Jenis item yang akan dipantau. Bisa berupa salah satu dari ["bucket", "dataset", "model", "org", "space", "user"].
  • name (str) — Nama item yang akan dipantau. Bisa berupa nama pengguna, nama organisasi, nama model, nama dataset, nama space, atau nama bucket.

Struktur data yang berisi informasi tentang item yang dipantau oleh webhook.

CommitOperation

Berikut adalah nilai yang didukung untuk CommitOperation():

kelas huggingface_hub.CommitOperationAdd

< >

( path_in_repo: strpath_or_fileobj: str | pathlib.Path | bytes | typing.BinaryIO )

Parameter

  • path_in_repo (str) — Path file relatif di repo, misalnya: "checkpoints/1fec34a/weights.bin"
  • path_or_fileobj (str, Path, bytes, atau BinaryIO) — Salah satu dari:
    • path ke file lokal (sebagai str atau pathlib.Path) untuk diunggah
    • buffer berisi byte (bytes) yang menyimpan konten file yang akan diunggah
    • sebuah “file object” (subclass dari io.BufferedIOBase), biasanya diperoleh dengan open(path, "rb"). Objek ini harus mendukung metode seek() dan tell().

Membuang

ValueError

  • ValueError — Jika path_or_fileobj bukan salah satu dari str, Path, bytes atau io.BufferedIOBase.
  • ValueError — Jika path_or_fileobj adalah str atau Path tetapi bukan path ke file yang ada.
  • ValueError — Jika path_or_fileobj adalah io.BufferedIOBase tetapi tidak mendukung keduanya seek() dan tell().

Struktur data yang menyimpan informasi yang diperlukan untuk mengunggah file ke repositori di Hub.

as_file

< >

( with_tqdm: bool = False )

Parameter

  • with_tqdm (bool, opsional, default False) — Jika True, iterasi pada objek file akan menampilkan bilah progres. Hanya berfungsi jika objek seperti file adalah path ke sebuah file. Pure bytes dan buffer tidak didukung.

Manajer konteks yang menghasilkan objek mirip file yang memungkinkan membaca data mendasar di balik path_or_fileobj.

Contoh:

>>> 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

< >

( )

Konten yang dikodekan base64 dari path_or_fileobj

Mengembalikan: bytes

kelas huggingface_hub.CommitOperationDelete

< >

( path_in_repo: stris_folder: typing.Union[bool, typing.Literal['auto']] = 'auto' )

Parameter

  • path_in_repo (str) — Path file relatif di repo, misalnya: "checkpoints/1fec34a/weights.bin" untuk file atau "checkpoints/1fec34a/" untuk folder.
  • is_folder (bool atau Literal["auto"], opsional) — Apakah Operasi Hapus diterapkan pada folder atau tidak. Jika “auto”, tipe path (file atau folder) ditebak secara otomatis dengan memeriksa apakah path diakhiri dengan ”/” (folder) atau tidak (file). Untuk secara eksplisit mengatur tipe path, Anda dapat mengatur is_folder=True atau is_folder=False.

Struktur data yang menyimpan informasi yang diperlukan untuk menghapus file atau folder dari repositori di Hub.

kelas huggingface_hub.CommitOperationCopy

< >

( src_path_in_repo: strpath_in_repo: strsrc_revision: str | None = Nonesrc_repo_id: str | None = Nonesrc_repo_type: str | None = None_src_oid: str | None = None_dest_oid: str | None = None_is_duplicated: bool = False )

Parameter

  • src_path_in_repo (str) — Path relatif file di repo yang akan disalin, misalnya "checkpoints/1fec34a/weights.bin".
  • path_in_repo (str) — Path file relatif di repo tempat file akan disalin, misalnya "checkpoints/1fec34a/weights_copy.bin".
  • src_revision (str, opsional) — Revisi git dari file yang akan disalin. Bisa berupa revisi git valid apa pun. Secara default menggunakan revisi commit target.
  • src_repo_id (str, opsional) — Repositori sumber untuk disalin (mis. "username/source-model"). Beralih ke repositori tujuan (salin intra-repo).
  • src_repo_type (str, opsional) — Jenis repositori sumber ("model", "dataset" atau "space"). Wajib diisi ketika src_repo_id disetel.

Struktur data yang menyimpan informasi yang diperlukan untuk menyalin file di repositori pada Hub.

Kedua file LFS dan file reguler didukung. File LFS disalin di sisi server, sedangkan file reguler diunduh dan diunggah ulang sebagai bagian dari commit.

Salinan lintas repositori didukung dengan mengatur src_repo_id dan src_repo_type. Untuk salinan LFS lintas repositori, objek LFS diduplikasi ke repositori tujuan sebelum commit dibuat. Hal ini ditangani secara otomatis oleh create_commit(). Perhatikan bahwa salinan lintas repositori hanya berfungsi dalam storage region yang sama; menyalin antar region tidak didukung.

Catatan: Anda dapat menggabungkan CommitOperationCopy dan CommitOperationDelete untuk mengubah nama file LFS di Hub.

CommitScheduler

kelas huggingface_hub.CommitScheduler

< >

( repo_id: strfolder_path: str | pathlib.Pathevery: int | float = 5path_in_repo: str | None = Nonerepo_type: str | None = Nonerevision: str | None = Noneprivate: bool | None = Nonetoken: str | None = Noneallow_patterns: list[str] | str | None = Noneignore_patterns: list[str] | str | None = Nonesquash_history: bool = Falsehf_api: typing.Optional[ForwardRef('HfApi')] = None )

Parameter

  • repo_id (str) — ID dari repo yang akan di-commit.
  • folder_path (str atau Path) — Path ke folder lokal yang akan diunggah secara berkala.
  • every (int atau float, opsional) — Jumlah menit di antara setiap commit. Bawaan adalah 5 menit.
  • path_in_repo (str, opsional) — Path relatif direktori di repo, misalnya: "checkpoints/". Default ke folder root dari repository.
  • repo_type (str, opsional) — Jenis repo yang akan dikomitmennya. Bawaan adalah model.
  • revision (str, opsional) — Revisi repo yang akan di-commit. Defaultnya adalah main.
  • private (bool, opsional) — Apakah membuat repo menjadi privat. Jika None (default), repo akan menjadi publik kecuali default organisasi adalah privat. Nilai ini diabaikan jika repo sudah ada.
  • token (str, opsional) — Token yang digunakan untuk commit ke repo. Secara default menggunakan token yang tersimpan di mesin.
  • allow_patterns (list[str] atau str, opsional) — Jika disediakan, hanya file yang cocok dengan setidaknya satu pola yang akan diunggah.
  • ignore_patterns (list[str] atau str, opsional) — Jika diberikan, file yang cocok dengan salah satu pola tidak diunggah.
  • squash_history (bool, opsional) — Apakah riwayat repo akan di-squash setelah setiap commit. Defaultnya False. Squashing commit berguna untuk menghindari penurunan performa pada repo ketika ukurannya menjadi terlalu besar.
  • hf_api (HfApi, opsional) — Klien HfApi yang digunakan untuk melakukan commit ke Hub. Dapat diatur dengan pengaturan kustom (user agent, token, …).

Penjadwal untuk mengunggah folder lokal ke Hub pada interval tertentu (misalnya, push ke hub setiap 5 menit).

Cara yang direkomendasikan untuk menggunakan scheduler adalah dengan menggunakannya sebagai context manager. Hal ini memastikan bahwa scheduler dihentikan dengan benar dan commit terakhir dipicu ketika skrip berakhir. Scheduler juga dapat dihentikan secara manual dengan metode stop. Lihat panduan upload untuk mempelajari lebih lanjut tentang cara menggunakannya.

Contoh:

>>> 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")

Contoh menggunakan context manager:

>>> 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

< >

( )

Dorong folder ke Hub dan kembalikan info commit.

Metode ini tidak dimaksudkan untuk dipanggil secara langsung. Metode ini dijalankan di latar belakang oleh penjadwal, dengan mematuhi mekanisme antrean untuk menghindari commit yang bersamaan. Memanggil metode ini secara langsung dapat menyebabkan masalah konkurensi.

Perilaku default dari push_to_hub adalah mengasumsikan folder append-only. Metode ini mendaftar semua file di folder dan hanya mengunggah file yang berubah. Jika tidak ada perubahan yang ditemukan, metode ini mengembalikan tanpa mengcommit apa pun. Jika Anda ingin mengubah perilaku ini, Anda dapat mewarisi dari CommitScheduler dan menimpa metode ini. Hal ini dapat berguna, misalnya, untuk mengompresi data bersama dalam satu file sebelum mengcommit. Untuk detail dan contoh lebih lanjut, lihat panduan integrasi kami.

berhenti

< >

( )

Hentikan penjadwal.

Scheduler yang dihentikan tidak dapat dimulai ulang. Terutama untuk keperluan pengujian.

pemicu

< >

( )

Pemicu push_to_hub dan kembalikan future.

Metode ini dipanggil secara otomatis setiap every menit. Anda juga dapat memanggilnya secara manual untuk memicu commit segera, tanpa menunggu commit terjadwal berikutnya.

Update on GitHub

←Variabel lingkungan CLI→