# Klien HfApi Berikut adalah dokumentasi untuk kelas `HfApi`, yang berfungsi sebagai pembungkus 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/authentication#huggingface_hub.login) karena token tidak disimpan secara persisten di mesin. Anda juga dapat menyediakan endpoint yang berbeda atau mengonfigurasi user-agent khusus. ```python from huggingface_hub import HfApi, list_models # Use root method models = list_models() # Or configure a HfApi client hf_api = HfApi( endpoint="https://huggingface.co", # Can be a Private Hub endpoint. token="hf_xxx", # Token is not persisted on the machine. ) models = hf_api.list_models() ``` ## HfApi[[huggingface_hub.HfApi]] #### huggingface_hub.HfApi[[huggingface_hub.HfApi]] ```python huggingface_hub.HfApi(endpoint: str | None = None, token: str | bool | None = None, library_name: str | None = None, library_version: str | None = None, user_agent: dict | str | None = None, headers: dict[str, str] | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2127) **Parameter:** endpoint (`str`, *opsional*) : Endpoint dari Hub. Bawaan ke . 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 kamus atau satu string. Informasi ini akan dilengkapi dengan data tentang 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[[huggingface_hub.HfApi.accept_access_request]] ```python accept_access_request(repo_id: str, user: str | None = None, request_id: str | None = None, repo_type: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10873) **Parameter:** repo_id (`str`) : id dari 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 agar 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`. **Mengangkat:** `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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.cancel_access_request) dan [reject_access_request()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.reject_access_request). Untuk informasi lebih lanjut tentang repositori bergerbang, lihat https://huggingface.co/docs/hub/models-gated. #### add_collection_item[[huggingface_hub.HfApi.add_collection_item]] ```python add_collection_item(collection_slug: str, item_id: str, item_type: CollectionItemType_T, note: str | None = None, exists_ok: bool = False, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10411) **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, paper id untuk papers, slug dari koleksi lain (mis. `"moonshotai/kimi-k2"`) atau bucket id (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`. **Mengangkat:** `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](/docs/huggingface_hub/v2.4.0/id/package_reference/collections#huggingface_hub.Collection) Contoh: ```py >>> from huggingface_hub import add_collection_item >>> collection = add_collection_item( ... collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab", ... item_id="pierre-loic/climate-news-articles", ... item_type="dataset" ... ) >>> collection.items[-1].item_id "pierre-loic/climate-news-articles" # ^item got added to the collection on last position # Add item with a note >>> add_collection_item( ... collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab", ... item_id="datasets/climate_fever", ... item_type="dataset", ... note="This dataset adopts the FEVER methodology that consists of 1,535 real-world claims regarding climate-change collected on the internet." ... ) (...) ``` #### add_space_secret[[huggingface_hub.HfApi.add_space_secret]] ```python add_space_secret(repo_id: str, key: str, value: str, description: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8043) **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[[huggingface_hub.HfApi.add_space_variable]] ```python add_space_variable(repo_id: str, key: str, value: str, description: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8169) **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 dari 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[[huggingface_hub.HfApi.auth_check]] ```python auth_check(repo_id: str, repo_type: str | None = None, token: bool | str | None = None, write: bool = False) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12047) **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 menulis konten pada repositori. Jika `False` (default), hanya memeriksa akses baca. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [GatedRepoError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.GatedRepoError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.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](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.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 diberikan, 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: ```python >>> from huggingface_hub import auth_check >>> from huggingface_hub.utils import GatedRepoError, RepositoryNotFoundError try: auth_check("user/my-cool-model") except GatedRepoError: # Handle gated repository error print("You do not have permission to access this gated repository.") except RepositoryNotFoundError: # Handle repository not found error print("The repository was not found or you do not have access.") ``` 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 sesuai. #### batch_bucket_files[[huggingface_hub.HfApi.batch_bucket_files]] ```python batch_bucket_files(bucket_id: str, add: list[tuple[str | Path | bytes, str]] | None = None, copy: list[tuple[str, str, str, str]] | None = None, delete: list[str] | None = None, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14729) **Parameter:** bucket_id (`str`) : ID dari bucket (mis. `"username/my-bucket"`). add (`list` dari `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 tuple `(source_repo_type, source_repo_id, xet_hash, destination)` di mana: - `source_repo_type` adalah tipe repositori sumber: `"model"`, `"dataset"`, `"space"`, atau `"bucket"`. - `source_repo_id` adalah ID repositori atau bucket sumber (mis. `"username/my-model"`). - `xet_hash` adalah hash xet dari file yang akan disalin. - `destination` adalah path tujuan di dalam bucket. Ini adalah operasi sisi server — tidak ada data yang diunduh atau diunggah ulang. delete (`list` dari `str`, *opsional*) : Jalur 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`. **Mengangkat:** `BucketBatchError` - `BucketBatchError` -- Jika server melaporkan bahwa beberapa operasi gagal. Error ini dilempar setelah semua operasi 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: ```python >>> from huggingface_hub import batch_bucket_files # Upload files >>> batch_bucket_files( ... "username/my-bucket", ... add=[ ... ("./model.safetensors", "models/model.safetensors"), ... (b'{{"key": "value"}}', "config.json"), ... ], ... ) # Copy xet files from another bucket or repo (server-side, no data transfer) >>> batch_bucket_files( ... "username/my-bucket", ... copy=[ ... ("bucket", "username/source-bucket", "", "models/model.safetensors"), ... ("model", "username/my-model", "", "models/config.safetensors"), ... ], ... ) # Delete files >>> batch_bucket_files("username/my-bucket", delete=["old-model.bin"]) # Upload and delete in one batch >>> batch_bucket_files( ... "username/my-bucket", ... add=[("./new.txt", "new.txt")], ... delete=["old.txt"], ... ) ``` #### bucket_info[[huggingface_hub.HfApi.bucket_info]] ```python bucket_info(bucket_id: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14058) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.BucketInfo) Informasi bucket. **Mengangkat:** `BucketNotFoundError` atau ``or`` - `BucketNotFoundError` -- Jika bucket tidak dapat ditemukan. Hal ini mungkin karena bucket tidak ada, - ``or`` -- karena disetel ke `private` dan Anda tidak memiliki akses. Dapatkan informasi tentang bucket tertentu di Hub. Contoh: ```python >>> from huggingface_hub import bucket_info >>> info = bucket_info(bucket_id="Wauplin/first-bucket") >>> info.id 'Wauplin/first-bucket' >>> info.private False >>> info.created_at datetime.datetime(2026, 2, 6, 17, 37, 57, tzinfo=datetime.timezone.utc) >>> info.size 551879671 >>> info.total_files 12 ``` #### cancel_access_request[[huggingface_hub.HfApi.cancel_access_request]] ```python cancel_access_request(repo_id: str, user: str | None = None, request_id: str | None = None, repo_type: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10823) **Parameter:** repo_id (`str`) : id dari 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 agar 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`. **Mengangkat:** `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[[huggingface_hub.HfApi.cancel_job]] ```python cancel_job(job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12757) **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[[huggingface_hub.HfApi.change_discussion_status]] ```python change_discussion_status(repo_id: str, discussion_num: int, new_status: Literal['open', 'closed'], token: bool | str | None = None, comment: str | None = None, repo_type: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7756) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. discussion_num (`int`) : Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif yang ketat. 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](/docs/huggingface_hub/v2.4.0/id/package_reference/community#huggingface_hub.DiscussionStatusChange) peristiwa perubahan status Menutup atau membuka kembali Diskusi atau Pull Request. Contoh: ```python >>> HfApi().change_discussion_status( ... repo_id="username/repo_name", ... discussion_num=34, ... new_status="closed" ... ) # DiscussionStatusChange(id='deadbeef0000000', type='status-change', ...) ``` > [!TIP] > Membuang kesalahan berikut: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) jika API HuggingFace mengembalikan error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) jika nilai beberapa parameter tidak valid - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repository yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repository tidak ada, atau karena repository disetel ke `private` dan Anda tidak memiliki akses. #### comment_discussion[[huggingface_hub.HfApi.comment_discussion]] ```python comment_discussion(repo_id: str, discussion_num: int, comment: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7613) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. discussion_num (`int`) : Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif yang ketat. comment (`str`) : Konten 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:** [DiscussionComment](/docs/huggingface_hub/v2.4.0/id/package_reference/community#huggingface_hub.DiscussionComment) komentar yang baru dibuat Membuat komentar baru pada Diskusi yang diberikan. Contoh: ```python >>> comment = """ ... Hello @otheruser! ... ... # This is a title ... ... **This is bold**, *this is italic* and ~this is strikethrough~ ... And [this](http://url) is a link ... """ >>> HfApi().comment_discussion( ... repo_id="username/repo_name", ... discussion_num=34, ... comment=comment ... ) # DiscussionComment(id='deadbeef0000000', type='comment', ...) ``` > [!TIP] > Membuang kesalahan berikut: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) jika API HuggingFace mengembalikan error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) jika nilai beberapa parameter tidak valid - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repository yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repository tidak ada, atau karena repository disetel ke `private` dan Anda tidak memiliki akses. #### copy_files[[huggingface_hub.HfApi.copy_files]] ```python copy_files(source: str, destination: str, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14410) **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`. **Mengangkat:** ``ValueError`` - [`ValueError`](https://docs.python.org/3/library/exceptions.html#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. Baik file individual maupun 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.CommitOperationCopy) di balik layar dan membuat commit pada repositori tujuan. Salinan dari bucket ke repo tidak didukung. > [!WARNING] > Salinan sisi server hanya berfungsi di dalam [region penyimpanan](https://huggingface.co/docs/hub/storage-regions) yang sama. Contoh: ```python >>> from huggingface_hub import copy_files # Copy a single file between buckets >>> copy_files("hf://buckets/my-bucket/data.bin", "hf://buckets/other-bucket/data.bin") # Copy a folder into another bucket (nests: backup/models/...) >>> copy_files("hf://buckets/my-bucket/models", "hf://buckets/other-bucket/backup/") # Copy folder contents (trailing /): files go directly into backup/ >>> copy_files("hf://buckets/my-bucket/models/", "hf://buckets/other-bucket/backup/") # Copy a file from a model repo to a bucket >>> copy_files("hf://username/my-model/model.safetensors", "hf://buckets/my-bucket/") # Copy an entire dataset to a bucket >>> copy_files("hf://datasets/username/my-dataset/", "hf://buckets/my-bucket/datasets/") # Copy files between repositories >>> copy_files("hf://username/source-model/", "hf://username/dest-model/") # Copy a file from one repo to another >>> copy_files("hf://username/source-model/config.json", "hf://username/dest-model/config.json") ``` #### create_branch[[huggingface_hub.HfApi.create_branch]] ```python create_branch(repo_id: str, branch: str, revision: str | None = None, token: bool | str | None = None, repo_type: str | None = None, exist_ok: bool = False) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6963) **Parameter:** repo_id (`str`) : Repositori tempat cabang akan dibuat. Contoh: `"user/my-cool-model"`. branch (`str`) : Nama cabang 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 cabang pada dataset atau space, `None` atau `"model"` jika memberi tag pada model. Default adalah `None`. exist_ok (`bool`, *opsional*, defaultnya `False`) : Jika `True`, jangan lempar error jika cabang sudah ada. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [BadRequestError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.BadRequestError) atau [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada. - [BadRequestError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.BadRequestError) -- Jika referensi untuk branch tidak valid. Contoh: `refs/pr/5` atau 'refs/foo/bar'. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_repo_refs) atau [list_repo_commits()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_repo_commits). #### create_bucket[[huggingface_hub.HfApi.create_bucket]] ```python create_bucket(bucket_id: str, private: bool | None = None, visibility: Literal['public', 'private'] | None = None, resource_group_id: str | None = None, region: REPO_REGIONS | None = None, exist_ok: bool = False, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13950) **Parameter:** bucket_id (`str`) : Nama ruang lingkup (pengguna atau organisasi) dan nama bucket yang dipisahkan oleh `/`. Jika ruang lingkup tidak diberikan, bucket akan dibuat di ruang lingkup 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 (misalnya `"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. Dapat 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.BucketUrl) URL ke bucket yang baru dibuat yang berisi atribut seperti `endpoint`, `namespace`, dan `bucket_id`. Buat bucket di Hub. Contoh: ```python >>> from huggingface_hub import create_bucket >>> url = create_bucket(bucket_id="my-bucket") >>> url.bucket_id 'user/my-bucket' >>> url.url 'https://huggingface.co/buckets/user/my-bucket' >>> url.uri.to_uri() 'hf://buckets/user/my-bucket' >>> create_bucket(bucket_id="my-bucket", private=True, exist_ok=True) BucketUrl(...) >>> create_bucket(bucket_id="my-bucket", region="us") BucketUrl(...) ``` #### create_collection[[huggingface_hub.HfApi.create_collection]] ```python create_collection(title: str, namespace: str | None = None, description: str | None = None, private: bool = False, resource_group_id: str | None = None, exists_ok: bool = False, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10191) **Parameter:** title (`str`) : Judul koleksi yang akan dibuat. Contoh: `"Recent models"`. namespace (`str`, *opsional*) : Namespace dari koleksi yang akan dibuat (nama pengguna atau org). Akan secara default 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*) : Menugaskan 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](/docs/huggingface_hub/v2.4.0/id/package_reference/collections#huggingface_hub.Collection) Contoh: ```py >>> from huggingface_hub import create_collection >>> collection = create_collection( ... title="ICCV 2023", ... description="Portfolio of models, papers and demos I presented at ICCV 2023", ... ) >>> collection.slug "username/iccv-2023-64f9a55bb3115b4f513ec026" ``` #### create_commit[[huggingface_hub.HfApi.create_commit]] ```python create_commit(repo_id: str, operations: Iterable[CommitOperation], commit_message: str, commit_description: str | None = None, token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, create_pr: bool | None = None, num_threads: int = 5, parent_commit: str | None = None, run_as_future: bool = False, _hot_reload: bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L5016) **Parameter:** repo_id (`str`) : Repositori tempat commit akan dibuat, misalnya: `"username/custom_transformers"` operations (`Iterable` dari `~hf_api.CommitOperation`) : Sebuah iterable berisi 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 terkait pengunggahan. Jangan gunakan ulang 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. Bawaan adalah 5. Mengaturnya ke 2 berarti paling banyak 2 file akan diunggah secara bersamaan. 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 atau tidak. Tugas latar belakang dijalankan secara berurutan tanpa memblokir utas utama. Mengirimkan `run_as_future=True` akan mengembalikan objek [Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects). Bawaan adalah `False`. **Mengembalikan:** [CommitInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.CommitInfo) atau `Future` Instance of [CommitInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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. **Mengangkat:** ``ValueError`` atau [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Jika pesan commit kosong. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Jika commit induk bukan OID commit yang valid. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Jika file README.md dengan bagian metadata yang tidak valid di-commit. Dalam kasus ini, commit akan gagal lebih awal, sebelum mencoba mengunggah file apa pun. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Jika `create_pr` adalah `True` dan revisi bukan `None` maupun `"main"`. - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.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. > [!WARNING] > Daftar input `CommitOperation` akan dimutasi selama proses commit. Jangan gunakan objek yang sama untuk beberapa commit. > [!WARNING] > `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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_repo). > [!WARNING] > `create_commit` dibatasi hingga 25k file LFS dan payload 1GB untuk file reguler. #### create_discussion[[huggingface_hub.HfApi.create_discussion]] ```python create_discussion(repo_id: str, title: str, token: bool | str | None = None, description: str | None = None, repo_type: str | None = None, pull_request: bool = False) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7440) **Parameter:** repo_id (`str`) : Nama namespace (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. Bawaan 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_commit). Mengembalikan: [DiscussionWithDetails](/docs/huggingface_hub/v2.4.0/id/package_reference/community#huggingface_hub.DiscussionWithDetails) > [!TIP] > Membuang kesalahan berikut: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) jika API HuggingFace mengembalikan error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) jika nilai beberapa parameter tidak valid - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repository yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repository tidak ada, atau karena repository disetel ke `private` dan Anda tidak memiliki akses. #### create_inference_endpoint[[huggingface_hub.HfApi.create_inference_endpoint]] ```python create_inference_endpoint(name: str, repository: str, framework: str, accelerator: str, instance_size: str, instance_type: str, region: str, vendor: str, account_id: str | None = None, private_link_account_id: str | None = None, private_link_region: str | None = None, min_replica: int = 1, max_replica: int = 1, scaling_metric: InferenceEndpointScalingMetric | None = None, scaling_threshold: float | None = None, scale_to_zero_timeout: int | None = None, revision: str | None = None, task: str | None = None, custom_image: dict | None = None, container_registry_username: str | None = None, container_registry_password: str | None = None, container_command: list[str] | None = None, container_args: list[str] | None = None, env: dict[str, str] | None = None, secrets: dict[str, str] | None = None, type: InferenceEndpointType | str = , domain: str | None = None, path: str | None = None, cache_http_responses: bool | None = None, tags: list[str] | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9205) **Parameter:** name (`str`) : Nama unik untuk Inference Endpoint baru. repository (`str`) : Nama repositori model yang terkait dengan Inference Endpoint (misalnya `"gpt2"`). framework (`str`) : Kerangka kerja 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 (misalnya `"x4"`). instance_type (`str`) : Tipe instans cloud tempat Inference Endpoint akan di-deploy (misalnya `"intel-icl"`). region (`str`) : Wilayah cloud tempat Inference Endpoint akan dibuat (misalnya `"us-east-1"`). vendor (`str`) : Penyedia cloud atau vendor tempat Inference Endpoint akan dihosting (misalnya `"aws"`). account_id (`str`, *opsional*) : Tidak lagi didukung 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*) : Wilayah AWS dari titik masuk PrivateLink (`"us-east-1"` atau `"eu-west-1"`), tempat VPC endpoint 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. Bawaan adalah 1. scaling_metric (`str` atau `InferenceEndpointScalingMetric `, *opsional*) : Referensi metrik untuk penskalaan. Yaitu "pendingRequests" atau "hardwareUsage" saat diberikan. Bawaan adalah None (artinya: biarkan layanan HF Endpoints yang menentukan metriknya). scaling_threshold (`float`, *opsional*) : Ambang batas metrik penskalaan yang digunakan untuk memicu peningkatan skala. Diabaikan ketika metrik penskalaan tidak disediakan. Bawaan 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. Bawaan adalah None. revision (`str`, *opsional*) : Revisi model spesifik yang akan di-deploy pada Inference Endpoint (misalnya `"6c0e6080953db56375760c0471a8c5f2929baf11"`). task (`str`, *opsional*) : Tugas di mana model akan di-deploy (misalnya `"text-classification"`). custom_image (`dict`, *opsional*) : Citra kontainer yang akan dijalankan. Bisa berupa dict yang dikey berdasarkan varian citra (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 kontainer kustom (mis. `{"url": ..., "port": ...}`), yang dikirim sebagai `{"custom": ...}` (lihat contoh). Defaultnya adalah citra 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`. Dikecualikan dari payload API jika tidak disediakan. container_command (`list[str]`, *opsional*) : Menimpa perintah entrypoint kontainer (dipetakan ke `model.command` dalam payload API). Berfungsi dengan gambar mesin yang dikelola (misalnya vLLM, SGLang) maupun gambar kustom. container_args (`list[str]`, *opsional*) : Argumen yang ditambahkan ke entrypoint kontainer (dipetakan ke `model.args` dalam payload API). Berfungsi dengan gambar mesin yang dikelola (mis. vLLM, SGLang) maupun gambar kustom. env (`dict[str, str]`, *opsional*) : Variabel lingkungan non-rahasia untuk disuntikkan ke lingkungan container. secrets (`dict[str, str]`, *opsional*) : Nilai rahasia untuk disuntikkan ke lingkungan container. type ([`InferenceEndpointType]`, *opsional*) : Jenis Inference Endpoint, yang dapat berupa `"authenticated"` (default), `"public"` atau `"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. Bawaan 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](/docs/huggingface_hub/v2.4.0/id/package_reference/inference_endpoints#huggingface_hub.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_inference_endpoints_hardware) untuk menampilkan kombinasi yang valid. Contoh: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> endpoint = api.create_inference_endpoint( ... "my-endpoint-name", ... repository="gpt2", ... framework="pytorch", ... task="text-generation", ... accelerator="cpu", ... vendor="aws", ... region="us-east-1", ... type="authenticated", ... instance_size="x2", ... instance_type="intel-icl", ... ) >>> endpoint InferenceEndpoint(name='my-endpoint-name', status="pending",...) # Run inference on the endpoint >>> endpoint.client.text_generation(...) "..." ``` ```python # Start an Inference Endpoint running Zephyr-7b-beta on TGI >>> from huggingface_hub import HfApi >>> api = HfApi() >>> endpoint = api.create_inference_endpoint( ... "aws-zephyr-7b-beta-0486", ... repository="HuggingFaceH4/zephyr-7b-beta", ... framework="pytorch", ... task="text-generation", ... accelerator="gpu", ... vendor="aws", ... region="us-east-1", ... type="authenticated", ... instance_size="x1", ... instance_type="nvidia-a10g", ... env={ ... "MAX_BATCH_PREFILL_TOKENS": "2048", ... "MAX_INPUT_LENGTH": "1024", ... "MAX_TOTAL_TOKENS": "1512", ... "MODEL_ID": "/repository" ... }, ... custom_image={ ... "healthRoute": "/health", ... "url": "ghcr.io/huggingface/text-generation-inference:1.1.0", ... }, ... secrets={"MY_SECRET_KEY": "secret_value"}, ... tags=["dev", "text-generation"], ... ) ``` ```python # Start an Inference Endpoint running ProsusAI/finbert while scaling to zero in 15 minutes >>> from huggingface_hub import HfApi >>> api = HfApi() >>> endpoint = api.create_inference_endpoint( ... "finbert-classifier", ... repository="ProsusAI/finbert", ... framework="pytorch", ... task="text-classification", ... min_replica=0, ... scale_to_zero_timeout=15, ... accelerator="cpu", ... vendor="aws", ... region="us-east-1", ... type="authenticated", ... instance_size="x2", ... instance_type="intel-icl", ... ) >>> endpoint.wait(timeout=300) # Run inference on the endpoint >>> endpoint.client.text_generation(...) TextClassificationOutputElement(label='positive', score=0.8983615040779114) ``` #### create_inference_endpoint_from_catalog[[huggingface_hub.HfApi.create_inference_endpoint_from_catalog]] ```python create_inference_endpoint_from_catalog(repo_id: str | None = None, recipe_id: str | None = None, name: str | None = None, accelerator: Literal['cpu', 'gpu', 'neuron'] | str | None = None, gguf_file: str | None = None, token: bool | str | None = None, namespace: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9502) **Parameter:** repo_id (`str`, *opsional*) : ID model di katalog untuk di-deploy sebagai Inference Endpoint. Saling eksklusif dengan `recipe_id`. recipe_id (`str`, *opsional*) : ID resep katalog yang akan di-deploy (lihat [InferenceCatalogRecipe](/docs/huggingface_hub/v2.4.0/id/package_reference/inference_endpoints#huggingface_hub.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](/docs/huggingface_hub/v2.4.0/id/package_reference/inference_endpoints#huggingface_hub.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_inference_catalog). > [!WARNING] > `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[[huggingface_hub.HfApi.create_pull_request]] ```python create_pull_request(repo_id: str, title: str, token: bool | str | None = None, description: str | None = None, repo_type: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7529) **Parameter:** repo_id (`str`) : Nama namespace (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. Bawaan 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_commit); Ini adalah pembungkus di sekitar [HfApi.create_discussion()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_discussion). Mengembalikan: [DiscussionWithDetails](/docs/huggingface_hub/v2.4.0/id/package_reference/community#huggingface_hub.DiscussionWithDetails) > [!TIP] > Membuang kesalahan berikut: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) jika API HuggingFace mengembalikan error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) jika nilai beberapa parameter tidak valid - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repository yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repository tidak ada, atau karena repository disetel ke `private` dan Anda tidak memiliki akses. #### create_repo[[huggingface_hub.HfApi.create_repo]] ```python create_repo(repo_id: str, token: str | bool | None = None, private: bool | None = None, visibility: RepoVisibility_T | None = None, repo_type: str | None = None, exist_ok: bool = False, resource_group_id: str | None = None, region: REPO_REGIONS | None = None, space_sdk: str | None = None, space_hardware: SpaceHardware | None = None, space_sleep_time: int | None = None, space_secrets: list[dict[str, str]] | None = None, space_variables: list[dict[str, str]] | None = None, space_volumes: list[Volume] | None = None, space_template: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4576) **Parameter:** repo_id (`str`) : Nama namespace (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 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` (default), repo akan bersifat publik kecuali default 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*, defaultnya `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 (misalnya `"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. Dapat 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](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.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 default 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](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.Volume) yang akan dipasang di Space saat pembuatan. 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`. Hanya berlaku jika repo_type adalah "space". space_template (`str`, *opsional*) : Menanamkan Space baru dari template resmi. Bisa berupa id repo template (mis. `"SpacesExamples/jupyterlab"`) atau nama singkatnya (mis. `"JupyterLab"`). Gunakan [HfApi.list_space_templates()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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 diset secara eksplisit, Space akan dibuat sebagai privat. **Mengembalikan:** [RepoUrl](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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[[huggingface_hub.HfApi.create_scheduled_job]] ```python create_scheduled_job(image: str, command: list[str], schedule: str, suspend: bool | None = None, concurrency: bool | None = None, env: dict[str, Any] | None = None, secrets: dict[str, Any] | None = None, flavor: JobHardware | str | None = None, timeout: int | float | str | None = None, attempts: int | None = None, name: str | None = None, labels: dict[str, str] | None = None, volumes: list[Volume] | None = None, expose: list[int] | None = None, expose_public: list[int] | None = None, resource_group_id: str | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13072) **Parameter:** image (`str`) : Citra Docker yang akan digunakan. Contoh: `"ubuntu"`, `"python:3.12"`, `"pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"`. Contoh dengan citra 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 9 pagi 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 adalah False. env (`dict[str, Any]`, *opsional*) : Mendefinisikan variabel lingkungan untuk Job. secrets (`dict[str, Any]`, *opsional*) : Mendefinisikan variabel lingkungan rahasia untuk Job. flavor (`str`, *opsional*) : Flavor untuk perangkat keras. Lihat `JobHardware` untuk nilai yang mungkin. Bawaan 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, menggunakan nama yang 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](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.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://--8000.hf.jobs`). Akses selalu memerlukan token HF dengan akses baca ke 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 di `expose`. resource_group_id (`str`, *opsional*) : ID dari grup sumber daya tempat Job terjadwal akan dibuat. Digunakan untuk mengontrol akses ke sumber daya dalam organisasi dan untuk fitur atribusi biaya/batas pengeluaran. Jika tidak disediakan, Job terjadwal dibuat di luar grup sumber daya 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: ```python >>> from huggingface_hub import create_scheduled_job >>> create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], schedule="@hourly") ``` Gunakan ekspresi jadwal CRON: ```python >>> from huggingface_hub import create_scheduled_job >>> create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('this runs every 5min')"], schedule="*/5 * * * *") ``` Buat Job GPU terjadwal: ```python >>> from huggingface_hub import create_scheduled_job >>> image = "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel" >>> command = ["python", "-c", "import torch; print(f'This code ran with the following GPU: {torch.cuda.get_device_name()}')"] >>> create_scheduled_job(image=image, command=command, flavor="a10g-small", schedule="@hourly") ``` #### create_scheduled_uv_job[[huggingface_hub.HfApi.create_scheduled_uv_job]] ```python create_scheduled_uv_job(script: str, script_args: list[str] | None = None, schedule: str, suspend: bool | None = None, concurrency: bool | None = None, dependencies: list[str] | None = None, python: str | None = None, image: str | None = None, env: dict[str, Any] | None = None, secrets: dict[str, Any] | None = None, flavor: JobHardware | str | None = None, timeout: int | float | str | None = None, attempts: int | None = None, name: str | None = None, labels: dict[str, str] | None = None, volumes: list[Volume] | None = None, expose: list[int] | None = None, expose_public: list[int] | None = None, resource_group_id: str | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13551) **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 9 pagi 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 adalah 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*, defaultnya "ghcr.io/astral-sh/uv --python3.12-bookworm"): Gunakan image Docker kustom dengan `uv` yang sudah terinstal. env (`dict[str, Any]`, *opsional*) : Mendefinisikan variabel lingkungan untuk Job. secrets (`dict[str, Any]`, *opsional*) : Mendefinisikan variabel lingkungan rahasia untuk Job. flavor (`str`, *opsional*) : Flavor untuk perangkat keras. Lihat `JobHardware` untuk nilai yang mungkin. Bawaan 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, 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](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.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://--8000.hf.jobs`). Akses selalu memerlukan token HF dengan akses baca ke 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 di `expose`. resource_group_id (`str`, *opsional*) : ID dari grup sumber daya tempat Job terjadwal akan dibuat. Digunakan untuk mengontrol akses ke sumber daya dalam organisasi dan untuk fitur atribusi biaya/batas pengeluaran. Jika tidak disediakan, Job terjadwal dibuat di luar grup sumber daya 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. > [!WARNING] > 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](../guides/jobs#ship-the-launch-config-with-the-script)): konfigurasi peluncuran harus diberikan secara eksplisit di sini. Contoh: Jadwalkan skrip dari URL: ```python >>> from huggingface_hub import create_scheduled_uv_job >>> script = "https://raw.githubusercontent.com/huggingface/trl/refs/heads/main/trl/scripts/sft.py" >>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"] >>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small", schedule="@weekly") ``` Jadwalkan skrip lokal: ```python >>> from huggingface_hub import create_scheduled_uv_job >>> script = "my_sft.py" >>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"] >>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small", schedule="@weekly") ``` Jadwalkan perintah: ```python >>> from huggingface_hub import create_scheduled_uv_job >>> script = "lighteval" >>> script_args= ["endpoint", "inference-providers", "model_name=openai/gpt-oss-20b,provider=auto", "lighteval|gsm8k|0|0"] >>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["lighteval"], flavor="a10g-small", schedule="@weekly") ``` #### create_tag[[huggingface_hub.HfApi.create_tag]] ```python create_tag(repo_id: str, tag: str, tag_message: str | None = None, revision: str | None = None, token: bool | str | None = None, repo_type: str | None = None, exist_ok: bool = False) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7095) **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 untuk ditag. 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*, defaultnya `False`) : Jika `True`, jangan lempar error jika tag sudah ada. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) atau [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Jika revisi tidak ditemukan (error 404) di repo. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.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[[huggingface_hub.HfApi.create_webhook]] ```python create_webhook(url: str | None = None, job_id: str | None = None, watched: list[dict | WebhookWatchedItem], domains: list[constants.WEBHOOK_DOMAIN_T] | None = None, secret: str | None = None, secrets: dict[str, str] | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11176) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.WebhookWatchedItem) yang akan dipantau oleh webhook. Item yang dipantau dapat berupa pengguna, organisasi, model, dataset, spaces, atau bucket. Item yang dipantau juga dapat disediakan sebagai dictionary polos. domains (`list[Literal["repo", "discussion"]]`, opsional) : Daftar domain yang akan dipantau. Nilainya bisa "repo", "discussion", atau keduanya. Secara default, keduanya dipantau. secret (`str`, opsional) : Rahasia untuk menandatangani payload. secrets (`dict[str, str]`, opsional) : Variabel lingkungan rahasia untuk Job yang dipicu oleh webhook (mis. `{"HF_TOKEN": "hf_***"}`). Hanya berlaku dengan `job_id`. Rahasia 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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 ```python >>> from huggingface_hub import create_webhook >>> payload = create_webhook( ... watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}], ... url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548", ... domains=["repo", "discussion"], ... secret="my-secret", ... ) >>> print(payload) WebhookInfo( id="654bbbc16f2ec14d77f109cc", url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548", job=None, watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")], domains=["repo", "discussion"], secret="my-secret", disabled=False, ) ``` Jalankan sebuah Job lalu buat webhook yang memicu Job ini ```python >>> from huggingface_hub import create_webhook, run_job >>> job = run_job( ... image="ubuntu", ... command=["bash", "-c", r"echo An event occurred in $WEBHOOK_REPO_ID: $WEBHOOK_PAYLOAD"], ... ) >>> payload = create_webhook( ... watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}], ... job_id=job.id, ... domains=["repo", "discussion"], ... secret="my-secret", ... ) >>> print(payload) WebhookInfo( id="654bbbc16f2ec14d77f109cc", url=None, job=JobSpec( docker_image='ubuntu', space_id=None, command=['bash', '-c', 'echo An event occurred in $WEBHOOK_REPO_ID: $WEBHOOK_PAYLOAD'], arguments=[], environment={}, secrets=[], flavor='cpu-basic', timeout=None, tags=None, arch=None ), watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")], domains=["repo", "discussion"], secret="my-secret", disabled=False, ) ``` #### dataset_info[[huggingface_hub.HfApi.dataset_info]] ```python dataset_info(repo_id: str, revision: str | None = None, timeout: float | None = None, files_metadata: bool = False, expand: list[ExpandDatasetProperty_T] | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3219) **Parameter:** repo_id (`str`) : Nama namespace (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 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 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.DatasetInfo) Informasi repositori dataset. Dapatkan informasi tentang satu dataset tertentu di huggingface.co. Dataset dapat bersifat privat jika Anda meneruskan token yang dapat diterima. > [!TIP] > Membuang kesalahan berikut: > > - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena disetel ke `private` dan Anda tidak memiliki akses. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) Jika revisi yang akan diunduh tidak dapat ditemukan. #### delete_branch[[huggingface_hub.HfApi.delete_branch]] ```python delete_branch(repo_id: str, branch: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7043) **Parameter:** repo_id (`str`) : Repositori tempat cabang akan dihapus. Contoh: `"user/my-cool-model"`. branch (`str`) : Nama cabang 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 cabang pada dataset atau space, `None` atau `"model"` jika memberi tag pada model. Default adalah `None`. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- Jika mencoba menghapus cabang yang dilindungi. Contoh: `main` tidak dapat dihapus. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- Jika mencoba menghapus cabang yang tidak ada. Hapus cabang dari repositori di Hub. #### delete_bucket[[huggingface_hub.HfApi.delete_bucket]] ```python delete_bucket(bucket_id: str, missing_ok: bool = False, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14157) **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`. **Mengangkat:** `BucketNotFoundError` - `BucketNotFoundError` -- Jika bucket tidak dapat ditemukan dan `missing_ok` diatur ke `False` (default). Hapus bucket dari Hub. Contoh: ```python >>> from huggingface_hub import delete_bucket >>> delete_bucket(bucket_id="Wauplin/first-bucket") >>> delete_bucket(bucket_id="Wauplin/first-bucket", missing_ok=True) ``` #### delete_collection[[huggingface_hub.HfApi.delete_collection]] ```python delete_collection(collection_slug: str, missing_ok: bool = False, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10373) **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: ```py >>> from huggingface_hub import delete_collection >>> collection = delete_collection("username/useless-collection-64f9a55bb3115b4f513ec026", missing_ok=True) ``` > [!WARNING] > Ini adalah tindakan yang tidak dapat dibatalkan. Koleksi yang dihapus tidak dapat dipulihkan. #### delete_collection_item[[huggingface_hub.HfApi.delete_collection_item]] ```python delete_collection_item(collection_slug: str, item_object_id: str, missing_ok: bool = False, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10548) **Parameter:** collection_slug (`str`) : Slug dari koleksi yang akan diperbarui. Contoh: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. item_object_id (`str`) : ID dari item dalam koleksi. Ini bukan id dari item di Hub (repo_id atau paper id). Nilai ini harus diambil dari objek [CollectionItem](/docs/huggingface_hub/v2.4.0/id/package_reference/collections#huggingface_hub.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: ```py >>> from huggingface_hub import get_collection, delete_collection_item # Get collection first >>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026") # Delete item based on its ID >>> delete_collection_item( ... collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026", ... item_object_id=collection.items[-1].item_object_id, ... ) ``` #### delete_file[[huggingface_hub.HfApi.delete_file]] ```python delete_file(path_in_repo: str, repo_id: str, token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, commit_message: str | None = None, commit_description: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6045) **Parameter:** path_in_repo (`str`) : filepath 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. Bawaan 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. > [!TIP] > Membuang kesalahan berikut: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) jika API HuggingFace mengembalikan error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) jika nilai beberapa parameter tidak valid - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repository yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repository tidak ada, atau karena repository disetel ke `private` dan Anda tidak memiliki akses. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) Jika revisi yang akan diunduh tidak dapat ditemukan. - [EntryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.EntryNotFoundError) Jika file yang akan diunduh tidak dapat ditemukan. #### delete_files[[huggingface_hub.HfApi.delete_files]] ```python delete_files(repo_id: str, delete_patterns: list[str], token: bool | str | None = None, repo_type: str | None = None, revision: str | None = None, commit_message: str | None = None, commit_description: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6135) **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 path file, path folder, atau pola wildcard. Pola-pola ini adalah Standard Wildcards (pola globbing) yang didokumentasikan [di sini](https://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm). Pencocokan pola didasarkan pada [`fnmatch`](https://docs.python.org/3/library/fnmatch.html). Perhatikan bahwa `fnmatch` mencocokkan `*` melintasi batas path, 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 direkomendasikan (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 untuk menghapus file. 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. Bawaan 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[[huggingface_hub.HfApi.delete_folder]] ```python delete_folder(path_in_repo: str, repo_id: str, token: bool | str | None = None, repo_type: str | None = None, revision: str | None = None, commit_message: str | None = None, commit_description: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6214) **Parameter:** path_in_repo (`str`) : Jalur 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 direkomendasikan (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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_commit). #### delete_inference_endpoint[[huggingface_hub.HfApi.delete_inference_endpoint]] ```python delete_inference_endpoint(name: str, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9894) **Parameter:** name (`str`) : Nama Inference Endpoint yang akan dihapus. namespace (`str`, *opsional*) : Namespace tempat Inference Endpoint berada. Secara default, namespace ini adalah 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 dengan [pause_inference_endpoint()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.pause_inference_endpoint) atau menskalakan ke nol dengan [scale_to_zero_inference_endpoint()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.scale_to_zero_inference_endpoint). Untuk kenyamanan, Anda juga dapat menghapus Inference Endpoint menggunakan [InferenceEndpoint.delete()](/docs/huggingface_hub/v2.4.0/id/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint.delete). #### delete_repo[[huggingface_hub.HfApi.delete_repo]] ```python delete_repo(repo_id: str, token: str | bool | None = None, repo_type: str | None = None, missing_ok: bool = False) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4788) **Parameter:** repo_id (`str`) : Nama namespace (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. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika repositori yang akan dihapus tidak dapat ditemukan dan `missing_ok` diatur ke False (default). Hapus repo dari HuggingFace Hub. PERHATIAN: tindakan ini tidak dapat dibatalkan. #### delete_scheduled_job[[huggingface_hub.HfApi.delete_scheduled_job]] ```python delete_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13324) **Parameter:** scheduled_job_id (`str`) : ID dari Job yang dijadwalkan. 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[[huggingface_hub.HfApi.delete_space_secret]] ```python delete_space_secret(repo_id: str, key: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8083) **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[[huggingface_hub.HfApi.delete_space_variable]] ```python delete_space_variable(repo_id: str, key: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8210) **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[[huggingface_hub.HfApi.delete_space_volumes]] ```python delete_space_volumes(repo_id: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9108) **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`. **Mengangkat:** `BadRequestError` - `BadRequestError` -- Jika Space tidak memiliki volume yang terpasang. Hapus semua volume dari sebuah Space. Contoh: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> api.delete_space_volumes("username/my-space") ``` #### delete_tag[[huggingface_hub.HfApi.delete_tag]] ```python delete_tag(repo_id: str, tag: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7169) **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`. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Jika tag tidak ditemukan. Hapus tag dari repo di Hub. #### delete_webhook[[huggingface_hub.HfApi.delete_webhook]] ```python delete_webhook(webhook_id: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11529) **Parameter:** webhook_id (`str`) : Pengenal 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: ```python >>> from huggingface_hub import delete_webhook >>> delete_webhook("654bbbc16f2ec14d77f109cc") ``` #### disable_space_dev_mode[[huggingface_hub.HfApi.disable_space_dev_mode]] ```python disable_space_dev_mode(repo_id: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8497) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Informasi runtime tentang Space Anda. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) atau [BadRequestError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.BadRequestError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika Space Anda tidak ditemukan (error 404). Kemungkinan besar repo_id salah atau Space Anda bersifat privat tetapi Anda belum terautentikasi. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- 403 Forbidden: hanya pemilik Space yang dapat mengatur mode dev. Jika Anda ingin menangani Space yang bukan milik Anda, mintalah kepada pemiliknya dengan membuka Discussion atau duplikat Space tersebut. - [BadRequestError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.BadRequestError) -- Jika Space Anda adalah static Space. Static Spaces selalu berjalan dan tidak pernah ditagih. Jika Anda ingin menyembunyikan static Space, 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[[huggingface_hub.HfApi.disable_webhook]] ```python disable_webhook(webhook_id: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11476) **Parameter:** webhook_id (`str`) : Pengenal 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.WebhookInfo) Info tentang webhook yang dinonaktifkan. Nonaktifkan webhook (menjadikannya "nonaktif"). Contoh: ```python >>> from huggingface_hub import disable_webhook >>> disabled_webhook = disable_webhook("654bbbc16f2ec14d77f109cc") >>> disabled_webhook WebhookInfo( id="654bbbc16f2ec14d77f109cc", url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548", jon=None, watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")], domains=["repo", "discussion"], secret="my-secret", disabled=True, ) ``` #### download_bucket_files[[huggingface_hub.HfApi.download_bucket_files]] ```python download_bucket_files(bucket_id: str, files: list[tuple[str | BucketFile, str | Path]], raise_on_missing_files: bool = False, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L15069) **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 `(remote file, local file)` adalah daftar tuple di mana `remote file` adalah path file di bucket atau objek [BucketFile](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.BucketFile), dan `local file` adalah path tujuan pada filesystem lokal. Saat meneruskan objek [BucketFile](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.BucketFile) (diperoleh dari [list_bucket_tree()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_bucket_tree)), metode akan melewati langkah pengambilan metadata dan langsung mengunduh file. Contoh: ```python >>> from huggingface_hub import download_bucket_files >>> download_bucket_files( ... bucket_id="username/my-bucket", ... files=[ ... ("models/model.safetensors", "./local/model.safetensors"), ... ("config.json", "./local/config.json"), ... ], ... ) ``` ```python >>> from huggingface_hub import download_bucket_files >>> parquet_files = [file for file in list_bucket_tree(bucket_id="username/my-bucket") if file.path.endswith(".parquet")] >>> download_bucket_files( ... bucket_id="username/my-bucket", ... files=[(file, f"./local/{file.path}") for file in parquet_files], ... ) ``` #### duplicate_repo[[huggingface_hub.HfApi.duplicate_repo]] ```python duplicate_repo(from_id: str, to_id: str | None = None, repo_type: str | None = None, private: bool | None = None, visibility: RepoVisibility_T | None = None, token: bool | str | None = None, exist_ok: bool = False, resource_group_id: str | None = None, space_hardware: SpaceHardware | None = None, space_sleep_time: int | None = None, space_secrets: list[dict[str, str]] | None = None, space_variables: list[dict[str, str]] | None = None, space_volumes: list[Volume] | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8863) **Parameter:** from_id (`str`) : ID dari repo yang akan diduplikasi. Contoh: `"openai/gdpval"`. to_id (`str`, *opsional*) : ID dari repo baru. Contoh: `"myorg/my-gdpval"`. Jika tidak disediakan, 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. Bawaannya 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*, defaultnya `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 (misalnya `"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](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.SpaceHardware) untuk daftar lengkap. space_sleep_time (`int`, *opsional*) : Jumlah detik inaktivitas yang ditunggu sebelum sebuah Space dimatikan sementara. 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 inaktivitas). 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](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.Volume) yang akan dipasang di Space saat duplikasi. 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`. Hanya berlaku jika repo_type adalah "space". **Mengembalikan:** [DuplicatedRepoUrl](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.DuplicatedRepoUrl) URL ke repo yang baru dibuat. Nilainya adalah subclass dari [RepoUrl](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.RepoUrl) (dan dari `str`) yang berisi atribut seperti `endpoint`, `repo_type`, `repo_id` dan `files_copy_pending`. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau `HfHubHTTPError` - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika salah satu dari `from_id` atau `to_id` tidak dapat ditemukan. Hal ini mungkin terjadi karena repositori tersebut tidak ada, atau karena statusnya 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: ```python >>> from huggingface_hub import duplicate_repo # Duplicate a model to your account >>> repo_url = duplicate_repo("google/gemma-7b") >>> repo_url RepoUrl('https://huggingface.co/nateraw/gemma-7b',...) >>> repo_url.files_copy_pending True # Duplicate a dataset with a custom name >>> duplicate_repo("openai/gdpval", to_id="myorg/my-gdpval", repo_type="dataset") RepoUrl('https://huggingface.co/datasets/myorg/my-gdpval',...) # Duplicate a Space with custom hardware >>> duplicate_repo("multimodalart/dreambooth-training", repo_type="space", space_hardware="t4-medium") RepoUrl('https://huggingface.co/spaces/nateraw/dreambooth-training',...) ``` #### edit_discussion_comment[[huggingface_hub.HfApi.edit_discussion_comment]] ```python edit_discussion_comment(repo_id: str, discussion_num: int, comment_id: str, new_content: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7883) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. discussion_num (`int`) : Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif yang ketat. 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:** [DiscussionComment](/docs/huggingface_hub/v2.4.0/id/package_reference/community#huggingface_hub.DiscussionComment) komentar yang diedit Mengedit komentar pada Diskusi / Pull Request. > [!TIP] > Membuang kesalahan berikut: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) jika API HuggingFace mengembalikan error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) jika nilai beberapa parameter tidak valid - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repository yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repository tidak ada, atau karena repository disetel ke `private` dan Anda tidak memiliki akses. #### enable_space_dev_mode[[huggingface_hub.HfApi.enable_space_dev_mode]] ```python enable_space_dev_mode(repo_id: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8458) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Informasi runtime tentang Space Anda. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) atau [BadRequestError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.BadRequestError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika Space Anda tidak ditemukan (error 404). Kemungkinan besar repo_id salah atau Space Anda bersifat privat tetapi Anda belum terautentikasi. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- 403 Forbidden: hanya pemilik Space yang dapat mengatur mode dev. Jika Anda ingin menangani Space yang bukan milik Anda, mintalah kepada pemiliknya dengan membuka Discussion atau duplikat Space tersebut. - [BadRequestError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.BadRequestError) -- Jika Space Anda adalah static Space. Static Spaces selalu berjalan dan tidak pernah ditagih. Jika Anda ingin menyembunyikan static Space, 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[[huggingface_hub.HfApi.enable_webhook]] ```python enable_webhook(webhook_id: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11423) **Parameter:** webhook_id (`str`) : Pengenal 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.WebhookInfo) Info tentang webhook yang diaktifkan. Aktifkan webhook (menjadikannya "aktif"). Contoh: ```python >>> from huggingface_hub import enable_webhook >>> enabled_webhook = enable_webhook("654bbbc16f2ec14d77f109cc") >>> enabled_webhook WebhookInfo( id="654bbbc16f2ec14d77f109cc", job=None, url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548", watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")], domains=["repo", "discussion"], secret="my-secret", disabled=False, ) ``` #### fetch_job_logs[[huggingface_hub.HfApi.fetch_job_logs]] ```python fetch_job_logs(job_id: str, namespace: str | None = None, follow: bool = False, tail: int | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12327) **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`, dimulai dari N baris terakhir dan terus mengalirkan log baru. Saat `follow=False`, hanya mengembalikan N baris terakhir dari log yang saat ini tersedia. 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: ```python >>> from huggingface_hub import fetch_job_logs, run_job >>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"]) >>> for log in fetch_job_logs(job_id=job.id): ... print(log) Hello from HF compute! >>> # Non-blocking: fetch only currently available logs >>> for log in fetch_job_logs(job_id=job.id, follow=False): ... print(log) >>> # Stream logs starting from the last 100 lines >>> for log in fetch_job_logs(job_id=job.id, follow=True, tail=100): ... print(log) ``` #### fetch_job_metrics[[huggingface_hub.HfApi.fetch_job_metrics]] ```python fetch_job_metrics(job_id: str, namespace: str | None = None, follow: bool = False, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12407) **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: ```python >>> from huggingface_hub import fetch_job_metrics, run_job >>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], flavor="a10g-small") >>> for metrics in fetch_job_metrics(job_id=job.id): ... print(metrics) { "cpu_usage_pct": 0, "cpu_millicores": 3500, "memory_used_bytes": 1306624, "memory_total_bytes": 15032385536, "rx_bps": 0, "tx_bps": 0, "gpus": { "882fa930": { "utilization": 0, "memory_used_bytes": 0, "memory_total_bytes": 22836000000 } }, "replica": "57vr7" } >>> # Stream metrics until the job completes >>> for metrics in fetch_job_metrics(job_id=job.id, follow=True): ... print(metrics) ``` #### fetch_space_logs[[huggingface_hub.HfApi.fetch_space_logs]] ```python fetch_space_logs(repo_id: str, build: bool = False, follow: bool = False, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8737) **Parameter:** repo_id (`str`) : ID dari Space. Contoh: `"bigcode/in-the-stack"`. build (`bool`, *opsional*, defaultnya `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*, defaultnya `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 terbuffer 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 bukan pilihan. Contoh: ```python >>> from huggingface_hub import fetch_space_logs >>> # Non-blocking: print currently available run logs and exit. >>> for line in fetch_space_logs("username/my-space"): ... print(line, end="") >>> # Debug a build failure: >>> for line in fetch_space_logs("username/my-space", build=True): ... print(line, end="") >>> # Stream run logs until the server closes the stream. >>> for line in fetch_space_logs("username/my-space", follow=True): ... print(line, end="") ``` #### file_exists[[huggingface_hub.HfApi.file_exists]] ```python file_exists(repo_id: str, filename: str, repo_type: str | None = None, revision: str | None = None, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3768) **Parameter:** repo_id (`str`) : Nama namespace (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 digunakan untuk mengambil 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`. **Mengembalikan:** True jika file ada, False jika tidak. Memeriksa apakah file ada di repositori di Hugging Face Hub. Contoh: ```py >>> from huggingface_hub import file_exists >>> file_exists("bigcode/starcoder", "config.json") True >>> file_exists("bigcode/starcoder", "not-a-file") False >>> file_exists("bigcode/not-a-repo", "config.json") False ``` #### get_bucket_file_metadata[[huggingface_hub.HfApi.get_bucket_file_metadata]] ```python get_bucket_file_metadata(bucket_id: str, remote_path: str, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L15010) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.BucketFileMetadata) Metadata file yang berisi ukuran dan informasi xet. Ambil metadata file di dalam bucket. Contoh: ```python >>> from huggingface_hub import get_bucket_file_metadata >>> metadata = get_bucket_file_metadata( ... bucket_id="username/my-bucket", ... remote_path="models/model.safetensors", ... ) >>> metadata.size 42000 ``` #### get_bucket_paths_info[[huggingface_hub.HfApi.get_bucket_paths_info]] ```python get_bucket_paths_info(bucket_id: str, paths: Iterable[str], token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14356) **Parameter:** bucket_id (`str`) : ID dari bucket (mis. `"username/my-bucket"`). paths (`Iterable[str]`) : Jalur untuk diambil informasinya. Jika suatu jalur tidak ada, jalur tersebut diabaikan tanpa memicu pengecualian. Hanya jalur file 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.BucketFile). Dapatkan informasi tentang path sebuah bucket. Panggilan dilakukan dalam batch berisi 1000 path. Hasil diberikan saat diterima. Contoh: ```py >>> from huggingface_hub import get_bucket_paths_info >>> paths_info = get_bucket_paths_info("username/my-bucket", ["file.txt", "checkpoints/model.safetensors"]) >>> for info in paths_info: ... print(info) BucketFile(type='file', path='file.txt', size=2379, xet_hash='96e637d9665bd35477b1908a23f2e254edfba0618dbd2d62f90a6baee7d139cf', mtime=datetime.datetime(2024, 9, 25, 15, 31, 2, 346000, tzinfo=datetime.timezone.utc)) BucketFile(type='file', path='checkpoints/model.safetensors', size=2408828, xet_hash='3ed0e9fefe788ddd61d1e26eba67057e9740a064b009256fbafadf6bb95785ca', mtime=datetime.datetime(2024, 9, 25, 15, 31, 2, 346000, tzinfo=datetime.timezone.utc)) ``` #### get_collection[[huggingface_hub.HfApi.get_collection]] ```python get_collection(collection_slug: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10152) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/collections#huggingface_hub.Collection) Contoh: ```py >>> from huggingface_hub import get_collection >>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026") >>> collection.title 'Recent models' >>> len(collection.items) 37 >>> collection.items[0] CollectionItem( item_object_id='651446103cd773a050bf64c2', item_id='TheBloke/U-Amethyst-20B-AWQ', item_type='model', position=88, note=None ) ``` #### get_dataset_leaderboard[[huggingface_hub.HfApi.get_dataset_leaderboard]] ```python get_dataset_leaderboard(repo_id: str, base_model_only: bool | None = None, token: bool | str | None = None, timeout: float | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3289) **Parameter:** repo_id (`str`) : Nama namespace (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 kanonikal/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 menyertakan setiap hasil yang dikirim, terlepas dari apakah model tersebut mendeklarasikan relasi model dasar atau tidak. token (`bool` atau `str`, *opsional*) : Token akses pengguna yang valid. 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`. timeout (`float`, *opsional*) : Apakah akan mengatur batas waktu untuk permintaan ke Hub. **Mengembalikan:** `list[DatasetLeaderboardEntry]` Daftar objek [DatasetLeaderboardEntry](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.model_info) dengan `expand=["evalResults"]`. > [!TIP] > Membuang kesalahan berikut: > > - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.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](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) Jika dataset tidak memiliki papan peringkat. Contoh: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> leaderboard = api.get_dataset_leaderboard("allenai/olmOCR-bench") >>> leaderboard[0].model_id 'datalab-to/chandra-ocr-2' >>> leaderboard[0].rank 1 # Include fine-tuned / derivative models too >>> full_leaderboard = api.get_dataset_leaderboard("allenai/olmOCR-bench", base_model_only=False) ``` #### get_dataset_tags[[huggingface_hub.HfApi.get_dataset_tags]] ```python get_dataset_tags() ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2301) Daftarkan semua tag dataset yang valid sebagai objek namespace bersarang. #### get_discussion_details[[huggingface_hub.HfApi.get_discussion_details]] ```python get_discussion_details(repo_id: str, discussion_num: int, repo_type: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7364) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. discussion_num (`int`) : Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif yang ketat. 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](/docs/huggingface_hub/v2.4.0/id/package_reference/community#huggingface_hub.DiscussionWithDetails) > [!TIP] > Membuang kesalahan berikut: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) jika API HuggingFace mengembalikan error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) jika nilai beberapa parameter tidak valid - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repository yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repository tidak ada, atau karena repository disetel ke `private` dan Anda tidak memiliki akses. #### get_full_repo_name[[huggingface_hub.HfApi.get_full_repo_name]] ```python get_full_repo_name(model_id: str, organization: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7218) **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[[huggingface_hub.HfApi.get_hf_file_metadata]] ```python get_hf_file_metadata(url: str, token: bool | str | None = None, timeout: float | None = 10) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6285) **Parameter:** url (`str`) : URL file, misalnya yang dikembalikan oleh [hf_hub_url()](/docs/huggingface_hub/v2.4.0/id/package_reference/file_download#huggingface_hub.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. **Mengembalikan:** Objek [HfFileMetadata](/docs/huggingface_hub/v2.4.0/id/package_reference/file_download#huggingface_hub.HfFileMetadata) yang berisi metadata seperti lokasi, etag, ukuran, dan commit_hash. Ambil metadata dari file yang di-versikan di Hub untuk url tertentu. #### get_inference_endpoint[[huggingface_hub.HfApi.get_inference_endpoint]] ```python get_inference_endpoint(name: str, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9659) **Parameter:** name (`str`) : Nama Inference Endpoint untuk diambil informasinya. namespace (`str`, *opsional*) : Namespace tempat Inference Endpoint berada. Secara default, namespace ini adalah 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](/docs/huggingface_hub/v2.4.0/id/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint) informasi tentang Inference Endpoint yang diminta. Dapatkan informasi tentang Inference Endpoint. Contoh: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> endpoint = api.get_inference_endpoint("my-text-to-image") >>> endpoint InferenceEndpoint(name='my-text-to-image', ...) # Get status >>> endpoint.status 'running' >>> endpoint.url 'https://my-text-to-image.region.vendor.endpoints.huggingface.cloud' # Run inference >>> endpoint.client.text_to_image(...) ``` #### get_model_tags[[huggingface_hub.HfApi.get_model_tags]] ```python get_model_tags() ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2292) Daftarkan semua tag model yang valid sebagai objek namespace bersarang #### get_organization_overview[[huggingface_hub.HfApi.get_organization_overview]] ```python get_organization_overview(organization: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11747) **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 autentikasi yang direkomendasikan (lihat https://huggingface.co/docs/huggingface_hub/quick-start#authentication). Untuk menonaktifkan autentikasi, berikan `False`. **Mengembalikan:** `Organization` Objek `Organization` dengan ringkasan organisasi. **Mengangkat:** ``HTTPError`` - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) -- HTTP 404 Jika organisasi tidak ada di Hub. Dapatkan gambaran umum tentang organisasi di Hub. #### get_paths_info[[huggingface_hub.HfApi.get_paths_info]] ```python get_paths_info(repo_id: str, paths: list[str] | str, expand: bool = False, revision: str | None = None, repo_type: str | None = None, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4269) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. paths (`Union[list[str], str]`, *opsional*) : Jalur untuk mendapatkan informasi. Jika suatu jalur tidak ada, jalur tersebut diabaikan tanpa memicu pengecualian. expand (`bool`, *opsional*, defaultnya `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 paginasi diimplementasikan di `huggingface_hub`, hal ini transparan bagi Anda kecuali untuk waktu yang dibutuhkan untuk mendapatkan hasil. revision (`str`, *opsional*) : Revisi repositori yang digunakan untuk mengambil informasi. Secara default menggunakan cabang `"main"`. repo_type (`str`, *opsional*) : Jenis repositori yang akan diambil informasinya (`"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:** `list[Union[RepoFile, RepoFolder]]` Informasi tentang path, sebagai daftar objek [RepoFile](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.RepoFile) dan `RepoFolder`. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Jika revisi tidak ditemukan (error 404) di repo. Dapatkan informasi tentang path sebuah repo. Contoh: ```py >>> from huggingface_hub import get_paths_info >>> paths_info = get_paths_info("allenai/c4", ["README.md", "en"], repo_type="dataset") >>> paths_info [ RepoFile(path='README.md', size=2379, blob_id='f84cb4c97182890fc1dbdeaf1a6a468fd27b4fff', lfs=None, last_commit=None, security=None), RepoFolder(path='en', tree_id='dc943c4c40f53d02b31ced1defa7e5f438d5862e', last_commit=None) ] ``` #### get_repo_discussions[[huggingface_hub.HfApi.get_repo_discussions]] ```python get_repo_discussions(repo_id: str, author: str | None = None, discussion_type: constants.DiscussionTypeFilter | None = None, discussion_status: constants.DiscussionStatusFilter | None = None, repo_type: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7256) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. author (`str`, *opsional*) : Berikan nilai untuk memfilter berdasarkan penulis diskusi. `None` berarti tidak ada filter. 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](/docs/huggingface_hub/v2.4.0/id/package_reference/community#huggingface_hub.Discussion). Mengambil Diskusi dan Pull Requests untuk repo yang diberikan. Contoh: Mengumpulkan semua diskusi sebuah repo dalam sebuah daftar: ```python >>> from huggingface_hub import get_repo_discussions >>> discussions_list = list(get_repo_discussions(repo_id="bert-base-uncased")) ``` Mengiterasi diskusi dari sebuah repo: ```python >>> from huggingface_hub import get_repo_discussions >>> for discussion in get_repo_discussions(repo_id="bert-base-uncased"): ... print(discussion.num, discussion.title) ``` #### get_safetensors_metadata[[huggingface_hub.HfApi.get_safetensors_metadata]] ```python get_safetensors_metadata(repo_id: str, repo_type: str | None = None, revision: str | None = None, token: bool | str | None = None, timeout: float | None = 10) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6669) **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. **Mengangkat:** `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 tersebut. 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.parse_safetensors_file_metadata). Untuk mendapatkan setiap header shard dari model yang di-shard di `main` dalam satu permintaan, gunakan [get_sharded_safetensors_metadata()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.get_sharded_safetensors_metadata). Untuk detail lebih lanjut mengenai format safetensors, lihat https://huggingface.co/docs/safetensors/index#format. Contoh: ```py # Parse repo with single weights file >>> metadata = get_safetensors_metadata("bigscience/bloomz-560m") >>> metadata SafetensorsRepoMetadata( metadata=None, sharded=False, weight_map={'h.0.input_layernorm.bias': 'model.safetensors', ...}, files_metadata={'model.safetensors': SafetensorsFileMetadata(...)} ) >>> metadata.files_metadata["model.safetensors"].metadata {'format': 'pt'} # Parse repo with sharded model >>> metadata = get_safetensors_metadata("bigscience/bloom") Parse safetensors files: 100%|██████████████████████████████████████████| 72/72 [00:12<00:00, 5.78it/s] >>> metadata SafetensorsRepoMetadata(metadata={'total_size': 352494542848}, sharded=True, weight_map={...}, files_metadata={...}) >>> len(metadata.files_metadata) 72 # All safetensors files have been fetched # Parse repo with sharded model >>> get_safetensors_metadata("runwayml/stable-diffusion-v1-5") NotASafetensorsRepoError: 'runwayml/stable-diffusion-v1-5' is not a safetensors repo. Couldn't find 'model.safetensors.index.json' or 'model.safetensors' files. ``` #### get_sharded_safetensors_metadata[[huggingface_hub.HfApi.get_sharded_safetensors_metadata]] ```python get_sharded_safetensors_metadata(repo_id: str, filename: str = 'model.safetensors.index.json', token: bool | str | None = None, timeout: float | None = 10) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6824) **Parameter:** repo_id (`str`) : Nama pengguna atau organisasi dan nama repo yang dipisahkan oleh `/`. filename (`str`, *opsional*) : Path dari 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 untuk 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.get_safetensors_metadata). Dapatkan metadata setiap shard dari model safetensors yang di-shard di `main` dari Hub dalam satu permintaan, alih-alih [get_safetensors_metadata()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.get_safetensors_metadata) yang mem-parsing header setiap shard. Hanya Hugging Face Hub. Contoh: ```py >>> metadata = get_sharded_safetensors_metadata("HuggingFaceH4/zephyr-7b-beta") >>> len(metadata.files_metadata) 8 ``` #### get_space_runtime[[huggingface_hub.HfApi.get_space_runtime]] ```python get_space_runtime(repo_id: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8239) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Informasi runtime tentang sebuah Space, termasuk tahap dan perangkat keras Space. Mendapatkan informasi runtime tentang sebuah Space. #### get_space_secrets[[huggingface_hub.HfApi.get_space_secrets]] ```python get_space_secrets(repo_id: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8109) **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: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> api.get_space_secrets("username/my-space") {'HF_TOKEN': SpaceSecret(key='HF_TOKEN', description='...', updated_at=datetime.datetime(...))} ``` #### get_space_variables[[huggingface_hub.HfApi.get_space_variables]] ```python get_space_variables(repo_id: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8146) **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[[huggingface_hub.HfApi.get_user_overview]] ```python get_user_overview(username: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11721) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.User) berisi ringkasan pengguna. **Mengangkat:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Jika pengguna tidak ada di Hub. Dapatkan ringkasan tentang pengguna di Hub. #### get_webhook[[huggingface_hub.HfApi.get_webhook]] ```python get_webhook(webhook_id: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11072) **Parameter:** webhook_id (`str`) : Pengenal 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.WebhookInfo) Info tentang webhook. Dapatkan webhook berdasarkan id-nya. Contoh: ```python >>> from huggingface_hub import get_webhook >>> webhook = get_webhook("654bbbc16f2ec14d77f109cc") >>> print(webhook) WebhookInfo( id="654bbbc16f2ec14d77f109cc", job=None, watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")], url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548", secret="my-secret", domains=["repo", "discussion"], disabled=False, ) ``` #### get_zero_gpu_quota[[huggingface_hub.HfApi.get_zero_gpu_quota]] ```python get_zero_gpu_quota(token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8283) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.ZeroGpuQuota) Kuota ZeroGPU dari pengguna yang terautentikasi. Dapatkan kuota ZeroGPU dari pengguna yang terautentikasi. Berguna untuk melacak penggunaan ZeroGPU saat memanggil Spaces ZeroGPU secara programatik (misalnya dari aplikasi, agen, atau server MCP). Lihat https://huggingface.co/docs/hub/spaces-zerogpu untuk detail lebih lanjut. Contoh: ```py >>> from huggingface_hub import get_zero_gpu_quota >>> quota = get_zero_gpu_quota() >>> quota ZeroGpuQuota(base=2400, remaining=1810, resets_at=datetime.datetime(2026, 9, 30, 9, 12, 3, tzinfo=datetime.timezone.utc), overquota_used=0) >>> print(f"{quota.remaining / 60:.1f} minutes left") 30.2 minutes left ``` #### grant_access[[huggingface_hub.HfApi.grant_access]] ```python grant_access(repo_id: str, user: str, repo_type: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11017) **Parameter:** repo_id (`str`) : id dari repo yang akan diberikan akses. user (`str`) : Nama pengguna dari pengguna yang akan diberikan akses. repo_type (`str`, *opsional*) : Jenis repo yang akan diberikan 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`. **Mengangkat:** `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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.cancel_access_request) atau [reject_access_request()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.reject_access_request). Untuk informasi lebih lanjut tentang repositori bergerbang, lihat https://huggingface.co/docs/hub/models-gated. #### hf_hub_download[[huggingface_hub.HfApi.hf_hub_download]] ```python hf_hub_download(repo_id: str, filename: str, subfolder: str | None = None, repo_type: str | None = None, revision: str | None = None, cache_dir: str | Path | None = None, local_dir: str | Path | None = None, force_download: bool = False, etag_timeout: float = 10, token: bool | str | None = None, local_files_only: bool = False, tqdm_class: type[base_tqdm] | None = None, dry_run: bool = False) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6364) **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 diberikan, file yang diunduh akan ditempatkan di bawah direktori ini. force_download (`bool`, *opsional*, defaultnya `False`) : Apakah file harus diunduh meskipun sudah ada di cache lokal. etag_timeout (`float`, *opsional*, defaultnya `10`) : Saat mengambil ETag, berapa detik yang ditunggu agar 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 file tersebut ada. tqdm_class (`tqdm`, *opsional*) : Jika disediakan, menimpa perilaku bawaan untuk bilah progres. Argumen yang diteruskan harus mewarisi dari `tqdm.auto.tqdm` atau setidaknya meniru perilakunya. Bawaannya adalah bilah progres 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.DryRunFileInfo) yang berisi informasi tentang apa yang akan diunduh. **Mengembalikan:** `str` atau [DryRunFileInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.DryRunFileInfo) yang berisi informasi unduhan. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) atau `~utils.RemoteEntryNotFoundError` atau [LocalEntryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.LocalEntryNotFoundError) atau ``EnvironmentError`` atau ``OSError`` atau ``ValueError`` - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin terjadi karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke `private` dan Anda tidak memiliki akses. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Jika revisi yang akan diunduh tidak dapat ditemukan. - `~utils.RemoteEntryNotFoundError` -- Jika file yang akan diunduh tidak dapat ditemukan. - [LocalEntryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.LocalEntryNotFoundError) -- Jika jaringan dinonaktifkan atau tidak tersedia dan file tidak ditemukan di cache. - [`EnvironmentError`](https://docs.python.org/3/library/exceptions.html#EnvironmentError) -- Jika `token=True` tetapi token tidak dapat ditemukan. - [`OSError`](https://docs.python.org/3/library/exceptions.html#OSError) -- Jika ETag tidak dapat ditentukan. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#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 mereka merupakan file LFS atau tidak) - 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 root `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. #### hide_discussion_comment[[huggingface_hub.HfApi.hide_discussion_comment]] ```python hide_discussion_comment(repo_id: str, discussion_num: int, comment_id: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7940) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. discussion_num (`int`) : Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif yang ketat. 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:** [DiscussionComment](/docs/huggingface_hub/v2.4.0/id/package_reference/community#huggingface_hub.DiscussionComment) komentar tersembunyi Menyembunyikan komentar pada Diskusi / Pull Request. > [!WARNING] > Konten komentar tersembunyi tidak dapat diambil lagi. Menyembunyikan komentar bersifat tidak dapat dibatalkan. > [!TIP] > Membuang kesalahan berikut: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) jika API HuggingFace mengembalikan error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) jika nilai beberapa parameter tidak valid - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repository yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repository tidak ada, atau karena repository disetel ke `private` dan Anda tidak memiliki akses. #### inspect_job[[huggingface_hub.HfApi.inspect_job]] ```python inspect_job(job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12563) **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: ```python >>> from huggingface_hub import inspect_job, run_job >>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"]) >>> inspect_job(job_id=job.id) JobInfo( id='68780d00bbe36d38803f645f', created_at=datetime.datetime(2025, 7, 16, 20, 35, 12, 808000, tzinfo=datetime.timezone.utc), docker_image='python:3.12', space_id=None, command=['python', '-c', "print('Hello from HF compute!')"], arguments=[], environment={}, secrets={}, flavor='cpu-basic', status=JobStatus(stage='RUNNING', message=None) ) ``` #### inspect_scheduled_job[[huggingface_hub.HfApi.inspect_scheduled_job]] ```python inspect_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13285) **Parameter:** scheduled_job_id (`str`) : ID dari Job yang dijadwalkan. 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: ```python >>> from huggingface_hub import inspect_scheduled_job, create_scheduled_job >>> scheduled_job = create_scheduled_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], schedule="@hourly") >>> inspect_scheduled_job(scheduled_job_id=scheduled_job.id) ``` #### kernel_info[[huggingface_hub.HfApi.kernel_info]] ```python kernel_info(repo_id: str, revision: str | None = None, timeout: float | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3429) **Parameter:** repo_id (`str`) : Nama namespace (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 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.ModelInfo) Informasi repositori kernel. Dapatkan informasi tentang satu kernel tertentu di huggingface.co. #### list_accepted_access_requests[[huggingface_hub.HfApi.list_accepted_access_requests]] ```python list_accepted_access_requests(repo_id: str, repo_type: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10669) **Parameter:** repo_id (`str`) : id dari 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 diisi dengan jawaban pengguna. **Mengangkat:** `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 disetujui. 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.cancel_access_request) dan [reject_access_request()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.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: ```py >>> from huggingface_hub import list_accepted_access_requests >>> requests = list(list_accepted_access_requests("meta-llama/Llama-2-7b")) >>> len(requests) 411 >>> requests[0] [ AccessRequest( username='clem', request_id='655f3a1c9e6b2d4f8a7c1e05', fullname='Clem 🤗', email='***', timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc), status='accepted', fields=None, ), ... ] ``` #### list_bucket_tree[[huggingface_hub.HfApi.list_bucket_tree]] ```python list_bucket_tree(bucket_id: str, prefix: str | None = None, recursive: bool | None = None, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14301) **Parameter:** bucket_id (`str`) : ID dari bucket (mis. `"username/my-bucket"`). prefix (`str`, *opsional*) : Saring hasil ke file yang jalurnya diawali dengan prefiks 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.BucketFile) dan `BucketFolder` yang berisi informasi file dan direktori (path, dll.). Daftarkan file dalam bucket. Contoh: ```python >>> from huggingface_hub import list_bucket_tree >>> for file_info in list_bucket_tree(bucket_id="username/my-bucket"): ... print(file_info.path) >>> # Filter by prefix >>> for file_info in list_bucket_tree(bucket_id="username/my-bucket", prefix="models/"): ... print(file_info.path) ``` #### list_buckets[[huggingface_hub.HfApi.list_buckets]] ```python list_buckets(namespace: str | None = None, search: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14108) **Parameter:** namespace (`str`, *opsional*) : Daftar bucket di bawah namespace ini (pengguna atau organisasi). Secara default, menampilkan 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.BucketInfo). Daftarkan bucket di Hub di bawah namespace tertentu. Contoh: ```python >>> from huggingface_hub import list_buckets >>> for bucket in list_buckets(): # lists buckets in the user's namespace ... print(bucket) >>> for bucket in list_buckets(namespace="huggingface"): # lists buckets in the "huggingface" organization ... print(bucket) >>> for bucket in list_buckets(search="my-prefix"): # filter buckets by name ... print(bucket) ``` #### list_collections[[huggingface_hub.HfApi.list_collections]] ```python list_collections(owner: list[str] | str | None = None, item: list[str] | str | None = None, sort: CollectionSort_T | None = None, limit: int | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10096) **Parameter:** owner (`list[str]` atau `str`, *opsional*) : Saring berdasarkan nama pengguna pemilik. item (`list[str]` atau `str`, *opsional*) : Saring 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](/docs/huggingface_hub/v2.4.0/id/package_reference/collections#huggingface_hub.Collection). Daftarkan koleksi di Huggingface Hub, dengan beberapa filter tertentu. > [!WARNING] > Saat mendaftar koleksi, daftar item per koleksi dipangkas menjadi maksimal 4 item. Untuk mengambil semua item dari sebuah koleksi, Anda harus menggunakan [get_collection()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.get_collection). #### list_daily_papers[[huggingface_hub.HfApi.list_daily_papers]] ```python list_daily_papers(date: str | None = None, token: bool | str | None = None, week: str | None = None, month: str | None = None, submitter: str | None = None, sort: DailyPapersSort_T | None = None, p: int | None = None, limit: int | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11978) **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. Bawaan adalah 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: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> list(api.list_daily_papers(date="2025-10-29")) ``` #### list_dataset_parquet_files[[huggingface_hub.HfApi.list_dataset_parquet_files]] ```python list_dataset_parquet_files(repo_id: str, config: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2707) **Parameter:** repo_id (`str`) : ID repositori dataset (mis. `"username/dataset-name"`). config (`str`, *opsional*) : Saring berdasarkan nama konfigurasi/subset tertentu. Jika diberikan, hanya file parquet untuk konfigurasi 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](https://huggingface.co/docs/dataset-viewer/parquet). Metode ini mengembalikan daftar file parquet beserta URL, konfigurasi, split, dan ukurannya. Contoh: ```python >>> from huggingface_hub import list_dataset_parquet_files >>> list_dataset_parquet_files("lhoestq/demo1") >>> entries[0] DatasetParquetEntry(config='default', split='train', url='https://huggingface.co/...', size=5038) ``` #### list_datasets[[huggingface_hub.HfApi.list_datasets]] ```python list_datasets(filter: str | Iterable[str] | None = None, author: str | None = None, benchmark: Literal[True] | Literal['official'] | str | None = None, dataset_name: str | None = None, gated: bool | None = None, language_creators: str | list[str] | None = None, language: str | list[str] | None = None, multilinguality: str | list[str] | None = None, size_categories: str | list[str] | None = None, task_categories: str | list[str] | None = None, task_ids: str | list[str] | None = None, search: str | None = None, sort: DatasetSort_T | None = None, limit: int | None = None, expand: list[ExpandDatasetProperty_T] | None = None, full: bool | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2502) **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. Demi kompatibilitas di masa depan, juga bisa berupa string yang mewakili 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 berstatus gated atau tidak. Secara default, semua dataset dikembalikan. Jika `gated=True` diberikan, hanya dataset gated yang dikembalikan. Jika `gated=False` diberikan, 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 kurasi datanya, 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 berisi 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>> 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`: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() # List all datasets with "text" in their name >>> api.list_datasets(search="text") # List all datasets with "text" in their name made by google >>> api.list_datasets(search="text", author="google") ``` #### list_inference_catalog[[huggingface_hub.HfApi.list_inference_catalog]] ```python list_inference_catalog(accelerator: Literal['cpu', 'gpu', 'neuron'] | str | None = None, engine: Literal['llamacpp', 'sglang', 'tei', 'vllm'] | str | None = None, license: str | None = None, task: str | None = None, search: str | None = None, limit: int | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9587) **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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_inference_endpoint_from_catalog) untuk mendeploy model atau resep dari katalog. Contoh: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> catalog = api.list_inference_catalog(task="text-generation", accelerator="neuron") >>> [(model.repo_id, [recipe.id for recipe in model.recipes]) for model in catalog] [('meta-llama/Llama-3.1-8B-Instruct', ['sizzling-biryani-g4xsi1ac', 'artisanal-quinoa-yz9ynamx']), ...] ``` > [!WARNING] > `list_inference_catalog` bersifat eksperimental. API-nya dapat berubah di masa depan. Silakan berikan umpan balik jika Anda memiliki saran atau permintaan. #### list_inference_endpoints[[huggingface_hub.HfApi.list_inference_endpoints]] ```python list_inference_endpoints(namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9147) **Parameter:** namespace (`str`, *opsional*) : Namespace untuk mendaftar endpoint. Bawaan adalah pengguna saat ini. Atur ke `"*"` untuk mendaftar semua endpoint dari semua namespace (yaitu namespace pribadi dan semua organisasi yang pengguna tersebut ikuti). 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[InferenceEndpoint](/docs/huggingface_hub/v2.4.0/id/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint) Daftar semua endpoint inferensi untuk namespace yang diberikan. Mencantumkan semua endpoint inferensi untuk namespace yang diberikan. Contoh: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> api.list_inference_endpoints() [InferenceEndpoint(name='my-endpoint', ...), ...] ``` #### list_inference_endpoints_hardware[[huggingface_hub.HfApi.list_inference_endpoints_hardware]] ```python list_inference_endpoints_hardware(namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10038) **Parameter:** namespace (`str`, *opsional*) : Namespace yang kuota perangkat keras dan akseleratornya akan diuraikan. Secara default, 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). **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 tepat, sesuai yang diharapkan oleh [create_inference_endpoint()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_inference_endpoint), beserta harga dan kuota akselerator dari namespace. Contoh: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> hardware = api.list_inference_endpoints_hardware() >>> [hw.id for hw in hardware if hw.accelerator == "gpu" and hw.status == "available"] ['aws-us-east-1-nvidia-l4-x1', 'aws-us-east-1-nvidia-l4-x4', ...] ``` #### list_jobs[[huggingface_hub.HfApi.list_jobs]] ```python list_jobs(status: list[JobStage | str] | JobStage | str | None = None, labels: dict[str, str] | None = None, timeout: int | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12487) **Parameter:** status (`JobStage`, `str` atau `list`, *opsional*) : Hanya kembalikan Jobs dengan status yang diberikan, misalnya `"RUNNING"` atau `[JobStage.RUNNING, JobStage.SCHEDULING]`. Lihat [JobStage](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.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 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](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.JobInfo). Daftarkan compute Jobs pada infrastruktur Hugging Face. #### list_jobs_hardware[[huggingface_hub.HfApi.list_jobs_hardware]] ```python list_jobs_hardware(token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12535) **Mengembalikan:** `list[JobHardwareInfo]` Daftar konfigurasi perangkat keras yang tersedia. Daftarkan opsi hardware yang tersedia untuk Jobs pada infrastruktur Hugging Face. Contoh: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> hardware_list = api.list_jobs_hardware() >>> hardware_list[0] JobHardwareInfo(name='cpu-basic', pretty_name='CPU Basic', cpu='2 vCPU', ram='16 GB', ephemeral_storage='20 GB', accelerator=None, unit_cost_micro_usd=167, unit_cost_usd=0.000167, unit_label='minute') >>> hardware_list[0].name 'cpu-basic' # Filter GPU options >>> gpu_hardware = [hw for hw in hardware_list if hw.accelerator is not None] >>> gpu_hardware[0].accelerator.model 'T4' ``` #### list_lfs_files[[huggingface_hub.HfApi.list_lfs_files]] ```python list_lfs_files(repo_id: str, repo_type: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4426) **Parameter:** repo_id (`str`) : Repositori tempat Anda membuat daftar file LFS. repo_type (`str`, *opsional*) : Tipe 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 akhirnya membersihkan file besar dengan [permanently_delete_lfs_files()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.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: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() >>> lfs_files = api.list_lfs_files("username/my-cool-repo") # Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`. # e.g. select only LFS files in the "checkpoints" folder >>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/")) # Permanently delete LFS files >>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete) ``` #### list_liked_repos[[huggingface_hub.HfApi.list_liked_repos]] ```python list_liked_repos(user: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2988) **Parameter:** user (`str`, *opsional*) : Nama pengguna yang suka (likes) 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.UserLikes) objek yang berisi nama pengguna dan 3 daftar ID repo (1 untuk model, 1 untuk dataset, dan 1 untuk Spaces). **Mengangkat:** ``ValueError`` - [`ValueError`](https://docs.python.org/3/library/exceptions.html#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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.unlike). Contoh: ```python >>> from huggingface_hub import list_liked_repos >>> likes = list_liked_repos("julien-c") >>> likes.user "julien-c" >>> likes.models ["osanseviero/streamlit_1.15", "Xhaheen/ChatGPT_HF", ...] ``` #### list_models[[huggingface_hub.HfApi.list_models]] ```python list_models(filter: str | Iterable[str] | None = None, author: str | None = None, apps: str | list[str] | None = None, gated: bool | None = None, inference: Literal['warm'] | None = None, inference_provider: Literal['all'] | PROVIDER_T | list[PROVIDER_T] | None = None, trained_dataset: str | list[str] | None = None, search: str | None = None, pipeline_tag: str | None = None, num_parameters: str | None = None, emissions_thresholds: tuple[float, float] | None = None, sort: ModelSort_T | None = None, limit: int | None = None, expand: list[ExpandModelProperty_T] | None = None, full: bool | None = None, cardData: bool = False, fetch_config: bool = False, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2310) **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` diberikan, hanya model gated yang dikembalikan. Jika `gated=False` diberikan, 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*) : Menyaring 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*) : `Tuple` 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*) : Batasan 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 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 akan mengambil metadata untuk model tersebut juga. 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 dalam `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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.ModelInfo). Daftarkan model yang dihosting di Huggingface Hub, dengan beberapa filter tertentu. Contoh: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() # List all models >>> api.list_models() # List text classification models >>> api.list_models(filter="text-classification") # List models from the KerasHub library >>> api.list_models(filter="keras-hub") # List models served by Cohere >>> api.list_models(inference_provider="cohere") # List models with "bert" in their name >>> api.list_models(search="bert") # List models with "bert" in their name and pushed by google >>> api.list_models(search="bert", author="google") # List models with 6B to 128B parameters >>> api.list_models(num_parameters="min:6B,max:128B", sort="likes") ``` #### list_organization_followers[[huggingface_hub.HfApi.list_organization_followers]] ```python list_organization_followers(organization: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11774) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.User) dengan pengikut organisasi. **Mengangkat:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Jika organisasi tidak ada di Hub. Daftarkan pengikut sebuah organisasi di Hub. #### list_organization_members[[huggingface_hub.HfApi.list_organization_members]] ```python list_organization_members(organization: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11803) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.User) dengan anggota organisasi. **Mengangkat:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Jika organisasi tidak ada di Hub. Daftar anggota organisasi di Hub. #### list_papers[[huggingface_hub.HfApi.list_papers]] ```python list_papers(query: str | None = None, limit: int | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11887) **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 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[PaperInfo]` iterable dari objek `huggingface_hub.hf_api.PaperInfo`. Daftarkan paper harian di Hugging Face Hub berdasarkan kueri pencarian. Contoh: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() # List all papers with "attention" in their title >>> api.list_papers(query="attention") ``` #### list_pending_access_requests[[huggingface_hub.HfApi.list_pending_access_requests]] ```python list_pending_access_requests(repo_id: str, repo_type: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10604) **Parameter:** repo_id (`str`) : id dari 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 diisi dengan jawaban pengguna. **Mengangkat:** `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 permintaannya belum diproses. Jika mode persetujuan adalah otomatis, daftar ini seharusnya kosong. Permintaan yang tertunda dapat diterima atau ditolak menggunakan [accept_access_request()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.accept_access_request) dan [reject_access_request()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.reject_access_request). Untuk informasi lebih lanjut tentang repositori bergerbang, lihat https://huggingface.co/docs/hub/models-gated. Contoh: ```py >>> from huggingface_hub import list_pending_access_requests, accept_access_request # List pending requests >>> requests = list(list_pending_access_requests("meta-llama/Llama-2-7b")) >>> len(requests) 411 >>> requests[0] [ AccessRequest( username='clem', request_id='655f3a1c9e6b2d4f8a7c1e05', fullname='Clem 🤗', email='***', timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc), status='pending', fields=None, ), ... ] # Accept Clem's request >>> accept_access_request("meta-llama/Llama-2-7b", "clem") ``` #### list_rejected_access_requests[[huggingface_hub.HfApi.list_rejected_access_requests]] ```python list_rejected_access_requests(repo_id: str, repo_type: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10732) **Parameter:** repo_id (`str`) : id dari 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 diisi dengan jawaban pengguna. **Mengangkat:** `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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.accept_access_request) dan [cancel_access_request()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.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: ```py >>> from huggingface_hub import list_rejected_access_requests >>> requests = list(list_rejected_access_requests("meta-llama/Llama-2-7b")) >>> len(requests) 411 >>> requests[0] [ AccessRequest( username='clem', request_id='655f3a1c9e6b2d4f8a7c1e05', fullname='Clem 🤗', email='***', timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc), status='rejected', fields=None, ), ... ] ``` #### list_repo_commits[[huggingface_hub.HfApi.list_repo_commits]] ```python list_repo_commits(repo_id: str, repo_type: str | None = None, token: bool | str | None = None, revision: str | None = None, formatted: bool = False) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4183) **Parameter:** repo_id (`str`) : Nama namespace (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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.GitCommitInfo)] daftar objek yang berisi informasi tentang commit untuk repo di Hub. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.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: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() # Commits are sorted by date (last commit first) >>> initial_commit = api.list_repo_commits("gpt2")[-1] # Initial commit is always a system commit containing the `.gitattributes` file. >>> initial_commit GitCommitInfo( commit_id='9b865efde13a30c13e0a33e536cf3e4a5a9d71d8', authors=['system'], created_at=datetime.datetime(2019, 2, 18, 10, 36, 15, tzinfo=datetime.timezone.utc), title='initial commit', message='', formatted_title=None, formatted_message=None ) # Create an empty branch by deriving from initial commit >>> api.create_branch("gpt2", branch="new_empty_branch", revision=initial_commit.commit_id) ``` #### list_repo_files[[huggingface_hub.HfApi.list_repo_files]] ```python list_repo_files(repo_id: str, revision: str | None = None, repo_type: str | None = None, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3829) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. revision (`str`, *opsional*) : Revisi repositori yang menjadi sumber pengambilan 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[[huggingface_hub.HfApi.list_repo_likers]] ```python list_repo_likers(repo_id: str, repo_type: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3105) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.User). Daftarkan semua pengguna yang menyukai repositori tertentu di hugging Face Hub. Lihat juga [list_liked_repos()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_liked_repos). #### list_repo_refs[[huggingface_hub.HfApi.list_repo_refs]] ```python list_repo_refs(repo_id: str, repo_type: str | None = None, include_pull_requests: bool = False, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4111) **Parameter:** repo_id (`str`) : Nama namespace (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 referensi dari pull request dalam daftar. 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:** [GitRefs](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.GitRefs) objek yang berisi semua informasi tentang cabang dan tag untuk repositori di Hub. Dapatkan daftar ref dari repo tertentu (baik tag maupun cabang). Contoh: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() >>> api.list_repo_refs("gpt2") GitRefs(branches=[GitRefInfo(name='main', ref='refs/heads/main', target_commit='e7da7f221d5bf496a48136c0cd264e630fe9fcc8')], converts=[], tags=[]) >>> api.list_repo_refs("bigcode/the-stack", repo_type='dataset') GitRefs( branches=[ GitRefInfo(name='main', ref='refs/heads/main', target_commit='18edc1591d9ce72aa82f56c4431b3c969b210ae3'), GitRefInfo(name='v1.1.a1', ref='refs/heads/v1.1.a1', target_commit='f9826b862d1567f3822d3d25649b0d6d22ace714') ], converts=[], tags=[ GitRefInfo(name='v1.0', ref='refs/tags/v1.0', target_commit='c37a8cd1e382064d8aced5e05543c5f7753834da') ] ) ``` #### list_repo_tree[[huggingface_hub.HfApi.list_repo_tree]] ```python list_repo_tree(repo_id: str, path_in_repo: str | None = None, recursive: bool = False, expand: bool = False, revision: str | None = None, repo_type: str | None = None, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3866) **Parameter:** repo_id (`str`) : Nama namespace (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*, defaultnya `False`) : Apakah akan mendaftar file dan folder pohon secara rekursif. expand (`bool`, *opsional*, defaultnya `False`) : Apakah akan mengambil informasi lebih lanjut tentang file dan folder di dalam tree (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 yang digunakan untuk mengambil pohon. Secara default menggunakan cabang `"main"`. repo_type (`str`, *opsional*) : Jenis repositori tempat mengambil pohon (`"model"`, `"dataset"`, `"space"` atau `"kernel"`). 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[Union[RepoFile, RepoFolder]]` Informasi tentang file dan folder pohon, sebagai iterable dari objek [RepoFile](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.RepoFile) dan `RepoFolder`. Urutan file dan folder tidak dijamin. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) atau `~utils.RemoteEntryNotFoundError` - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.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. ```py >>> from huggingface_hub import list_repo_tree >>> repo_tree = list_repo_tree("lysandre/arxiv-nlp") >>> repo_tree >>> 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) ```py >>> from huggingface_hub import list_repo_tree >>> repo_tree = list_repo_tree("prompthero/openjourney-v4", expand=True) >>> list(repo_tree) [ RepoFolder( path='feature_extractor', tree_id='aa536c4ea18073388b5b0bc791057a7296a00398', last_commit={ 'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190', 'title': 'Upload diffusers weights (#48)', 'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc) } ), RepoFolder( path='safety_checker', tree_id='65aef9d787e5557373fdf714d6c34d4fcdd70440', last_commit={ 'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190', 'title': 'Upload diffusers weights (#48)', 'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc) } ), RepoFile( path='model_index.json', size=582, blob_id='d3d7c1e8c3e78eeb1640b8e2041ee256e24c9ee1', lfs=None, last_commit={ 'oid': 'b195ed2d503f3eb29637050a886d77bd81d35f0e', 'title': 'Fix deprecation warning by changing `CLIPFeatureExtractor` to `CLIPImageProcessor`. (#54)', 'date': datetime.datetime(2023, 5, 15, 21, 41, 59, tzinfo=datetime.timezone.utc) }, security={ 'safe': True, 'av_scan': {'virusFound': False, 'virusNames': None}, 'pickle_import_scan': None } ) ... ] ``` #### list_scheduled_jobs[[huggingface_hub.HfApi.list_scheduled_jobs]] ```python list_scheduled_jobs(labels: dict[str, str] | None = None, timeout: int | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13231) **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 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[[huggingface_hub.HfApi.list_space_templates]] ```python list_space_templates(token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4548) **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`. **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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_repo) untuk membuat Space baru dari template tersebut. Contoh: ```py >>> from huggingface_hub import list_space_templates >>> templates = list_space_templates() >>> templates[0] SpaceTemplate(name='Streamlit', repo_id='streamlit/streamlit-template-space', sdk='docker', preferred_private=False) ``` #### list_spaces[[huggingface_hub.HfApi.list_spaces]] ```python list_spaces(filter: str | Iterable[str] | None = None, author: str | None = None, search: str | None = None, datasets: str | Iterable[str] | None = None, models: str | Iterable[str] | None = None, linked: bool = False, sort: SpaceSort_T | None = None, limit: int | None = None, expand: list[ExpandSpaceProperty_T] | None = None, full: bool | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2774) **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*) : Batasan 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 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 bidang `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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.SpaceInfo). Daftarkan ruang yang dihosting di Huggingface Hub, dengan beberapa filter tertentu. #### list_spaces_hardware[[huggingface_hub.HfApi.list_spaces_hardware]] ```python list_spaces_hardware(token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8260) **Mengembalikan:** `list[JobHardwareInfo]` Daftar konfigurasi perangkat keras yang tersedia. Daftarkan opsi hardware yang tersedia untuk Spaces. Contoh: ```python >>> from huggingface_hub import list_spaces_hardware >>> hardware_list = list_spaces_hardware() >>> hardware_list[0] JobHardwareInfo(name='cpu-basic', pretty_name='CPU Basic', cpu='2 vCPU', ram='16 GB', ...) >>> hardware_list[0].name 'cpu-basic' ``` #### list_user_followers[[huggingface_hub.HfApi.list_user_followers]] ```python list_user_followers(username: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11831) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.User) yang berisi pengikut dari pengguna tersebut. **Mengangkat:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Jika pengguna tidak ada di Hub. Dapatkan daftar pengikut pengguna di Hub. #### list_user_following[[huggingface_hub.HfApi.list_user_following]] ```python list_user_following(username: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11859) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.User) berisi pengguna yang diikuti oleh pengguna tersebut. **Mengangkat:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Jika pengguna tidak ada di Hub. Dapatkan daftar pengguna yang diikuti oleh pengguna di Hub. #### list_user_repos[[huggingface_hub.HfApi.list_user_repos]] ```python list_user_repos(namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3065) **Parameter:** namespace (`str`, *opsional*) : Nama organisasi. Jika tidak disediakan, akan menampilkan repositori untuk pengguna yang terautentikasi. token (`bool` atau `str`, *opsional*) : Token akses pengguna yang valid. Secara bawaan 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: ```python >>> from huggingface_hub import list_user_repos >>> repos = list(list_user_repos()) >>> repos[0] RepoStorageInfo(id='username/my-model', type='model', ...) >>> # List repos from an organization >>> repos = list(list_user_repos(namespace="my-org")) ``` #### list_webhooks[[huggingface_hub.HfApi.list_webhooks]] ```python list_webhooks(token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11125) **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`. **Mengembalikan:** `list[WebhookInfo]` Daftar objek info webhook. Daftarkan semua webhook yang dikonfigurasi. Contoh: ```python >>> from huggingface_hub import list_webhooks >>> webhooks = list_webhooks() >>> len(webhooks) 2 >>> webhooks[0] WebhookInfo( id="654bbbc16f2ec14d77f109cc", watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")], url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548", secret="my-secret", domains=["repo", "discussion"], disabled=False, ) ``` #### merge_pull_request[[huggingface_hub.HfApi.merge_pull_request]] ```python merge_pull_request(repo_id: str, discussion_num: int, token: bool | str | None = None, comment: str | None = None, repo_type: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7830) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. discussion_num (`int`) : Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif yang ketat. 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](/docs/huggingface_hub/v2.4.0/id/package_reference/community#huggingface_hub.DiscussionStatusChange) peristiwa perubahan status Menggabungkan Pull Request. > [!TIP] > Membuang kesalahan berikut: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) jika API HuggingFace mengembalikan error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) jika nilai beberapa parameter tidak valid - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repository yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repository tidak ada, atau karena repository disetel ke `private` dan Anda tidak memiliki akses. #### model_info[[huggingface_hub.HfApi.model_info]] ```python model_info(repo_id: str, revision: str | None = None, timeout: float | None = None, securityStatus: bool | None = None, files_metadata: bool = False, expand: list[ExpandModelProperty_T] | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3144) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. revision (`str`, *opsional*) : Revisi repositori model yang menjadi sumber pengambilan informasi. timeout (`float`, *opsional*) : Apakah akan mengatur batas waktu untuk permintaan ke Hub. securityStatus (`bool`, *opsional*) : Apakah akan mengambil status keamanan dari repositori model juga. Status keamanan akan dikembalikan di bidang `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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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. > [!TIP] > Membuang kesalahan berikut: > > - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena disetel ke `private` dan Anda tidak memiliki akses. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) Jika revisi yang akan diunduh tidak dapat ditemukan. #### move_bucket[[huggingface_hub.HfApi.move_bucket]] ```python move_bucket(from_id: str, to_id: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14199) **Parameter:** from_id (`str`) : Nama ruang nama (pengguna atau organisasi) dan nama bucket yang dipisahkan oleh `/`. Pengidentifikasi bucket asli (mis. `"username/my-bucket"`). to_id (`str`) : Nama ruang nama (pengguna atau organisasi) dan nama bucket yang dipisahkan oleh `/`. Pengidentifikasi 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`. **Mengangkat:** `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: ```python >>> from huggingface_hub import move_bucket >>> # Rename a bucket within the same namespace >>> move_bucket(from_id="username/old-name", to_id="username/new-name") >>> # Transfer a bucket to an organization >>> move_bucket(from_id="username/my-bucket", to_id="my-org/my-bucket") ``` #### move_repo[[huggingface_hub.HfApi.move_repo]] ```python move_repo(from_id: str, to_id: str, repo_type: str | None = None, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4918) **Parameter:** from_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. Identifikasi repository asli. to_id (`str`) : Nama 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. > [!TIP] > Membuang kesalahan berikut: > > - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin terjadi karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke `private` dan Anda tidak memiliki akses. #### paper_info[[huggingface_hub.HfApi.paper_info]] ```python paper_info(id: str) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11938) **Parameter:** id (`str`, **opsional**) : id ArXiv dari makalah. **Mengembalikan:** `PaperInfo` Objek `PaperInfo`. **Mengangkat:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Jika paper tidak ada di Hub. Dapatkan informasi untuk sebuah paper di Hub. #### parse_safetensors_file_metadata[[huggingface_hub.HfApi.parse_safetensors_file_metadata]] ```python parse_safetensors_file_metadata(repo_id: str, filename: str, repo_type: str | None = None, revision: str | None = None, token: bool | str | None = None, timeout: float | None = 10) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6882) **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 untuk 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. **Mengangkat:** `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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.get_safetensors_metadata). Untuk detail lebih lanjut mengenai format safetensors, lihat https://huggingface.co/docs/safetensors/index#format. #### pause_inference_endpoint[[huggingface_hub.HfApi.pause_inference_endpoint]] ```python pause_inference_endpoint(name: str, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9922) **Parameter:** name (`str`) : Nama Inference Endpoint yang akan dijeda. namespace (`str`, *opsional*) : Namespace tempat Inference Endpoint berada. Secara default, namespace ini adalah 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](/docs/huggingface_hub/v2.4.0/id/package_reference/inference_endpoints#huggingface_hub.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.resume_inference_endpoint). Hal ini berbeda dengan menskalakan Inference Endpoint menjadi nol menggunakan [scale_to_zero_inference_endpoint()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.pause_inference_endpoint). #### pause_space[[huggingface_hub.HfApi.pause_space]] ```python pause_space(repo_id: str, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8419) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Informasi runtime tentang Space Anda, termasuk `stage=PAUSED` dan hardware yang diminta. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) atau [BadRequestError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.BadRequestError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika Space Anda tidak ditemukan (error 404). Kemungkinan besar repo_id salah atau Space Anda bersifat privat tetapi Anda belum terautentikasi. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.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](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.BadRequestError) -- Jika Space Anda adalah static Space. Static Spaces selalu berjalan dan tidak pernah ditagih. Jika Anda ingin menyembunyikan static Space, 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.restart_space) dan buka halaman pengaturan Space Anda. Untuk detail lebih lanjut, silakan kunjungi [dokumentasi](https://huggingface.co/docs/hub/spaces-gpus#pause). #### permanently_delete_lfs_files[[huggingface_hub.HfApi.permanently_delete_lfs_files]] ```python permanently_delete_lfs_files(repo_id: str, lfs_files: Iterable[LFSFileInfo], rewrite_history: bool = True, repo_type: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4480) **Parameter:** repo_id (`str`) : Repositori tempat Anda membuat daftar file LFS. lfs_files (`Iterable[LFSFileInfo]`) : Sebuah iterable dari item `LFSFileInfo` untuk dihapus secara permanen dari repo. Gunakan [list_lfs_files()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_lfs_files) untuk mendaftar semua file LFS dari sebuah repo. rewrite_history (`bool`, *opsional*, default ke `True`) : Apakah akan menulis ulang riwayat repositori untuk menghapus penunjuk file yang merujuk ke file LFS yang dihapus (disarankan). repo_type (`str`, *opsional*) : Tipe 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. > [!WARNING] > 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: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() >>> lfs_files = api.list_lfs_files("username/my-cool-repo") # Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`. # e.g. select only LFS files in the "checkpoints" folder >>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/")) # Permanently delete LFS files >>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete) ``` #### preupload_lfs_files[[huggingface_hub.HfApi.preupload_lfs_files]] ```python preupload_lfs_files(repo_id: str, additions: Iterable[CommitOperationAdd], token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, create_pr: bool | None = None, num_threads: int = 5, free_memory: bool = True, gitignore_content: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L5311) **Parameter:** repo_id (`str`) : Repositori tempat Anda akan meng-commit file, misalnya: `"username/custom_transformers"`. additions (`Iterable` dari [CommitOperationAdd](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.CommitOperationAdd)) : Daftar file yang akan diunggah. Peringatan: objek dalam daftar ini akan dimutasi untuk menyertakan informasi terkait 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 untuk 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. Bawaan adalah 5. Mengaturnya ke 2 berarti paling banyak 2 file akan diunggah secara bersamaan. free_memory (`bool`, *opsional*, defaultnya `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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.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. > [!WARNING] > Ini adalah metode untuk pengguna tingkat lanjut. Anda tidak perlu memanggilnya secara langsung untuk membuat commit biasa. Gunakan [create_commit()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_commit) secara langsung sebagai gantinya. > [!WARNING] > 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 ke [create_commit()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_commit). Jika Anda tidak ingin menghapus konten yang terlampir dari objek operasi commit, lewati `free_memory=False`. Contoh: ```py >>> from huggingface_hub import CommitOperationAdd, preupload_lfs_files, create_commit, create_repo >>> repo_id = create_repo("test_preupload").repo_id # Generate and preupload LFS files one by one >>> operations = [] # List of all `CommitOperationAdd` objects that will be generated >>> for i in range(5): ... content = ... # generate binary content ... addition = CommitOperationAdd(path_in_repo=f"shard_{i}_of_5.bin", path_or_fileobj=content) ... preupload_lfs_files(repo_id, additions=[addition]) # upload + free memory ... operations.append(addition) # Create commit >>> create_commit(repo_id, operations=operations, commit_message="Commit all shards") ``` #### read_paper[[huggingface_hub.HfApi.read_paper]] ```python read_paper(id: str) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11958) **Parameter:** id (`str`) : id ArXiv dari makalah. **Mengembalikan:** `str` Konten halaman paper sebagai markdown. **Mengangkat:** `HfHubHTTPError` - `HfHubHTTPError` -- HTTP 404 Jika paper tidak ada di Hub. Dapatkan konten markdown dari halaman paper di Hub. #### reject_access_request[[huggingface_hub.HfApi.reject_access_request]] ```python reject_access_request(repo_id: str, user: str | None = None, request_id: str | None = None, repo_type: str | None = None, rejection_reason: str | None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10925) **Parameter:** repo_id (`str`) : id dari 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 agar 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`. **Mengangkat:** `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 tersebut. Permintaan yang ditolak dapat diterima atau dibatalkan kapan saja menggunakan [accept_access_request()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.accept_access_request) dan [cancel_access_request()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.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[[huggingface_hub.HfApi.rename_discussion]] ```python rename_discussion(repo_id: str, discussion_num: int, new_title: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L7689) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. discussion_num (`int`) : Nomor Discussion atau Pull Request. Harus berupa bilangan bulat positif yang ketat. 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](/docs/huggingface_hub/v2.4.0/id/package_reference/community#huggingface_hub.DiscussionTitleChange) peristiwa perubahan judul Mengubah nama Diskusi. Contoh: ```python >>> new_title = "New title, fixing a typo" >>> HfApi().rename_discussion( ... repo_id="username/repo_name", ... discussion_num=34, ... new_title=new_title ... ) # DiscussionTitleChange(id='deadbeef0000000', type='title-change', ...) ``` > [!TIP] > Membuang kesalahan berikut: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) jika API HuggingFace mengembalikan error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) jika nilai beberapa parameter tidak valid - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repository yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repository tidak ada, atau karena repository disetel ke `private` dan Anda tidak memiliki akses. #### repo_exists[[huggingface_hub.HfApi.repo_exists]] ```python repo_exists(repo_id: str, repo_type: str | None = None, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3677) **Parameter:** repo_id (`str`) : Nama namespace (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`. **Mengembalikan:** True jika repositori ada, False jika tidak. Memeriksa apakah sebuah repositori ada di Hugging Face Hub. Contoh: ```py >>> from huggingface_hub import repo_exists >>> repo_exists("google/gemma-7b") True >>> repo_exists("google/not-a-repo") False ``` #### repo_info[[huggingface_hub.HfApi.repo_info]] ```python repo_info(repo_id: str, revision: str | None = None, repo_type: str | None = None, timeout: float | None = None, files_metadata: bool = False, expand: ExpandModelProperty_T | ExpandDatasetProperty_T | ExpandSpaceProperty_T | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3469) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. revision (`str`, *opsional*) : Revisi repositori yang menjadi sumber pengambilan 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 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.model_info), [dataset_info()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.dataset_info) atau [space_info()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.DatasetInfo), [huggingface_hub.hf_api.ModelInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.ModelInfo) atau [huggingface_hub.hf_api.SpaceInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.SpaceInfo). Dapatkan objek info untuk repositori tertentu dari tipe tertentu. > [!TIP] > Membuang kesalahan berikut: > > - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena disetel ke `private` dan Anda tidak memiliki akses. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) Jika revisi yang akan diunduh tidak dapat ditemukan. #### request_space_hardware[[huggingface_hub.HfApi.request_space_hardware]] ```python request_space_hardware(repo_id: str, hardware: SpaceHardware, token: bool | str | None = None, sleep_time: int | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8323) **Parameter:** repo_id (`str`) : ID repo yang akan diperbarui. Contoh: `"bigcode/in-the-stack"`. hardware (`str` atau [SpaceHardware](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.SpaceHardware)) : Perangkat keras untuk menjalankan Space. 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 default 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](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Informasi runtime tentang sebuah Space, termasuk tahap dan perangkat keras Space. Minta perangkat keras baru untuk sebuah Space. > [!TIP] > Anda juga dapat meminta perangkat keras secara langsung saat membuat repo Space! Lihat [create_repo()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_repo) untuk detailnya. #### rerun_job[[huggingface_hub.HfApi.rerun_job]] ```python rerun_job(job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12728) **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 adalah token yang disimpan secara lokal. **Mengembalikan:** [JobInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.JobInfo) Job yang baru dimulai. Jalankan Job baru menggunakan spesifikasi Job yang ada, termasuk pengaturan retry dan resource-nya. #### resolve_revision[[huggingface_hub.HfApi.resolve_revision]] ```python resolve_revision(repo_id: str, repo_type: str | None = None, revision: str | None = None, cache_dir: str | Path | None = None, local_files_only: bool = False, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3544) **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 di-resolve. Bisa berupa nama branch, tag, PR ref, atau commit hash. Defaultnya adalah branch default. Jika [ResolvedRevision](/docs/huggingface_hub/v2.4.0/id/package_reference/file_download#huggingface_hub.ResolvedRevision) diberikan, nilai tersebut dikembalikan apa adanya - kecuali jika di-resolve terhadap repo lain, di mana revisi yang awalnya diminta akan di-resolve ulang. cache_dir (`str`, `Path`, *opsional*) : Path ke folder tempat file cache disimpan. Default ke nilai `HF_HUB_CACHE`. local_files_only (`bool`, *opsional*, defaultnya `False`) : Jika `True`, selesaikan revisi hanya 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](/docs/huggingface_hub/v2.4.0/id/package_reference/file_download#huggingface_hub.ResolvedRevision) Subkelas `str` yang menyimpan baik revisi yang diminta maupun hash commit yang dihasilkannya. **Mengangkat:** [RevisionResolutionError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionResolutionError) atau [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) atau [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) - [RevisionResolutionError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionResolutionError) -- Jika revisi tidak dapat diselesaikan: Hub tidak dapat dihubungi dan tidak ada yang di-cache secara lokal. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Jika revisi tidak ada di Hub. - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.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](/docs/huggingface_hub/v2.4.0/id/package_reference/file_download#huggingface_hub.ResolvedRevision) yang dikembalikan menjamin bahwa setiap panggilan berikutnya menargetkan commit yang persis sama, bahkan jika repo diperbarui di sela-selanya. Hal ini juga menghemat panggilan HTTP, karena unduhan yang dilakukan dengan hash commit dapat disajikan dari cache lokal tanpa perlu menghubungi Hub. Pemetaan `revision` -> `commit hash` disimpan di cache 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. > [!TIP] > Jika Anda hanya perlu mengunduh snapshot repo lengkap, satu panggilan [snapshot_download()](/docs/huggingface_hub/v2.4.0/id/package_reference/file_download#huggingface_hub.snapshot_download) sudah cukup dan sudah melakukan hal yang tepat. `resolve_revision` hanya berguna saat mengunduh file secara terpisah. Contoh: ```py >>> from huggingface_hub import hf_hub_download, resolve_revision >>> revision = resolve_revision("openai-community/gpt2") >>> revision ResolvedRevision(initial=None, resolved='607a30d783dfa663caf39e06633721c8d4cfcd7e') # Pass it around: every download is pinned to the same commit >>> config = hf_hub_download("openai-community/gpt2", "config.json", revision=revision) >>> weights = hf_hub_download("openai-community/gpt2", "model.safetensors", revision=revision) ``` #### restart_space[[huggingface_hub.HfApi.restart_space]] ```python restart_space(repo_id: str, token: bool | str | None = None, factory_reboot: bool = False) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8542) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Informasi runtime tentang Space Anda. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) atau [BadRequestError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.BadRequestError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika Space Anda tidak ditemukan (error 404). Kemungkinan besar repo_id salah atau Space Anda bersifat privat tetapi Anda belum terautentikasi. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.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](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.BadRequestError) -- Jika Space Anda adalah static Space. Static Spaces selalu berjalan dan tidak pernah ditagih. Jika Anda ingin menyembunyikan static Space, 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.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](https://huggingface.co/docs/hub/spaces-gpus#pause). #### resume_inference_endpoint[[huggingface_hub.HfApi.resume_inference_endpoint]] ```python resume_inference_endpoint(name: str, namespace: str | None = None, running_ok: bool = True, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9957) **Parameter:** name (`str`) : Nama Inference Endpoint yang akan dilanjutkan. namespace (`str`, *opsional*) : Namespace tempat Inference Endpoint berada. Secara default, namespace ini adalah milik pengguna saat ini. running_ok (`bool`, *opsional*) : Jika `True`, metode tidak akan melempar kesalahan jika Inference Endpoint sudah berjalan. Bawaan 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](/docs/huggingface_hub/v2.4.0/id/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint) informasi tentang Inference Endpoint yang dilanjutkan. Lanjutkan Endpoint Inferensi. Untuk kenyamanan, Anda juga dapat melanjutkan Inference Endpoint menggunakan [InferenceEndpoint.resume()](/docs/huggingface_hub/v2.4.0/id/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint.resume). #### resume_scheduled_job[[huggingface_hub.HfApi.resume_scheduled_job]] ```python resume_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13384) **Parameter:** scheduled_job_id (`str`) : ID dari Job yang dijadwalkan. 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. Resume (unpause) Job komputasi terjadwal di infrastruktur Hugging Face. #### revision_exists[[huggingface_hub.HfApi.revision_exists]] ```python revision_exists(repo_id: str, revision: str, repo_type: str | None = None, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3721) **Parameter:** repo_id (`str`) : Nama namespace (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`. **Mengembalikan:** True jika repositori dan revisi ada, False jika tidak. Memeriksa apakah revisi tertentu ada di repositori pada Hugging Face Hub. Contoh: ```py >>> from huggingface_hub import revision_exists >>> revision_exists("google/gemma-7b", "float16") True >>> revision_exists("google/gemma-7b", "not-a-revision") False ``` #### run_as_future[[huggingface_hub.HfApi.run_as_future]] ```python run_as_future(fn: Callable[..., R], *args, **kwargs) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2178) **Parameter:** fn (`Callable`) : Metode yang akan dijalankan di latar belakang. - ***args,** **kwargs : Argumen yang digunakan untuk memanggil metode. **Mengembalikan:** `Future` sebuah instance [Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects) 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](https://docs.python.org/3/library/concurrent.futures.html#threadpoolexecutor) Anda sendiri. Catatan: Metode yang paling sering digunakan seperti [upload_file()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.upload_file), [upload_folder()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.upload_folder) dan [create_commit()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.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, tetapi lebih ringkas. Contoh: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() >>> future = api.run_as_future(api.whoami) # instant >>> future.done() False >>> future.result() # wait until complete and return result (...) >>> future.done() True ``` #### run_job[[huggingface_hub.HfApi.run_job]] ```python run_job(image: str, command: list[str], env: dict[str, Any] | None = None, secrets: dict[str, Any] | None = None, flavor: JobHardware | str | None = None, timeout: int | float | str | None = None, attempts: int | None = None, name: str | None = None, labels: dict[str, str] | None = None, volumes: list[Volume] | None = None, expose: list[int] | None = None, expose_public: list[int] | None = None, ssh: bool = False, network_group: str | None = None, network_aliases: list[str] | None = None, resource_group_id: str | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12122) **Parameter:** image (`str`) : Citra Docker yang akan digunakan. Contoh: `"ubuntu"`, `"python:3.12"`, `"pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"`. Contoh dengan citra dari Space: `"hf.co/spaces/lhoestq/duckdb"`. command (`list[str]`) : Perintah yang akan dijalankan. Contoh: `["echo", "hello"]`. env (`dict[str, Any]`, *opsional*) : Mendefinisikan variabel lingkungan untuk Job. secrets (`dict[str, Any]`, *opsional*) : Mendefinisikan variabel lingkungan rahasia untuk Job. flavor (`str`, *opsional*) : Flavor untuk perangkat keras. Lihat `JobHardware` untuk nilai yang mungkin. Bawaan 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. Nilai 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 dikirim bersamaan dengan kunci `name` di `labels`. Nama tidak harus unik. Secara default, menggunakan nama yang 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](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.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://--8000.hf.jobs`). Akses selalu memerlukan token HF dengan akses baca ke 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 di `expose`. ssh (`bool`, *opsional*) : Jika True, kontainer dari job tersebut dapat dijangkau melalui SSH di URL yang diberikan oleh `job.status.ssh_url` (misalnya `ssh @ssh.hf.jobs`, atau `hf jobs ssh ` 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 mengakses di setiap port. Di dalam setiap anggota, `HF_NETWORK_GROUP_HOSTNAME` akan teresolusi 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}`. 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 grup sumber daya tempat Job akan dibuat. Digunakan untuk mengontrol akses ke sumber daya dalam organisasi dan untuk fitur atribusi biaya/batas pengeluaran. Jika tidak disediakan, Job akan dibuat di luar grup sumber daya 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: ```python >>> from huggingface_hub import run_job >>> run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"]) ``` Jalankan Tugas GPU: ```python >>> from huggingface_hub import run_job >>> image = "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel" >>> command = ["python", "-c", "import torch; print(f'This code ran with the following GPU: {torch.cuda.get_device_name()}')"] >>> run_job(image=image, command=command, flavor="a10g-small") ``` Jalankan Job dengan volume: ```python >>> from huggingface_hub import Volume, run_job >>> dataset_volume = Volume(type="dataset", source="HuggingFaceFW/fineweb", mount_path="/data") >>> output_bucket_volume = Volume(type="bucket", source="username/my-bucket", mount_path="/output") >>> image = "duckdb/duckdb" >>> command = ["duckdb", "-c", "COPY (SELECT * FROM '/data/**/*.parquet' LIMIT 5) TO '/output/first-rows.parquet'"] >>> run_job(image=image, command=command, volumes=[dataset_volume, output_bucket_volume]) ``` #### run_uv_job[[huggingface_hub.HfApi.run_uv_job]] ```python run_uv_job(script: str, script_args: list[str] | None = None, dependencies: list[str] | None = None, python: str | None = None, image: str | None = None, env: dict[str, Any] | None = None, secrets: dict[str, Any] | None = None, flavor: JobHardware | str | None = None, timeout: int | float | str | None = None, attempts: int | None = None, name: str | None = None, labels: dict[str, str] | None = None, volumes: list[Volume] | None = None, expose: list[int] | None = None, expose_public: list[int] | None = None, ssh: bool = False, network_group: str | None = None, network_aliases: list[str] | None = None, resource_group_id: str | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12871) **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*, defaultnya "ghcr.io/astral-sh/uv --python3.12-bookworm"): Gunakan image Docker kustom dengan `uv` yang sudah terinstal. env (`dict[str, Any]`, *opsional*) : Mendefinisikan variabel lingkungan untuk Job. secrets (`dict[str, Any]`, *opsional*) : Mendefinisikan variabel lingkungan rahasia untuk Job. flavor (`str`, *opsional*) : Flavor untuk perangkat keras. Lihat `JobHardware` untuk nilai yang mungkin. Bawaan 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. Bawaan adalah 1. name (`str`, *opsional*) : Nama untuk Job. Disimpan sebagai label `name`. Tidak dapat dikirim 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](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.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://--8000.hf.jobs`). Akses selalu memerlukan token HF dengan akses baca ke 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 di `expose`. ssh (`bool`, *opsional*) : Jika True, kontainer dari job tersebut dapat dijangkau melalui SSH di URL yang diberikan oleh `job.status.ssh_url` (misalnya `ssh @ssh.hf.jobs`, atau `hf jobs ssh ` 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 mengakses di setiap port. Di dalam setiap anggota, `HF_NETWORK_GROUP_HOSTNAME` akan teresolusi 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}`. 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 grup sumber daya tempat Job akan dibuat. Digunakan untuk mengontrol akses ke sumber daya dalam organisasi dan untuk fitur atribusi biaya/batas pengeluaran. Jika tidak disediakan, Job akan dibuat di luar grup sumber daya 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. > [!WARNING] > 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](../guides/jobs#ship-the-launch-config-with-the-script)): konfigurasi peluncuran harus diberikan secara eksplisit di sini. Contoh: Jalankan skrip dari URL: ```python >>> from huggingface_hub import run_uv_job >>> script = "https://raw.githubusercontent.com/huggingface/trl/refs/heads/main/trl/scripts/sft.py" >>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"] >>> run_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small") ``` Jalankan skrip lokal: ```python >>> from huggingface_hub import run_uv_job >>> script = "my_sft.py" >>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"] >>> run_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small") ``` Jalankan perintah: ```python >>> from huggingface_hub import run_uv_job >>> script = "lighteval" >>> script_args= ["endpoint", "inference-providers", "model_name=openai/gpt-oss-20b,provider=auto", "lighteval|gsm8k|0|0"] >>> run_uv_job(script, script_args=script_args, dependencies=["lighteval"], flavor="a10g-small") ``` Pasang volume, misalnya untuk menyimpan checkpoint model selama pelatihan: ```python >>> from huggingface_hub import Volume, run_uv_job >>> script = "my_sft.py" >>> script_args = ["--output_dir", "/training-outputs/training-v3-final", ...] >>> checkpoints_bucket = Volume(type="bucket", source="username/my-bucket", mount_path="/training-outputs") >>> run_uv_job(script, script_args=script_args, volumes=[checkpoints_bucket]) ``` #### scale_to_zero_inference_endpoint[[huggingface_hub.HfApi.scale_to_zero_inference_endpoint]] ```python scale_to_zero_inference_endpoint(name: str, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10003) **Parameter:** name (`str`) : Nama Inference Endpoint yang akan diskalakan ke nol. namespace (`str`, *opsional*) : Namespace tempat Inference Endpoint berada. Secara default, namespace ini adalah 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](/docs/huggingface_hub/v2.4.0/id/package_reference/inference_endpoints#huggingface_hub.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.pause_inference_endpoint), yang memerlukan pengaktifan manual dengan [resume_inference_endpoint()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.resume_inference_endpoint). Untuk kenyamanan, Anda juga dapat menskalakan Inference Endpoint menjadi nol menggunakan [InferenceEndpoint.scale_to_zero()](/docs/huggingface_hub/v2.4.0/id/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint.scale_to_zero). #### search_spaces[[huggingface_hub.HfApi.search_spaces]] ```python search_spaces(query: str, filter: str | Iterable[str] | None = None, sdk: str | list[str] | None = None, include_non_running: bool = False, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2878) **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. 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:** `Iterable[SpaceSearchResult]` iterable dari objek [SpaceSearchResult](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> results = list(api.search_spaces("generate image")) >>> results[0].id 'mrfakename/Z-Image-Turbo' >>> results[0].ai_category 'Image Generation' ``` #### set_space_sleep_time[[huggingface_hub.HfApi.set_space_sleep_time]] ```python set_space_sleep_time(repo_id: str, sleep_time: int, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8373) **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 sementara. 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](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.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. > [!TIP] > Anda juga dapat mengatur waktu tidur kustom saat meminta perangkat keras dengan [request_space_hardware()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.request_space_hardware). #### set_space_volumes[[huggingface_hub.HfApi.set_space_volumes]] ```python set_space_volumes(repo_id: str, volumes: list[Volume], token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9057) **Parameter:** repo_id (`str`) : ID Space yang akan diperbarui. Contoh: `"username/my-space"`. volumes (`list[Volume]`) : Daftar objek [Volume](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.Volume) yang akan dipasang. 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`. **Mengangkat:** `BadRequestError` - `BadRequestError` -- Jika Space adalah static Space (volume tidak didukung pada static Spaces). Setel volume untuk sebuah Space. Sets (atau menggantikan) daftar volume yang dipasang di Space. Setiap volume memberikan akses ke sumber daya Hub (model, dataset, atau storage bucket) bagi container Space. Contoh: ```python >>> from huggingface_hub import HfApi, Volume >>> api = HfApi() >>> api.set_space_volumes( ... "username/my-space", ... volumes=[ ... Volume(type="model", source="username/my-model", mount_path="/models", read_only=True), ... Volume(type="bucket", source="username/my-bucket", mount_path="/data"), ... ], ... ) ``` #### snapshot_download[[huggingface_hub.HfApi.snapshot_download]] ```python snapshot_download(repo_id: str, repo_type: str | None = None, revision: str | None = None, cache_dir: str | Path | None = None, local_dir: str | Path | None = None, etag_timeout: float = 10, force_download: bool = False, token: bool | str | None = None, local_files_only: bool = False, allow_patterns: list[str] | str | None = None, ignore_patterns: list[str] | str | None = None, max_workers: int = 8, tqdm_class: type[base_tqdm] | None = None, dry_run: bool = False) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L6546) **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 diberikan, file yang diunduh akan ditempatkan di bawah direktori ini. etag_timeout (`float`, *opsional*, defaultnya `10`) : Saat mengambil ETag, berapa detik yang ditunggu agar server mengirim data sebelum menyerah, yang diteruskan ke `httpx2.request`. force_download (`bool`, *opsional*, defaultnya `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 file tersebut ada. allow_patterns (`list[str]` atau `str`, *opsional*) : Jika diberikan, 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). Bawaan adalah 8. tqdm_class (`tqdm`, *opsional*) : Jika disediakan, menimpa perilaku bawaan untuk bilah progres. Argumen yang diteruskan harus mewarisi dari `tqdm.auto.tqdm` atau setidaknya meniru perilakunya. Perhatikan bahwa `tqdm_class` tidak diteruskan ke setiap unduhan individual. Bawaannya adalah bilah progres 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.DryRunFileInfo) yang berisi informasi tentang apa yang akan diunduh. **Mengembalikan:** `str` atau daftar [DryRunFileInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.DryRunFileInfo) - Jika `dry_run=False`: Jalur folder dari snapshot repo. - Jika `dry_run=True`: Daftar objek [DryRunFileInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.DryRunFileInfo) yang berisi informasi unduhan. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) atau ``EnvironmentError`` atau ``OSError`` atau ``ValueError`` - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin terjadi karena repositori tersebut tidak ada, atau karena repositori tersebut disetel ke `private` dan Anda tidak memiliki akses. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Jika revisi yang akan diunduh tidak dapat ditemukan. - [`EnvironmentError`](https://docs.python.org/3/library/exceptions.html#EnvironmentError) -- Jika `token=True` dan token tidak dapat ditemukan. - [`OSError`](https://docs.python.org/3/library/exceptions.html#OSError) -- jika ETag tidak dapat ditentukan. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#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 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 root `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[[huggingface_hub.HfApi.space_info]] ```python space_info(repo_id: str, revision: str | None = None, timeout: float | None = None, files_metadata: bool = False, expand: list[ExpandSpaceProperty_T] | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L3359) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. revision (`str`, *opsional*) : Revisi repositori space yang digunakan untuk mengambil informasi. timeout (`float`, *opsional*) : Apakah akan mengatur batas waktu 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 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.SpaceInfo) Informasi repositori space. Dapatkan informasi tentang satu Space tertentu di huggingface.co. Space dapat bersifat privat jika Anda meneruskan token yang dapat diterima. > [!TIP] > Membuang kesalahan berikut: > > - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repositori tersebut tidak ada, atau karena disetel ke `private` dan Anda tidak memiliki akses. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) Jika revisi yang akan diunduh tidak dapat ditemukan. #### super_squash_history[[huggingface_hub.HfApi.super_squash_history]] ```python super_squash_history(repo_id: str, branch: str | None = None, commit_message: str | None = None, repo_type: str | None = None, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4346) **Parameter:** repo_id (`str`) : Nama namespace (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 di-squash. 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`. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) atau [BadRequestError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.BadRequestError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Jika cabang yang akan dipadatkan tidak dapat ditemukan. - [BadRequestError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.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. > [!WARNING] > Setelah di-squash, riwayat commit tidak dapat diambil kembali. Ini adalah operasi yang tidak dapat dibatalkan. > [!WARNING] > Setelah riwayat sebuah cabang di-squash, tidak mungkin lagi menggabungkannya kembali ke cabang lain karena riwayatnya akan telah bercabang. Contoh: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() # Create repo >>> repo_id = api.create_repo("test-squash").repo_id # Make a lot of commits. >>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"content") >>> api.upload_file(repo_id=repo_id, path_in_repo="lfs.bin", path_or_fileobj=b"content") >>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"another_content") # Squash history >>> api.super_squash_history(repo_id=repo_id) ``` #### suspend_scheduled_job[[huggingface_hub.HfApi.suspend_scheduled_job]] ```python suspend_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13354) **Parameter:** scheduled_job_id (`str`) : ID dari Job yang dijadwalkan. 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[[huggingface_hub.HfApi.sync_bucket]] ```python sync_bucket(source: str | None = None, dest: str | None = None, delete: bool = False, ignore_times: bool = False, ignore_sizes: bool = False, existing: bool = False, ignore_existing: bool = False, include: list[str] | None = None, exclude: list[str] | None = None, filter_from: str | None = None, plan: str | None = None, apply: str | None = None, dry_run: bool = False, verbose: bool = False, quiet: bool = False, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L15207) **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*, defaultnya *False*) : Lewati file hanya berdasarkan ukuran, mengabaikan waktu modifikasi. ignore_sizes (*bool*, *opsional*, defaultnya *False*) : Lewati file hanya berdasarkan waktu modifikasi, mengabaikan ukuran. existing (*bool*, *opsional*, default *False*) : Lewati pembuatan file baru di penerima (hanya memperbarui file yang sudah ada). ignore_existing (*bool*, *opsional*, defaultnya *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*) : Kecualikan 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*, *opsional*) : 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*) : Menampilkan operasi per file secara detail. quiet (*bool*, *opsional*, defaultnya *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: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() # Upload local directory to bucket >>> api.sync_bucket("./data", "hf://buckets/username/my-bucket") # Download bucket to local directory >>> api.sync_bucket("hf://buckets/username/my-bucket", "./data") # Sync with delete and filtering >>> api.sync_bucket( ... "./data", ... "hf://buckets/username/my-bucket", ... delete=True, ... include=["*.safetensors"], ... ) # Dry run: preview what would be synced >>> plan = api.sync_bucket("./data", "hf://buckets/username/my-bucket", dry_run=True) >>> plan.summary() &lcub;'uploads': 3, 'downloads': 0, 'deletes': 0, 'skips': 1, 'total_size': 4096} # Save plan for review, then apply >>> api.sync_bucket("./data", "hf://buckets/username/my-bucket", plan="sync-plan.jsonl") >>> api.sync_bucket(apply="sync-plan.jsonl") ``` #### sync_job_volume[[huggingface_hub.HfApi.sync_job_volume]] ```python sync_job_volume(source: str | Path, mount_path: str, remote_name: str | None = None, read_only: bool = True, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13857) **Parameter:** source (`str` atau `Path`) : Path ke direktori lokal untuk disinkronkan. mount_path (`str`) : Jalur mount di dalam kontainer 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*, defaultnya `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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.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](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.Volume) Volume bucket yang di-scope ke subfolder yang disinkronkan, untuk dimasukkan ke dalam daftar `volumes` dari [run_job()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.run_job), [run_uv_job()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.run_uv_job), [create_scheduled_job()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_scheduled_job) atau [create_scheduled_uv_job()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_scheduled_uv_job). Sinkronkan direktori lokal ke bucket dan kembalikan [Volume](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.sync_bucket): sinkronisasi ulang pada direktori yang sama hanya mengunggah file baru atau yang telah dimodifikasi. Secara default, nama subfolder diturunkan dari path direktori dan hostname mesin, sehingga pemanggilan berulang dari direktori yang sama akan menggunakan folder remote yang sama. Sampaikan `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 read-only secara default. Untuk mengambil data yang ditulis oleh Job ke volume read-write, sinkronkan folder bucket kembali dengan [sync_bucket()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.sync_bucket). Jika direktori sumber kosong (misalnya direktori output), file placeholder `.keep` diunggah agar volume tetap dapat dimount. Contoh: ```python >>> from huggingface_hub import run_uv_job, sync_job_volume # Upload ./training-data once, then run multiple jobs against it >>> volume = sync_job_volume("./training-data", "/data") >>> run_uv_job("train.py", script_args=["--learning-rate", "0.01"], volumes=[volume]) >>> run_uv_job("train.py", script_args=["--learning-rate", "0.05"], volumes=[volume]) # Read-write volume to retrieve outputs after the job completes >>> volume = sync_job_volume("./outputs", "/outputs", read_only=False) >>> job = run_uv_job("process.py", volumes=[volume]) ``` #### trigger_scheduled_job[[huggingface_hub.HfApi.trigger_scheduled_job]] ```python trigger_scheduled_job(scheduled_job_id: str, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13466) **Parameter:** scheduled_job_id (`str`) : ID dari Job yang dijadwalkan. 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](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.JobInfo) Info tentang run yang dipicu. **Mengangkat:** [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- HTTP 409 jika instance lain sudah berjalan dan `concurrency` dinonaktifkan pada job terjadwal. Pemicu Job terjadwal untuk dijalankan segera. Ini memicu satu eksekusi segera dari spesifikasi job terjadwal. Hal ini **tidak** mengubah jadwal dan **tidak** memengaruhi eksekusi terjadwal berikutnya. Jika sebuah instance sudah berjalan dan job terjadwal tidak mengizinkan eksekusi bersamaan, permintaan akan ditolak (HTTP 409). #### berbeda dengan[[huggingface_hub.HfApi.unlike]] ```python unlike(repo_id: str, token: bool | str | None = None, repo_type: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2937) **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`. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_liked_repos). Contoh: ```python >>> from huggingface_hub import list_liked_repos, unlike >>> "gpt2" in list_liked_repos().models # we assume you have already liked gpt2 True >>> unlike("gpt2") >>> "gpt2" in list_liked_repos().models False ``` #### update_bucket_settings[[huggingface_hub.HfApi.update_bucket_settings]] ```python update_bucket_settings(bucket_id: str, private: bool, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L14256) **Parameter:** bucket_id (`str`) : ID dari bucket (mis. `"username/my-bucket"`). private (`bool`) : Apakah 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`. **Mengangkat:** `BucketNotFoundError` atau ``or`` - `BucketNotFoundError` -- Jika bucket tidak dapat ditemukan. Hal ini mungkin karena bucket 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: ```python >>> from huggingface_hub import update_bucket_settings >>> # Make a bucket public >>> update_bucket_settings(bucket_id="Wauplin/first-bucket", private=False) >>> # Make it private again >>> update_bucket_settings(bucket_id="Wauplin/first-bucket", private=True) ``` #### update_collection_item[[huggingface_hub.HfApi.update_collection_item]] ```python update_collection_item(collection_slug: str, item_object_id: str, note: str | None = None, position: int | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10495) **Parameter:** collection_slug (`str`) : Slug dari koleksi yang akan diperbarui. Contoh: `"TheBloke/recent-models-64f9a55bb3115b4f513ec026"`. item_object_id (`str`) : ID dari item dalam koleksi. Ini bukan id dari item di Hub (repo_id atau paper id). Nilai ini harus diambil dari objek [CollectionItem](/docs/huggingface_hub/v2.4.0/id/package_reference/collections#huggingface_hub.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: ```py >>> from huggingface_hub import get_collection, update_collection_item # Get collection first >>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026") # Update item based on its ID (add note + update position) >>> update_collection_item( ... collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026", ... item_object_id=collection.items[-1].item_object_id, ... note="Newly updated model!", ... position=0, ... ) ``` #### update_collection_metadata[[huggingface_hub.HfApi.update_collection_metadata]] ```python update_collection_metadata(collection_slug: str, title: str | None = None, description: str | None = None, position: int | None = None, private: bool | None = None, theme: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10265) **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 dari 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](/docs/huggingface_hub/v2.4.0/id/package_reference/collections#huggingface_hub.Collection) Contoh: ```py >>> from huggingface_hub import update_collection_metadata >>> collection = update_collection_metadata( ... collection_slug="username/iccv-2023-64f9a55bb3115b4f513ec026", ... title="ICCV Oct. 2023", ... description="Portfolio of models, datasets, papers and demos I presented at ICCV Oct. 2023", ... private=False, ... theme="pink", ... ) >>> collection.slug "username/iccv-oct-2023-64f9a55bb3115b4f513ec026" # ^collection slug got updated but not the trailing ID ``` #### update_collection_resource_group[[huggingface_hub.HfApi.update_collection_resource_group]] ```python update_collection_resource_group(collection_slug: str, resource_group_id: str | None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L10333) **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: ```py >>> from huggingface_hub import update_collection_resource_group >>> update_collection_resource_group( ... collection_slug="my-org/iccv-2023-64f9a55bb3115b4f513ec026", ... resource_group_id="66980ecfc1e12a49c8f0e42d", ... ) ``` #### update_inference_endpoint[[huggingface_hub.HfApi.update_inference_endpoint]] ```python update_inference_endpoint(name: str, accelerator: str | None = None, instance_size: str | None = None, instance_type: str | None = None, min_replica: int | None = None, max_replica: int | None = None, scale_to_zero_timeout: int | None = None, scaling_metric: InferenceEndpointScalingMetric | None = None, scaling_threshold: float | None = None, repository: str | None = None, framework: str | None = None, revision: str | None = None, task: str | None = None, custom_image: dict | None = None, container_command: list[str] | None = None, container_args: list[str] | None = None, tensor_parallel_size: int | None = None, data_parallel_size: int | None = None, env: dict[str, str] | None = None, secrets: dict[str, str] | None = None, domain: str | None = None, path: str | None = None, cache_http_responses: bool | None = None, tags: list[str] | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L9706) **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 (misalnya `"x4"`). instance_type (`str`, *opsional*) : Jenis instance cloud tempat Inference Endpoint akan di-deploy (misalnya `"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 penskalaan. Yaitu "pendingRequests" atau "hardwareUsage" saat diberikan. Bawaan adalah None. scaling_threshold (`float`, *opsional*) : Ambang batas metrik penskalaan yang digunakan untuk memicu peningkatan skala. Diabaikan ketika metrik penskalaan tidak disediakan. Bawaan adalah None. repository (`str`, *opsional*) : Nama repositori model yang terkait dengan Inference Endpoint (misalnya `"gpt2"`). framework (`str`, *opsional*) : Kerangka kerja machine learning yang digunakan untuk model (mis. `"custom"`). revision (`str`, *opsional*) : Revisi model spesifik yang akan di-deploy pada Inference Endpoint (misalnya `"6c0e6080953db56375760c0471a8c5f2929baf11"`). task (`str`, *opsional*) : Tugas di mana model akan di-deploy (misalnya `"text-classification"`). custom_image (`dict`, *opsional*) : Citra kontainer yang akan dijalankan. Bisa berupa dict yang dikunci berdasarkan varian citra (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 kontainer kustom (mis. `{"url": ..., "port": ...}`), yang dikirim sebagai `{"custom": ...}`. container_command (`list[str]`, *opsional*) : Menimpa perintah entrypoint kontainer (dipetakan ke `model.command` dalam payload API). Berfungsi dengan gambar mesin yang dikelola (misalnya vLLM, SGLang) maupun gambar kustom. container_args (`list[str]`, *opsional*) : Argumen yang ditambahkan ke entrypoint kontainer (dipetakan ke `model.args` dalam payload API). Berfungsi dengan gambar mesin yang dikelola (mis. 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 container 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](/docs/huggingface_hub/v2.4.0/id/package_reference/inference_endpoints#huggingface_hub.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/inference_endpoints#huggingface_hub.InferenceEndpoint.update). #### update_job_expose[[huggingface_hub.HfApi.update_job_expose]] ```python update_job_expose(job_id: str, expose: list[int] | None = None, expose_public: list[int] | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12787) **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 di `expose`. namespace (`str`, *opsional*) : Namespace dari Job. Secara default menggunakan namespace pengguna saat ini. token (`bool` atau `str`, *opsional*) : Token akses pengguna. Bawaan adalah token yang disimpan secara lokal. **Mengembalikan:** [JobInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.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 akan ditutup. Jangan berikan keduanya untuk menutup semua port yang terekspos. #### update_job_labels[[huggingface_hub.HfApi.update_job_labels]] ```python update_job_labels(job_id: str, labels: dict[str, str], namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12828) **Parameter:** job_id (`str`) : ID dari Job. labels (`dict[str, str]`) : Label baru yang akan disetel pada job. Menggantikan semua label yang ada. Baik kunci maupun 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](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.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[[huggingface_hub.HfApi.update_repo_settings]] ```python update_repo_settings(repo_id: str, gated: Literal['auto', 'manual', False] | None = None, private: bool | None = None, visibility: RepoVisibility_T | None = None, token: str | bool | None = None, repo_type: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4838) **Parameter:** repo_id (`str`) : Nama namespace (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` repositori tidak akan diperbarui. * "auto": Repositori bersifat gated, dan permintaan akses disetujui atau ditolak secara otomatis berdasarkan kriteria yang telah ditentukan. * "manual": Repositori bersifat gated, dan permintaan akses memerlukan persetujuan manual. * False : Repositori tidak bersifat gated, dan siapa pun dapat mengaksesnya. private (`bool`, *opsional*) : Apakah repositori harus bersifat privat. Tidak dapat diteruskan 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 untuk memperbarui pengaturan dari (`"model"`, `"dataset"` atau `"space"`). Bawaan adalah `"model"`. **Mengangkat:** ``ValueError`` atau [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) atau [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Jika gated bukan salah satu dari "auto", "manual", atau False. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Jika repo_type bukan salah satu nilai dalam constants.REPO_TYPES. - [HfHubHTTPError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.HfHubHTTPError) -- Jika permintaan ke API Hugging Face Hub gagal. - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika repositori yang akan diunduh tidak dapat ditemukan. Hal ini mungkin terjadi 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 kendali lebih besar atas cara repositori digunakan, Hub memungkinkan penulis repositori untuk mengaktifkan permintaan akses untuk repositori mereka, serta mengubah visibilitas repositori. #### update_scheduled_job_labels[[huggingface_hub.HfApi.update_scheduled_job_labels]] ```python update_scheduled_job_labels(scheduled_job_id: str, labels: dict[str, str], namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13508) **Parameter:** scheduled_job_id (`str`) : ID dari Job yang dijadwalkan. labels (`dict[str, str]`) : Label baru untuk disetel pada pekerjaan terjadwal. Menggantikan semua label yang ada. Baik kunci maupun 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[[huggingface_hub.HfApi.update_scheduled_job_schedule]] ```python update_scheduled_job_schedule(scheduled_job_id: str, schedule: str, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L13414) **Parameter:** scheduled_job_id (`str`) : ID dari Job yang dijadwalkan. schedule (`str`) : Salah satu dari "@annually", "@yearly", "@monthly", "@weekly", "@daily", "@hourly", atau ekspresi jadwal CRON (misalnya, '0 9 * * 1' untuk pukul 9 pagi 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.trigger_scheduled_job) sebagai gantinya. Contoh: ```python >>> from huggingface_hub import update_scheduled_job_schedule >>> scheduled_job = update_scheduled_job_schedule(scheduled_job_id="6abb8dc9c617607c354d45f4", schedule="@daily") >>> scheduled_job.schedule '@daily' ``` #### update_webhook[[huggingface_hub.HfApi.update_webhook]] ```python update_webhook(webhook_id: str, url: str | None = None, job_id: str | None = None, watched: list[dict | WebhookWatchedItem] | None = None, domains: list[constants.WEBHOOK_DOMAIN_T] | None = None, secret: str | None = None, secrets: dict[str, str] | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L11319) **Parameter:** webhook_id (`str`) : Pengenal unik dari webhook yang akan diperbarui. url (`str`, opsional) : URL tempat payload akan dikirim. job_id (`str`, opsional) : ID dari Job sumber yang akan dipicu dengan webhook payload. 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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) : Rahasia 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.WebhookInfo) Info tentang webhook yang diperbarui. Perbarui webhook yang sudah ada. Contoh: ```python >>> from huggingface_hub import update_webhook >>> updated_payload = update_webhook( ... webhook_id="654bbbc16f2ec14d77f109cc", ... url="https://new.webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548", ... watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}], ... domains=["repo"], ... secret="my-secret", ... ) >>> print(updated_payload) WebhookInfo( id="654bbbc16f2ec14d77f109cc", job=None, url="https://new.webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548", watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")], domains=["repo"], secret="my-secret", disabled=False, ``` #### upload_attachment[[huggingface_hub.HfApi.upload_attachment]] ```python upload_attachment(path: str | Path, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8000) **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. File harus berukuran 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. **Mengangkat:** ``ValueError`` - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Jika format file tidak didukung. 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. Sisipkan URL yang dikembalikan ke dalam deskripsi atau komentar: `![alt text](url)` untuk gambar, URL polos untuk video, dan `` untuk file audio. Contoh: ```python >>> from huggingface_hub import HfApi >>> api = HfApi() >>> url = api.upload_attachment("screenshot.png") >>> api.create_discussion("username/my-model", title="Rendering bug", description=f"![screenshot]({url})") ``` #### upload_file[[huggingface_hub.HfApi.upload_file]] ```python upload_file(path_or_fileobj: str | Path | bytes | BinaryIO, path_in_repo: str, repo_id: str, token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, commit_message: str | None = None, commit_description: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None, run_as_future: bool = False, _hot_reload: bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L5621) **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`) : filepath 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 atau tidak. Tugas latar belakang dijalankan secara berurutan tanpa memblokir utas utama. Mengirimkan `run_as_future=True` akan mengembalikan objek [Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects). Bawaan adalah `False`. **Mengembalikan:** [CommitInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.CommitInfo) atau `Future` Instance of [CommitInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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 ditentukan. Unggahan dilakukan melalui permintaan HTTP post, dan tidak memerlukan git atau git-lfs yang terinstal. > [!TIP] > Membuang kesalahan berikut: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) jika API HuggingFace mengembalikan error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) jika nilai beberapa parameter tidak valid - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) Jika repository yang akan diunduh tidak dapat ditemukan. Hal ini mungkin karena repository tidak ada, atau karena repository disetel ke `private` dan Anda tidak memiliki akses. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) Jika revisi yang akan diunduh tidak dapat ditemukan. > [!WARNING] > `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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_repo). Contoh: ```python >>> from huggingface_hub import upload_file >>> with open("./local/filepath", "rb") as fobj: ... upload_file( ... path_or_fileobj=fileobj, ... path_in_repo="remote/file/path.h5", ... repo_id="username/my-dataset", ... repo_type="dataset", ... token="my_token", ... ) >>> upload_file( ... path_or_fileobj=".\\local\\file\\path", ... path_in_repo="remote/file/path.h5", ... repo_id="username/my-model", ... token="my_token", ... ) >>> upload_file( ... path_or_fileobj=".\\local\\file\\path", ... path_in_repo="remote/file/path.h5", ... repo_id="username/my-model", ... token="my_token", ... create_pr=True, ... ) ``` #### upload_folder[[huggingface_hub.HfApi.upload_folder]] ```python upload_folder(repo_id: str, folder_path: str | Path, path_in_repo: str | None = None, commit_message: str | None = None, commit_description: str | None = None, token: str | bool | None = None, repo_type: str | None = None, revision: str | None = None, create_pr: bool | None = None, parent_commit: str | None = None, allow_patterns: list[str] | str | None = None, ignore_patterns: list[str] | str | None = None, delete_patterns: list[str] | str | None = None, run_as_future: bool = False) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L5808) **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 dari direktori di repo, misalnya: `"checkpoints/1fec34a/results"`. Akan default ke 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. Bawaan: `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. Nilainya secara default adalah `False`. PR selalu dibuka terhadap cabang 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 unggahan 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 diberikan, 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 diberikan, file jarak jauh yang cocok dengan salah satu pola akan dihapus dari repositori saat file baru dikomit. 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 atau tidak. Tugas latar belakang dijalankan secara berurutan tanpa memblokir utas utama. Mengirimkan `run_as_future=True` akan mengembalikan objek [Future](https://docs.python.org/3/library/concurrent.futures.html#future-objects). Bawaan adalah `False`. **Mengembalikan:** [CommitInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.CommitInfo) atau `Future` Instance of [CommitInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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 ditentukan. 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](https://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm). 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, proses kembali ke satu komit yang dibuat dengan [create_commit()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_commit). > [!TIP] > Membuang kesalahan berikut: > > - [`HTTPError`](https://requests.readthedocs.io/en/latest/api/#requests.HTTPError) jika API HuggingFace mengembalikan error - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) jika nilai beberapa parameter tidak valid > [!WARNING] > `upload_folder` mengasumsikan bahwa repo sudah ada di Hub. Jika Anda mendapatkan Client error 404, pastikan Anda 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_repo). Contoh: ```python # Upload checkpoints folder except the log files >>> upload_folder( ... folder_path="local/checkpoints", ... path_in_repo="remote/experiment/checkpoints", ... repo_id="username/my-dataset", ... repo_type="datasets", ... token="my_token", ... ignore_patterns="**/logs/*.txt", ... ) # Upload checkpoints folder including logs while deleting existing logs from the repo # Useful if you don't know exactly which log files have already being pushed >>> upload_folder( ... folder_path="local/checkpoints", ... path_in_repo="remote/experiment/checkpoints", ... repo_id="username/my-dataset", ... repo_type="datasets", ... token="my_token", ... delete_patterns="**/logs/*.txt", ... ) # Upload checkpoints folder while creating a PR >>> upload_folder( ... folder_path="local/checkpoints", ... path_in_repo="remote/experiment/checkpoints", ... repo_id="username/my-dataset", ... repo_type="datasets", ... token="my_token", ... create_pr=True, ... ) ``` #### verify_repo_checksums[[huggingface_hub.HfApi.verify_repo_checksums]] ```python verify_repo_checksums(repo_id: str, repo_type: str | None = None, revision: str | None = None, local_dir: str | Path | None = None, cache_dir: str | Path | None = None, token: str | bool | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L4035) **Parameter:** repo_id (`str`) : Nama namespace (pengguna atau organisasi) dan nama repo yang dipisahkan oleh `/`. repo_type (`str`, *opsional*) : Jenis repositori yang akan diambil pohonnya (`"model"`, `"dataset"` atau `"space"`. Bawaan adalah `"model"`. revision (`str`, *opsional*) : Revisi repositori yang digunakan untuk mengambil pohon. Secara default menggunakan 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], 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:** `FolderVerification` hasil terstruktur yang berisi detail verifikasi. **Mengangkat:** [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) atau [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) - [RepositoryNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RepositoryNotFoundError) -- Jika repositori tidak ditemukan (error 404): repo_id/repo_type salah, repositori bersifat privat tetapi tidak terautentikasi, atau repositori tidak ada. - [RevisionNotFoundError](/docs/huggingface_hub/v2.4.0/id/package_reference/utilities#huggingface_hub.errors.RevisionNotFoundError) -- Jika revisi tidak ditemukan (error 404) di repo. Verifikasi file lokal untuk sebuah repo terhadap checksum Hub. #### wait_for_job[[huggingface_hub.HfApi.wait_for_job]] ```python wait_for_job(job_id: str | list[str], timeout: float | None = None, poll_interval: float = 1.0, stages: list[JobStage] | None = None, namespace: str | None = None, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L12638) **Parameter:** job_id (`str` atau `list[str]`) : ID dari Job, atau daftar ID Job yang akan ditunggu. Jika daftar yang diberikan, sebuah daftar [JobInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.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 1s. stages (`list[JobStage]`, *opsional*) : Tahapan yang akan ditunggu. Secara bawaan, menunggu hingga tahap terminal (`"COMPLETED"`, `"CANCELED"`, `"ERROR"`, `"DELETED"`). Berikan misalnya `[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](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.JobInfo) atau `list[JobInfo]` info Job akhir. **Mengangkat:** ``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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.inspect_job)) setiap `poll_interval` detik hingga tahapnya menjadi salah satu dari `stages` (tahap terminal secara default: `"COMPLETED"`, `"CANCELED"`, `"ERROR"` atau `"DELETED"`). [JobInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/jobs#huggingface_hub.JobInfo) akhir dikembalikan dalam semua kasus: Job yang gagal atau dibatalkan tidak **menimbulkan** 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: ```python >>> from huggingface_hub import run_job, wait_for_job >>> job = run_job(image="python:3.12", command=["python", "-c", "print('Hello from HF compute!')"]) >>> wait_for_job(job_id=job.id).status.stage 'COMPLETED' ``` #### wait_for_space[[huggingface_hub.HfApi.wait_for_space]] ```python wait_for_space(repo_id: str, timeout: float | None = None, poll_interval: float = 1.0, token: bool | str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L8803) **Parameter:** repo_id (`str`) : ID Space yang akan ditunggu. Contoh: `"username/my-space"`. timeout (`float`, *opsional*) : Waktu maksimum untuk menunggu dalam detik. Jika `None`, menunggu tanpa batas waktu. poll_interval (`float`, *opsional*) : Detik antara pemeriksaan status. Bawaan 1s. 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](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.SpaceRuntime) Informasi runtime terakhir saat Space mencapai tahap terminal. **Mengangkat:** ``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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.get_space_runtime) setiap `poll_interval` detik hingga tahap Space tidak lagi bersifat perantara (`BUILDING`, `RUNNING_BUILDING`, `APP_STARTING`, `RUNNING_APP_STARTING`). Mengembalikan [SpaceRuntime](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.SpaceRuntime) akhir dalam semua kasus — periksa `runtime.stage` untuk bertindak berdasarkan hasilnya (mis. `RUNNING` vs `BUILD_ERROR`). Contoh: ```python >>> from huggingface_hub import restart_space, wait_for_space >>> restart_space("username/my-space") >>> runtime = wait_for_space("username/my-space") >>> runtime.stage 'RUNNING' ``` #### whoami[[huggingface_hub.HfApi.whoami]] ```python whoami(token: bool | str | None = None, cache: bool = False) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L2218) **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. Bawaan adalah `False`. Panggil HF API 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[[huggingface_hub.hf_api.AccessRequest]] #### huggingface_hub.hf_api.AccessRequest[[huggingface_hub.hf_api.AccessRequest]] ```python huggingface_hub.hf_api.AccessRequest(username: str | None, request_id: str, fullname: str | None, email: str | None, timestamp: datetime, status: Literal['pending', 'accepted', 'rejected'], fields: dict[str, Any] | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L445) **Parameter:** username (`str`, *opsional*) : Nama pengguna dari pengguna yang meminta akses. `None` jika repositori dikonfigurasi untuk tidak membagikan nama pengguna 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 repositori 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`) : Stempel waktu dari permintaan. status (`Literal["pending", "accepted", "rejected"]`) : Status dari permintaan. Dapat 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[[huggingface_hub.BucketFile]] #### huggingface_hub.BucketFile[[huggingface_hub.BucketFile]] ```python huggingface_hub.BucketFile(**kwargs) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L197) Berisi informasi tentang file dalam bucket di Hub. Objek ini dikembalikan oleh [list_bucket_tree()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_bucket_tree). Mirip dengan [RepoFile](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.RepoFile) tetapi untuk file di bucket. ### BucketFileMetadata[[huggingface_hub.BucketFileMetadata]] #### huggingface_hub.BucketFileMetadata[[huggingface_hub.BucketFileMetadata]] ```python huggingface_hub.BucketFileMetadata(size: int, xet_file_data: XetFileData) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L140) **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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.get_bucket_file_metadata). ### BucketInfo[[huggingface_hub.BucketInfo]] #### huggingface_hub.BucketInfo[[huggingface_hub.BucketInfo]] ```python huggingface_hub.BucketInfo(**kwargs) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L65) **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`) : Total jumlah file dalam bucket. Berisi informasi tentang bucket di Hub. Objek ini dikembalikan oleh [bucket_info()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.bucket_info) dan [list_buckets()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_buckets). ### BucketUrl[[huggingface_hub.BucketUrl]] #### huggingface_hub.BucketUrl[[huggingface_hub.BucketUrl]] ```python huggingface_hub.BucketUrl(url: str, endpoint: str = '') ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L157) **Parameter:** url (`str`) : Nilai string dari url bucket. endpoint (`str`, *opsional*) : Endpoint dari Hub. Bawaan ke . Menggambarkan URL bucket di Hub. `BucketUrl` dikembalikan oleh [create_bucket()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_bucket). Saat inisialisasi, URL diurai untuk mengisi properti: - endpoint (`str`) - namespace (`str`) - bucket_id (`str`) - url (`str`) - uri (`HfUri`) ### DatasetLeaderboardEntry[[huggingface_hub.DatasetLeaderboardEntry]] #### huggingface_hub.DatasetLeaderboardEntry[[huggingface_hub.DatasetLeaderboardEntry]] ```python huggingface_hub.DatasetLeaderboardEntry(**kwargs) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1948) **Parameter:** rank (`int`) : Peringkat model di papan peringkat (indeks mulai dari 1). model_id (`str`) : ID dari model (mis. `"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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.get_dataset_leaderboard). Untuk mendapatkan hasil evaluasi untuk model tertentu di berbagai benchmark, lihat `ModelInfo.eval_results` (melalui [model_info()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.model_info) dengan `expand=["evalResults"]`) dan [EvalResultEntry](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.EvalResultEntry). ### EvalResultEntry[[huggingface_hub.EvalResultEntry]] #### huggingface_hub.EvalResultEntry[[huggingface_hub.EvalResultEntry]] ```python huggingface_hub.EvalResultEntry(dataset_id: str, task_id: str, value: typing.Any, dataset_revision: str | None = None, verify_token: str | None = None, date: str | None = None, source_url: str | None = None, source_name: str | None = None, source_user: str | None = None, source_org: str | None = None, notes: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_eval_results.py#L17) **Parameter:** dataset_id (`str`) : ID dataset benchmark dari Hub. Contoh: "cais/hle", "Idavidrein/gpqa". task_id (`str`) : Pengenal tugas di dalam benchmark. Contoh: "gpqa_diamond". value (`Any`) : Nilai metrik. Contoh: 20.90. dataset_revision (`str`, *opsional*) : Git SHA 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 organisasi 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](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.EvalResult) sebagai gantinya. Lihat https://huggingface.co/docs/hub/eval-results untuk detail lebih lanjut. Contoh: ```python >>> from huggingface_hub import EvalResultEntry >>> # Minimal example with required fields only >>> result = EvalResultEntry( ... dataset_id="Idavidrein/gpqa", ... task_id="gpqa_diamond", ... value=0.412, ... ) >>> # Full example with all fields >>> result = EvalResultEntry( ... dataset_id="cais/hle", ... task_id="default", ... value=20.90, ... dataset_revision="5503434ddd753f426f4b38109466949a1217c2bb", ... verify_token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", ... date="2025-01-15T10:30:00Z", ... source_url="https://huggingface.co/datasets/cais/hle", ... source_name="CAIS HLE", ... source_org="cais", ... notes="no-tools", ... ) ``` ### SyncOperation[[huggingface_hub.SyncOperation]] #### huggingface_hub.SyncOperation[[huggingface_hub.SyncOperation]] ```python huggingface_hub.SyncOperation(action: typing.Literal['upload', 'download', 'delete', 'skip'], path: str, size: int | None = None, reason: str = '', local_mtime: str | None = None, remote_mtime: str | None = None, bucket_file: huggingface_hub._buckets.BucketFile | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L289) Mewakili operasi sinkronisasi yang akan dilakukan. ### SyncPlan[[huggingface_hub.SyncPlan]] #### huggingface_hub.SyncPlan[[huggingface_hub.SyncPlan]] ```python huggingface_hub.SyncPlan(source: str, dest: str, timestamp: str, operations: list = ) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_buckets.py#L302) Mewakili rencana sinkronisasi lengkap. ### CommitInfo[[huggingface_hub.CommitInfo]] #### huggingface_hub.CommitInfo[[huggingface_hub.CommitInfo]] ```python huggingface_hub.CommitInfo(commit_url: str, *args, **kwargs) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L362) **Parameter:** commit_url (`str`) : Url tempat menemukan commit. commit_message (`str`) : Ringkasan (baris pertama) dari commit yang telah dibuat. commit_description (`str`) : Deskripsi dari commit yang telah dibuat. Bisa kosong. oid (`str`) : Hash id commit. Contoh: `"91c54ad1727ee830252e457677f467be0bfd8a57"`. pr_url (`str`, *opsional*) : Url ke PR yang telah dibuat, jika ada. Terisi ketika `create_pr=True` diteruskan. 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_commit), [upload_file()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.upload_file), [upload_folder()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.upload_folder), [delete_file()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.delete_file), [delete_folder()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.delete_folder). Kelas ini mewarisi dari `str` untuk kompatibilitas mundur, tetapi penggunaan metode yang spesifik untuk `str` sudah tidak didukung lagi. ### DatasetInfo[[huggingface_hub.DatasetInfo]] #### huggingface_hub.DatasetInfo[[huggingface_hub.DatasetInfo]] ```python huggingface_hub.DatasetInfo(**kwargs) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1013) **Parameter:** id (`str`) : ID dari dataset. author (`str`) : Penulis dataset. card_data (`DatasetCardData`, *opsional*) : Metadata Dataset Card sebagai objek [huggingface_hub.repocard_data.DatasetCardData](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.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 total unduhan dataset sejak dibuat. gated (`Literal["auto", "manual", False]`, *opsional*) : Apakah repo tersebut bergerbang. Jika ya, apakah persetujuannya manual atau otomatis. last_modified (`datetime`, *opsional*) : Tanggal commit terakhir ke repo. likes (`int`) : Jumlah suka 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.dataset_info) dan [list_datasets()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_datasets). > [!TIP] > 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_datasets), hanya sebagian kecil atribut yang dikembalikan. ### DryRunFileInfo[[huggingface_hub.DryRunFileInfo]] #### huggingface_hub.DryRunFileInfo[[huggingface_hub.DryRunFileInfo]] ```python huggingface_hub.DryRunFileInfo(commit_hash: str, file_size: int | None, filename: str, local_path: str, is_cached: bool, will_download: bool) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/file_download.py#L182) **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`. Pada 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/file_download#huggingface_hub.hf_hub_download) ketika `dry_run=True`. ### DuplicatedRepoUrl[[huggingface_hub.DuplicatedRepoUrl]] #### huggingface_hub.DuplicatedRepoUrl[[huggingface_hub.DuplicatedRepoUrl]] ```python huggingface_hub.DuplicatedRepoUrl(url: Any, endpoint: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L594) **Parameter:** files_copy_pending (`bool`) : `True` jika file LFS/Xet dari repo baru masih sedang disalin di latar belakang. Hingga proses salin selesai, pengunduhan file-file ini mungkin gagal. [RepoUrl](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.RepoUrl) yang dikembalikan oleh [duplicate_repo()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.duplicate_repo). ### GitRefInfo[[huggingface_hub.GitRefInfo]] #### huggingface_hub.GitRefInfo[[huggingface_hub.GitRefInfo]] ```python huggingface_hub.GitRefInfo(name: str, ref: str, target_commit: str) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1444) **Parameter:** name (`str`) : Nama 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[[huggingface_hub.GitCommitInfo]] #### huggingface_hub.GitCommitInfo[[huggingface_hub.GitCommitInfo]] ```python huggingface_hub.GitCommitInfo(commit_id: str, authors: list[str], created_at: datetime, title: str, message: str, formatted_title: str | None, formatted_message: str | None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1489) **Parameter:** commit_id (`str`) : OID dari commit (mis. `"e7da7f221d5bf496a48136c0cd264e630fe9fcc8"`) authors (`list[str]`) : Daftar penulis dari commit. created_at (`datetime`) : Waktu saat commit dibuat. title (`str`) : Judul commit. Ini adalah nilai teks bebas yang dimasukkan oleh para penulis. message (`str`) : Deskripsi dari commit. Ini adalah nilai teks bebas yang dimasukkan 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_repo_commits) untuk detail lebih lanjut. ### GitRefs[[huggingface_hub.GitRefs]] #### huggingface_hub.GitRefs[[huggingface_hub.GitRefs]] ```python huggingface_hub.GitRefs(branches: list[GitRefInfo], converts: list[GitRefInfo], tags: list[GitRefInfo], pull_requests: list[GitRefInfo] | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1463) **Parameter:** branches (`list[GitRefInfo]`) : Daftar [GitRefInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.GitRefInfo) yang berisi informasi tentang cabang di repo. converts (`list[GitRefInfo]`) : Daftar [GitRefInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.GitRefInfo) yang berisi informasi tentang ref "convert" pada repo. Ref convert digunakan (secara internal) untuk mendorong data yang telah diproses di repo Dataset. tags (`list[GitRefInfo]`) : Daftar [GitRefInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.GitRefInfo) yang berisi informasi tentang tag pada repo. pull_requests (`list[GitRefInfo]`, *opsional*) : Daftar [GitRefInfo](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_repo_refs). ### InferenceProviderMapping[[huggingface_hub.hf_api.InferenceProviderMapping]] #### huggingface_hub.hf_api.InferenceProviderMapping[[huggingface_hub.hf_api.InferenceProviderMapping]] ```python huggingface_hub.hf_api.InferenceProviderMapping(**kwargs) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L773) ### KernelInfo[[huggingface_hub.KernelInfo]] #### huggingface_hub.KernelInfo[[huggingface_hub.KernelInfo]] ```python huggingface_hub.KernelInfo(**kwargs) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1285) **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 tersebut bergerbang. Jika ya, apakah persetujuannya manual atau otomatis. last_modified (`datetime`, *opsional*) : Tanggal commit terakhir ke repo. likes (`int`, *opsional*) : Jumlah suka 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.kernel_info). ### LFSFileInfo[[huggingface_hub.hf_api.LFSFileInfo]] #### huggingface_hub.hf_api.LFSFileInfo[[huggingface_hub.hf_api.LFSFileInfo]] ```python huggingface_hub.hf_api.LFSFileInfo(**kwargs) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1887) **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 repositori. 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_lfs_files) dan [permanently_delete_lfs_files()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.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](https://huggingface.co/docs/hub/storage-limits#advanced-track-lfs-file-references) untuk mempelajari cara mengetahui nama file mana yang terkait dengan setiap SHA. Contoh: ```py >>> from huggingface_hub import HfApi >>> api = HfApi() >>> lfs_files = api.list_lfs_files("username/my-cool-repo") # Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`. # e.g. select only LFS files in the "checkpoints" folder >>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/")) # Permanently delete LFS files >>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete) ``` ### ModelInfo[[huggingface_hub.ModelInfo]] #### huggingface_hub.ModelInfo[[huggingface_hub.ModelInfo]] ```python huggingface_hub.ModelInfo(**kwargs) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L798) **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](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.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 total unduhan model sejak pembuatannya. eval_results (`list[EvalResultEntry]`, *opsional*) : Hasil evaluasi model. gated (`Literal["auto", "manual", False]`, *opsional*) : Apakah repo tersebut bergerbang. Jika ya, apakah persetujuannya 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 suka 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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.hf_api.RepoSibling) yang membentuk model. spaces (`list[str]`, *opsional*) : Daftar ruang 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 khusus Transformers (auto class, processor, dll.) yang terkait dengan model. trending_score (`int`, *opsional*) : Skor tren 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.model_info) dan [list_models()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_models). > [!TIP] > 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_models), hanya sebagian kecil dari atribut yang dikembalikan. ### RepoSibling[[huggingface_hub.hf_api.RepoSibling]] #### huggingface_hub.hf_api.RepoSibling[[huggingface_hub.hf_api.RepoSibling]] ```python huggingface_hub.hf_api.RepoSibling(rfilename: str, size: int | None = None, blob_id: str | None = None, lfs: BlobLfsInfo | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L648) **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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.repo_info) diatur ke `True`. Nilainya `None` jika tidak. blob_id (`str`, *opsional*) : OID git dari file. Atribut ini didefinisikan ketika argumen `files_metadata` dari [repo_info()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.repo_info) diatur ke `True`. Nilainya `None` jika tidak. lfs (`BlobLfsInfo`, *opsional*) : Metadata LFS dari file. Atribut ini didefinisikan saat argumen `files_metadata` dari [repo_info()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.repo_info) diatur ke `True` dan file disimpan dengan Git LFS. Nilainya `None` jika tidak. Berisi informasi dasar tentang file repositori di dalam repositori di Hub. > [!TIP] > Semua atribut dari kelas ini bersifat opsional kecuali `rfilename`. Hal ini karena hanya nama file yang dikembalikan saat mendaftar repositori di Hub (dengan [list_models()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_models), [list_datasets()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_datasets) atau [list_spaces()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.model_info), [dataset_info()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.dataset_info) atau [space_info()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.space_info)) karena hal ini menambah lebih banyak kendala pada server backend untuk mengambil data tersebut. ### RepoFile[[huggingface_hub.RepoFile]] #### huggingface_hub.RepoFile[[huggingface_hub.RepoFile]] ```python huggingface_hub.RepoFile(**kwargs) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L680) **Parameter:** path (str) : jalur file relatif terhadap akar repo. size (`int`) : Ukuran file, dalam byte. blob_id (`str`) : OID git dari file. lfs (`BlobLfsInfo`, *opsional*) : Metadata LFS dari file tersebut. xet_hash (`str`, *opsional*) : Hash Xet dari file tersebut. last_commit (`LastCommitInfo`, *opsional*) : Metadata commit terakhir file. Hanya didefinisikan jika [list_repo_tree()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_repo_tree) dan [get_paths_info()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.get_paths_info) dipanggil dengan `expand=True`. security (`BlobSecurityInfo`, *opsional*) : Metadata pemindaian keamanan file. Hanya didefinisikan jika [list_repo_tree()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_repo_tree) dan [get_paths_info()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.get_paths_info) dipanggil dengan `expand=True`. Berisi informasi tentang file di Hub. ### RepoUrl[[huggingface_hub.RepoUrl]] #### huggingface_hub.RepoUrl[[huggingface_hub.RepoUrl]] ```python huggingface_hub.RepoUrl(url: Any, endpoint: str | None = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L527) **Parameter:** url (`Any`) : Nilai String dari url repo. endpoint (`str`, *opsional*) : Endpoint dari Hub. Bawaan ke . **Mengangkat:** `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: ```py >>> RepoUrl('https://huggingface.co/openai-community/gpt2') RepoUrl('https://huggingface.co/openai-community/gpt2', endpoint='https://huggingface.co', repo_type='model', repo_id='openai-community/gpt2') >>> RepoUrl('https://hub-ci.huggingface.co/datasets/dummy_user/dummy_dataset', endpoint='https://hub-ci.huggingface.co') RepoUrl('https://hub-ci.huggingface.co/datasets/dummy_user/dummy_dataset', endpoint='https://hub-ci.huggingface.co', repo_type='dataset', repo_id='dummy_user/dummy_dataset') >>> RepoUrl('hf://datasets/my-user/my-dataset') RepoUrl('hf://datasets/my-user/my-dataset', endpoint='https://huggingface.co', repo_type='dataset', repo_id='user/dataset') >>> HfApi.create_repo("dummy_model") RepoUrl('https://huggingface.co/Wauplin/dummy_model', endpoint='https://huggingface.co', repo_type='model', repo_id='Wauplin/dummy_model') ``` ### SafetensorsRepoMetadata[[huggingface_hub.utils.SafetensorsRepoMetadata]] #### huggingface_hub.utils.SafetensorsRepoMetadata[[huggingface_hub.utils.SafetensorsRepoMetadata]] ```python huggingface_hub.utils.SafetensorsRepoMetadata(metadata: dict | None, sharded: bool, weight_map: dict, files_metadata: dict) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/utils/_safetensors.py#L74) **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 dipecah (sharded) 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 di akarnya terdapat file bobot 'model.safetensors' (model non-shared) atau file indeks 'model.safetensors.index.json' (model sharded). Kelas ini dikembalikan oleh [get_safetensors_metadata()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.get_safetensors_metadata). Untuk detail lebih lanjut mengenai format safetensors, lihat https://huggingface.co/docs/safetensors/index#format. ### SafetensorsFileMetadata[[huggingface_hub.utils.SafetensorsFileMetadata]] #### huggingface_hub.utils.SafetensorsFileMetadata[[huggingface_hub.utils.SafetensorsFileMetadata]] ```python huggingface_hub.utils.SafetensorsFileMetadata(metadata: dict, tensors: dict) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/utils/_safetensors.py#L44) **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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.parse_safetensors_file_metadata). Untuk detail lebih lanjut mengenai format safetensors, lihat https://huggingface.co/docs/safetensors/index#format. ### SpaceInfo[[huggingface_hub.SpaceInfo]] #### huggingface_hub.SpaceInfo[[huggingface_hub.SpaceInfo]] ```python huggingface_hub.SpaceInfo(**kwargs) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1147) **Parameter:** id (`str`) : ID dari Space. author (`str`, *opsional*) : Penulis dari Space. card_data (`SpaceCardData`, *opsional*) : Metadata Space Card sebagai objek [huggingface_hub.repocard_data.SpaceCardData](/docs/huggingface_hub/v2.4.0/id/package_reference/cards#huggingface_hub.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 tersebut bergerbang. Jika ya, apakah persetujuannya manual atau otomatis. host (`str`, *opsional*) : URL host dari Space. last_modified (`datetime`, *opsional*) : Tanggal commit terakhir ke repo. likes (`int`) : Jumlah suka 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](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.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](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#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 dalam byte dari Space di Hub. Berisi informasi tentang Space di Hub. Objek ini dikembalikan oleh [space_info()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.space_info) dan [list_spaces()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_spaces). > [!TIP] > 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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.list_spaces), hanya sebagian kecil atribut yang dikembalikan. ### SpaceSearchResult[[huggingface_hub.SpaceSearchResult]] #### huggingface_hub.SpaceSearchResult[[huggingface_hub.SpaceSearchResult]] ```python huggingface_hub.SpaceSearchResult(data: dict) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_space_api.py#L309) **Parameter:** id (`str`) : ID dari Space (mis. `"username/repo-name"`). author (`str`) : Penulis dari Space. title (`str`) : Judul tampilan Space. emoji (`str` atau `None`) : Ikon emoji dari 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](/docs/huggingface_hub/v2.4.0/id/package_reference/space_runtime#huggingface_hub.SpaceRuntime) atau `None`) : Informasi runtime (tahap, perangkat keras, dll.). ai_short_description (`str` atau `None`) : Deskripsi singkat yang dihasilkan AI. ai_category (`str` atau `None`) : Kategori yang dihasilkan AI (misalnya `"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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.search_spaces). ### TensorInfo[[huggingface_hub.utils.TensorInfo]] #### huggingface_hub.utils.TensorInfo[[huggingface_hub.utils.TensorInfo]] ```python huggingface_hub.utils.TensorInfo(dtype: typing.Literal['F64', 'F32', 'F16', 'BF16', 'I64', 'I32', 'I16', 'I8', 'U8', 'U3', 'BOOL'], shape: list, data_offsets: tuple) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/utils/_safetensors.py#L14) **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[[huggingface_hub.User]] #### huggingface_hub.User[[huggingface_hub.User]] ```python huggingface_hub.User(**kwargs) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1658) **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[[huggingface_hub.UserLikes]] #### huggingface_hub.UserLikes[[huggingface_hub.UserLikes]] ```python huggingface_hub.UserLikes(user: str, total: int, datasets: list[str], kernels: list[str], models: list[str], spaces: list[str]) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L1522) **Parameter:** user (`str`) : Nama pengguna yang suka-sukanya kami ambil. total (`int`) : Total jumlah suka. datasets (`list[str]`) : Daftar dataset yang disukai oleh pengguna (sebagai repo_ids). kernels (`list[str]`) : Daftar kernel yang disukai oleh pengguna (sebagai repo_ids). models (`list[str]`) : Daftar model yang disukai oleh pengguna (sebagai repo_ids). spaces (`list[str]`) : Daftar ruang yang disukai oleh pengguna (sebagai repo_ids). Berisi informasi tentang suka pengguna di Hub. ### WebhookInfo[[huggingface_hub.WebhookInfo]] #### huggingface_hub.WebhookInfo[[huggingface_hub.WebhookInfo]] ```python huggingface_hub.WebhookInfo(id: str, url: str | None, job: JobSpec | None, watched: list[WebhookWatchedItem], domains: list[constants.WEBHOOK_DOMAIN_T], secret: str | None, disabled: bool) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L496) **Parameter:** id (`str`) : ID dari webhook. url (`str`, *opsional*) : URL dari webhook. job (`JobSpec`, *opsional*) : Spesifikasi Job yang akan dipicu. watched (`list[WebhookWatchedItem]`) : Daftar item yang dipantau oleh webhook, lihat [WebhookWatchedItem](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.WebhookWatchedItem). domains (`list[WEBHOOK_DOMAIN_T]`) : Daftar domain yang dipantau oleh webhook. Bisa berupa salah satu dari `["repo", "discussion"]`. secret (`str`, *opsional*) : Rahasia 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[[huggingface_hub.WebhookWatchedItem]] #### huggingface_hub.WebhookWatchedItem[[huggingface_hub.WebhookWatchedItem]] ```python huggingface_hub.WebhookWatchedItem(type: Literal['bucket', 'dataset', 'model', 'org', 'space', 'user'], name: str) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/hf_api.py#L480) **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[[huggingface_hub.CommitOperationAdd]] Berikut adalah nilai yang didukung untuk `CommitOperation()`: #### huggingface_hub.CommitOperationAdd[[huggingface_hub.CommitOperationAdd]] ```python huggingface_hub.CommitOperationAdd(path_in_repo: str, path_or_fileobj: str | pathlib.Path | bytes | typing.BinaryIO) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L141) **Parameter:** path_in_repo (`str`) : filepath 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 bytes (`bytes`) yang berisi konten file yang akan diunggah - "file object" (subclass dari `io.BufferedIOBase`), biasanya diperoleh dengan `open(path, "rb")`. Harus mendukung metode `seek()` dan `tell()`. **Mengangkat:** ``ValueError`` - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Jika `path_or_fileobj` bukan salah satu dari `str`, `Path`, `bytes` atau `io.BufferedIOBase`. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Jika `path_or_fileobj` adalah `str` atau `Path` tetapi bukan path ke file yang ada. - [`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError) -- Jika `path_or_fileobj` adalah `io.BufferedIOBase` tetapi tidak mendukung `seek()` dan `tell()`. Struktur data yang menyimpan informasi yang diperlukan untuk mengunggah file ke repositori di Hub. #### as_file[[huggingface_hub.CommitOperationAdd.as_file]] ```python as_file(with_tqdm: bool = False) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L223) **Parameter:** with_tqdm (`bool`, *opsional*, defaultnya `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 pembacaan data mendasar di balik `path_or_fileobj`. Contoh: ```python >>> operation = CommitOperationAdd( ... path_in_repo="remote/dir/weights.h5", ... path_or_fileobj="./local/weights.h5", ... ) CommitOperationAdd(path_in_repo='remote/dir/weights.h5', path_or_fileobj='./local/weights.h5') >>> with operation.as_file() as file: ... content = file.read() >>> with operation.as_file(with_tqdm=True) as file: ... while True: ... data = file.read(1024) ... if not data: ... break config.json: 100%|█████████████████████████| 8.19k/8.19k [00:02<00:00, 3.72kB/s] >>> with operation.as_file(with_tqdm=True) as file: ... httpx2.put(..., data=file) config.json: 100%|█████████████████████████| 8.19k/8.19k [00:02<00:00, 3.72kB/s] ``` #### b64content[[huggingface_hub.CommitOperationAdd.b64content]] ```python b64content() ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L275) Konten yang dikodekan base64 dari `path_or_fileobj` Mengembalikan: `bytes` #### huggingface_hub.CommitOperationDelete[[huggingface_hub.CommitOperationDelete]] ```python huggingface_hub.CommitOperationDelete(path_in_repo: str, is_folder: typing.Union[bool, typing.Literal['auto']] = 'auto') ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L56) **Parameter:** path_in_repo (`str`) : filepath 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 melihat 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. #### huggingface_hub.CommitOperationCopy[[huggingface_hub.CommitOperationCopy]] ```python huggingface_hub.CommitOperationCopy(src_path_in_repo: str, path_in_repo: str, src_revision: str | None = None, src_repo_id: str | None = None, src_repo_type: str | None = None, _src_oid: str | None = None, _dest_oid: str | None = None, _is_duplicated: bool = False) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_api.py#L87) **Parameter:** src_path_in_repo (`str`) : filepath relatif di repo dari file yang akan disalin, misalnya `"checkpoints/1fec34a/weights.bin"`. path_in_repo (`str`) : filepath 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"`). Bawaan ke repositori tujuan (salin intra-repo). src_repo_type (`str`, *opsional*) : Jenis repositori sumber (`"model"`, `"dataset"` atau `"space"`). Wajib diisi saat `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()](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.HfApi.create_commit). Perhatikan bahwa salinan lintas repositori hanya berfungsi dalam [storage region](https://huggingface.co/docs/hub/storage-regions) yang sama; penyalinan antar region tidak didukung. Catatan: Anda dapat menggabungkan [CommitOperationCopy](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.CommitOperationCopy) dan [CommitOperationDelete](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.CommitOperationDelete) untuk mengubah nama file LFS di Hub. ## CommitScheduler[[huggingface_hub.CommitScheduler]] #### huggingface_hub.CommitScheduler[[huggingface_hub.CommitScheduler]] ```python huggingface_hub.CommitScheduler(repo_id: str, folder_path: str | pathlib.Path, every: int | float = 5, path_in_repo: str | None = None, repo_type: str | None = None, revision: str | None = None, private: bool | None = None, token: str | None = None, allow_patterns: list[str] | str | None = None, ignore_patterns: list[str] | str | None = None, squash_history: bool = False, hf_api: typing.Optional[ForwardRef('HfApi')] = None) ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_scheduler.py#L30) **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 dari direktori di repo, misalnya: `"checkpoints/"`. Default ke folder root dari repository. repo_type (`str`, *opsional*) : Jenis repo yang akan dikomitm. Bawaan adalah `model`. revision (`str`, *opsional*) : Revisi repo yang akan dikomitm. Bawaan 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 melakukan commit ke repo. Secara default menggunakan token yang disimpan di mesin. allow_patterns (`list[str]` atau `str`, *opsional*) : Jika diberikan, 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 akan meratakan riwayat repo setelah setiap commit. Defaultnya adalah `False`. Meratakan commit berguna untuk menghindari penurunan performa pada repo ketika ukurannya menjadi terlalu besar. hf_api (`HfApi`, *opsional*) : Klien [HfApi](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.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](https://huggingface.co/docs/huggingface_hub/guides/upload#scheduled-uploads) untuk mempelajari lebih lanjut tentang cara menggunakannya. Contoh: ```py >>> from pathlib import Path >>> from huggingface_hub import CommitScheduler # Scheduler uploads every 10 minutes >>> csv_path = Path("watched_folder/data.csv") >>> CommitScheduler(repo_id="test_scheduler", repo_type="dataset", folder_path=csv_path.parent, every=10) >>> with csv_path.open("a") as f: ... f.write("first line") # Some time later (...) >>> with csv_path.open("a") as f: ... f.write("second line") ``` Contoh menggunakan context manager: ```py >>> from pathlib import Path >>> from huggingface_hub import CommitScheduler >>> with CommitScheduler(repo_id="test_scheduler", repo_type="dataset", folder_path="watched_folder", every=10) as scheduler: ... csv_path = Path("watched_folder/data.csv") ... with csv_path.open("a") as f: ... f.write("first line") ... (...) ... with csv_path.open("a") as f: ... f.write("second line") # Scheduler is now stopped and last commit have been triggered ``` #### push_to_hub[[huggingface_hub.CommitScheduler.push_to_hub]] ```python push_to_hub() ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_scheduler.py#L204) Dorong folder ke Hub dan kembalikan info commit. > [!WARNING] > 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 yang hanya dapat ditambahkan (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 mengomitmennya. Jika Anda ingin mengubah perilaku ini, Anda dapat mewarisi dari [CommitScheduler](/docs/huggingface_hub/v2.4.0/id/package_reference/hf_api#huggingface_hub.CommitScheduler) dan menimpa metode ini. Hal ini dapat berguna, misalnya, untuk mengompresi data bersama dalam satu file sebelum mengomitmennya. Untuk detail dan contoh lebih lanjut, lihat [panduan integrasi](https://huggingface.co/docs/huggingface_hub/main/en/guides/upload#scheduled-uploads) kami. #### stop[[huggingface_hub.CommitScheduler.stop]] ```python stop() ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_scheduler.py#L157) Hentikan penjadwal. Scheduler yang dihentikan tidak dapat dimulai ulang. Terutama untuk keperluan pengujian. #### pemicu[[huggingface_hub.CommitScheduler.trigger]] ```python trigger() ``` [Sumber](https://github.com/huggingface/huggingface_hub/blob/v2.4.0/src/huggingface_hub/_commit_scheduler.py#L181) 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.