Hugging Face's logo

Hub Python Library documentation

Autentikasi

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Autentikasi

Perpustakaan huggingface_hub memungkinkan pengguna untuk mengelola autentikasi ke Hub secara programatik. Ini mencakup masuk, keluar, beralih antar token, dan menampilkan daftar token yang tersedia.

Untuk detail lebih lanjut tentang autentikasi, lihat bagian ini.

login

huggingface_hub.login

< >

( token: str | None = Noneadd_to_git_credential: bool = Falseskip_if_logged_in: bool = True )

Parameter

  • token (str, opsional) — Token akses pengguna untuk dibuat dari https://huggingface.co/settings/token.
  • add_to_git_credential (bool, defaultnya False) — Jika True, token akan diset sebagai git credential. Jika tidak ada git credential helper yang dikonfigurasi, peringatan akan ditampilkan kepada pengguna. Hanya digunakan ketika token disediakan; diabaikan oleh alur berbasis browser.
  • skip_if_logged_in (bool, defaultnya True) — Jika True, jangan minta token jika pengguna sudah masuk. Setel ke False untuk memaksa masuk ulang. Di CLI, gunakan --force sebagai gantinya.

Membuang

ValueError atau DeviceCodeError

  • ValueError — Jika token organisasi yang diberikan. Hanya token akun pribadi yang valid untuk masuk.
  • ValueError — Jika token tidak valid.
  • DeviceCodeError — Jika login berbasis browser gagal (otorisasi ditolak, kode kedaluwarsa, …).

Login ke mesin untuk mengakses Hub.

token disimpan di cache dan diset sebagai kredensial git. Setelah selesai, mesin terlogin dan token akses akan tersedia di semua komponen huggingface_hub. Jika token tidak diberikan, alur OAuth berbasis browser digunakan untuk autentikasi: buka URL, masukkan kode pendek, lalu token diambil dan disimpan. Di terminal, Anda juga dapat memilih untuk menempelkan token akses yang sudah ada.

Untuk masuk dari luar skrip, Anda juga dapat menggunakan hf auth login yang merupakan perintah cli yang membungkus login().

Ketika token tidak diteruskan, login() akan secara otomatis mendeteksi apakah skrip dijalankan di notebook atau tidak. Namun, deteksi ini mungkin tidak akurat karena beragamnya notebook yang ada saat ini. Jika demikian, Anda selalu dapat memaksa penggunaan UI dengan menggunakan notebook_login() atau interpreter_login().

interpreter_login

huggingface_hub.interpreter_login

< >

( skip_if_logged_in: bool = True )

Parameter

  • skip_if_logged_in (bool, defaultnya True) — Jika True, jangan minta token jika pengguna sudah masuk. Setel ke False untuk memaksa masuk ulang. Di CLI, gunakan --force sebagai gantinya.

Menampilkan prompt untuk masuk ke situs web HF dan menyimpan token.

Ini setara dengan login() tanpa meneruskan token ketika tidak dijalankan di notebook. interpreter_login() berguna jika Anda ingin memaksa penggunaan prompt terminal alih-alih alur notebook.

Untuk detail lebih lanjut, lihat login().

notebook_login

huggingface_hub.notebook_login

< >

( skip_if_logged_in: bool = True )

Parameter

  • skip_if_logged_in (bool, defaultnya True) — Jika True, jangan minta token jika pengguna sudah masuk. Setel ke False untuk memaksa masuk ulang. Di CLI, gunakan --force sebagai gantinya.

Menampilkan prompt untuk masuk ke situs web HF dan menyimpan token.

Ini setara dengan login() tanpa meneruskan token saat dijalankan di notebook. notebook_login() berguna jika Anda ingin memaksa penggunaan alur notebook daripada prompt di terminal.

Untuk detail lebih lanjut, lihat login().

logout

huggingface_hub.logout

< >

( token_name: str | None = None )

Parameter

  • token_name (str, opsional) — Nama token akses untuk keluar. Jika None, akan keluar dari semua token akses yang tersimpan.

Membuang

ValueError

  • ValueError — Jika nama token akses tidak ditemukan.

Logout mesin dari Hub.

Token dihapus dari mesin dan dihapus dari kredensial git.

auth_switch

huggingface_hub.auth_switch

< >

( token_name: stradd_to_git_credential: bool = False )

Parameter

  • token_name (str) — Nama token akses untuk beralih ke.
  • add_to_git_credential (bool, defaultnya False) — Jika True, token akan diset sebagai git credential. Jika tidak ada git credential helper yang dikonfigurasi, peringatan akan ditampilkan kepada pengguna. Jika token adalah None, nilai dari add_to_git_credential akan diabaikan dan pengguna akhir akan diminta lagi.

Membuang

ValueError

  • ValueError — Jika nama token akses tidak ditemukan.

Beralih ke token akses yang berbeda.

auth_list

huggingface_hub.auth_list

< >

( )

Daftarkan semua token akses yang disimpan.

Update on GitHub

←Ikhtisar Variabel lingkungan→