Hub Python Library documentation
Xác thực
Xác thực
Thư viện huggingface_hub cho phép người dùng quản lý xác thực với Hub một cách lập trình. Điều này bao gồm đăng nhập, đăng xuất, chuyển đổi giữa các token và liệt kê các token khả dụng.
Để biết thêm chi tiết về xác thực, hãy xem mục này.
đăng nhập
huggingface_hub.login
< source >( token: str | None = Noneadd_to_git_credential: bool = Falseskip_if_logged_in: bool = True )
Tham số
- token (
str, tùy chọn) — Token truy cập của người dùng để tạo từ https://huggingface.co/settings/token. - add_to_git_credential (
bool, mặc định làFalse) — NếuTrue, token sẽ được đặt làm git credential. Nếu không có git credential helper nào được cấu hình, một cảnh báo sẽ được hiển thị cho người dùng. Chỉ được sử dụng khitokenđược cung cấp; bị bỏ qua trong luồng dựa trên trình duyệt. - skip_if_logged_in (
bool, mặc định làTrue) — NếuTrue, sẽ không yêu cầu nhập token nếu người dùng đã đăng nhập. Đặt thànhFalseđể buộc đăng nhập lại. Trong CLI, hãy dùng--forcethay thế.
Gây ra
ValueError hoặc DeviceCodeError
ValueError— Nếu một token của tổ chức được truyền vào. Chỉ các token của tài khoản cá nhân mới hợp lệ để đăng nhập.ValueError— Nếu token không hợp lệ.DeviceCodeError— Nếu đăng nhập dựa trên trình duyệt thất bại (bị từ chối ủy quyền, mã hết hạn, …).
Đăng nhập vào máy để truy cập Hub.
token được lưu trong cache và được đặt làm thông tin xác thực git. Khi hoàn tất, máy đã đăng nhập và access token sẽ khả dụng trên tất cả các thành phần của huggingface_hub. Nếu không cung cấp token, quy trình OAuth dựa trên trình duyệt sẽ được sử dụng để xác thực: mở một URL, nhập một mã ngắn, và token sẽ được lấy về và lưu lại. Trong terminal, bạn cũng có thể chọn dán một access token hiện có thay thế.
Để đăng nhập từ bên ngoài một script, bạn cũng có thể sử dụng hf auth login, đây là một lệnh cli bao bọc login().
Khi token không được truyền vào, login() sẽ tự động phát hiện xem script có đang chạy trong notebook hay không. Tuy nhiên, việc phát hiện này có thể không chính xác do sự đa dạng của các loại notebook hiện nay. Trong trường hợp đó, bạn luôn có thể ép buộc giao diện người dùng bằng cách sử dụng notebook_login() hoặc interpreter_login().
interpreter_login
huggingface_hub.interpreter_login
< source >( skip_if_logged_in: bool = True )
Hiển thị một lời nhắc để đăng nhập vào trang web HF và lưu trữ token.
Điều này tương đương với login() khi không truyền token nếu không chạy trong notebook. interpreter_login() hữu ích nếu bạn muốn ép buộc sử dụng prompt của terminal thay vì luồng notebook.
Để biết thêm chi tiết, xem login().
notebook_login
huggingface_hub.notebook_login
< source >( skip_if_logged_in: bool = True )
Hiển thị một lời nhắc để đăng nhập vào trang web HF và lưu trữ token.
Điều này tương đương với login() khi không truyền token nếu được chạy trong notebook. notebook_login() hữu ích nếu bạn muốn ép buộc sử dụng luồng notebook thay vì một prompt trong terminal.
Để biết thêm chi tiết, xem login().
Đăng xuất
huggingface_hub.logout
< source >( token_name: str | None = None )
Tham số
- token_name (
str, tùy chọn) — Tên của access token cần đăng xuất. Nếu làNone, sẽ đăng xuất khỏi tất cả các access token đã lưu.
Gây ra
ValueError
ValueError— Nếu không tìm thấy tên access token.
Đăng xuất máy khỏi Hub.
Token đã bị xóa khỏi máy và được gỡ khỏi git credential.
auth_switch
huggingface_hub.auth_switch
< source >( token_name: stradd_to_git_credential: bool = False )
Tham số
- token_name (
str) — Tên của token truy cập cần chuyển sang. - add_to_git_credential (
bool, mặc định làFalse) — NếuTrue, token sẽ được đặt làm git credential. Nếu không có git credential helper nào được cấu hình, một cảnh báo sẽ được hiển thị cho người dùng. NếutokenlàNone, giá trị củaadd_to_git_credentialsẽ bị bỏ qua và sẽ yêu cầu nhập lại từ người dùng cuối.
Gây ra
ValueError
ValueError— Nếu không tìm thấy tên access token.
Chuyển sang một token truy cập khác.
auth_list
Liệt kê tất cả các token truy cập đã lưu.