Hugging Face's logo

Hub Python Library documentation

HfApi 클라이언트

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

HfApi 클라이언트

아래는 Hugging Face Hub API의 Python 래퍼 역할을 하는 HfApi 클래스의 문서입니다.

HfApi의 모든 메서드는 패키지 루트에서도 직접 접근할 수 있습니다. 두 가지 접근 방식은 아래에 자세히 설명되어 있습니다.

루트 메서드를 사용하는 것이 더 직관적이지만 HfApi 클래스는 더 많은 유연성을 제공합니다. 특히, 모든 HTTP 호출에서 재사용되는 토큰을 전달할 수 있습니다. 이는 토큰이 머신에 영구적으로 저장되지 않으므로 hf auth login 또는 login()과 다릅니다. 또한 다른 엔드포인트를 제공하거나 사용자 지정 user-agent를 구성할 수도 있습니다.

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

< >

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

매개변수

  • endpoint (str, 선택 사항) — Hub의 엔드포인트입니다. 기본값은 https://huggingface.co입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • library_name (str, 선택 사항) — HTTP 요청을 보내는 라이브러리의 이름입니다. user-agent 헤더에 추가됩니다. 예: "transformers".
  • library_version (str, 선택 사항) — HTTP 요청을 보내는 라이브러리의 버전입니다. user-agent 헤더에 추가됩니다. 예: "4.24.0".
  • user_agent (str, dict, 선택 사항) — 사전 또는 단일 문자열 형태의 사용자 에이전트 정보입니다. 설치된 패키지에 대한 정보로 보완됩니다.
  • headers (dict, 선택) — 각 요청과 함께 전송할 추가 헤더입니다. 예: {"X-My-Header": "value"}. 여기서 전달된 헤더는 기본 헤더보다 우선합니다.

HTTP를 통해 Hugging Face Hub와 상호작용하는 클라이언트.

클라이언트는 Hub에 대한 모든 요청(HF 엔드포인트, 인증, 사용자 에이전트 등)에 사용되는 고급 설정으로 초기화됩니다. HfApi 클라이언트를 사용하는 것이 권장되지만 필수 사항은 아니며, 모든 공개 메서드가 huggingface_hub의 루트에서 직접 노출되기 때문입니다.

accept_access_request

< >

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

매개변수

  • repo_id (str) — 액세스 요청을 수락할 저장소의 id입니다.
  • user (str, 선택 사항) — 접근 요청을 수락할 사용자의 사용자 이름입니다. user 또는 request_id 중 정확히 하나만 제공해야 합니다.
  • request_id (str, 선택 사항) — 수락할 액세스 요청의 ID입니다(AccessRequest 참조). 저장소가 요청자의 사용자 이름을 공유하지 않도록 구성된 경우 필수입니다. user 또는 request_id 중 정확히 하나만 제공해야 합니다.
  • repo_type (str, 선택 사항) — 액세스 요청을 허용할 저장소의 유형입니다. model, dataset, space 중 하나여야 합니다. 기본값은 model입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — 리포지토리가 게이트되지 않은 경우 HTTP 400.
  • HfHubHTTPError — 리포지토리에 읽기 전용 액세스 권한만 있는 경우 HTTP 403이 발생합니다. 리포지토리가 속해 있는 조직에서 write 또는 admin 역할을 가지고 있지 않거나, read 토큰을 전달한 경우 이러한 상황이 발생할 수 있습니다.
  • HfHubHTTPError — Hub에 해당 사용자가 존재하지 않으면 HTTP 404를 반환합니다.
  • HfHubHTTPError — 사용자 액세스 요청을 찾을 수 없는 경우 HTTP 404.
  • HfHubHTTPError — 사용자 액세스 요청이 이미 승인 목록에 있는 경우 HTTP 404.

지정된 gated repo에 대한 사용자의 액세스 요청을 수락합니다.

요청이 승인되면 사용자는 저장소의 모든 파일을 다운로드하고 커뮤니티 탭에 액세스할 수 있습니다. 승인 모드가 자동인 경우 요청을 수동으로 승인할 필요가 없습니다. 승인된 요청은 cancel_access_request() 및 reject_access_request()를 사용하여 언제든지 취소하거나 거부할 수 있습니다.

게이트된 리포지토리에 대한 자세한 내용은 https://huggingface.co/docs/hub/models-gated를 참고하세요.

add_collection_item

< >

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

매개변수

  • collection_slug (str) — 업데이트할 collection의 slug입니다. 예: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • item_id (str) — 컬렉션에 추가할 항목의 ID입니다. 저장소/스페이스/데이터셋의 경우 repo_id, 논문의 경우 paper id, 다른 컬렉션의 슬러그(예: "moonshotai/kimi-k2") 또는 버킷 ID(예: "namespace/bucket-name")를 사용합니다.
  • item_type (str) — 추가할 항목의 유형입니다. "model", "dataset", "space", "paper", "collection" 또는 "bucket" 중 하나여야 합니다.
  • note (str, 선택 사항) — 컬렉션의 항목에 첨부할 노트입니다. 노트의 최대 길이는 500자입니다.
  • exists_ok (bool, 선택 사항) — True인 경우, 항목이 이미 존재해도 오류를 발생시키지 않습니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — 리포지토리에 읽기 전용 액세스 권한만 있는 경우 HTTP 403이 발생합니다. 리포지토리가 속해 있는 조직에서 write 또는 admin 역할을 가지고 있지 않거나, read 토큰을 전달한 경우 이러한 상황이 발생할 수 있습니다.
  • HfHubHTTPError — 컬렉션에 추가하려는 항목이 Hub에 존재하지 않으면 HTTP 404가 발생합니다.
  • HfHubHTTPError — 컬렉션에 추가하려는 항목이 이미 컬렉션에 있는 경우 (그리고 exists_ok=False) HTTP 409

Hub의 컬렉션에 항목을 추가합니다.

반환값: Collection

예:

>>> from huggingface_hub import add_collection_item
>>> collection = add_collection_item(
...     collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab",
...     item_id="pierre-loic/climate-news-articles",
...     item_type="dataset"
... )
>>> collection.items[-1].item_id
"pierre-loic/climate-news-articles"
# ^item got added to the collection on last position

# Add item with a note
>>> add_collection_item(
...     collection_slug="davanstrien/climate-64f99dc2a5067f6b65531bab",
...     item_id="datasets/climate_fever",
...     item_type="dataset",
...     note="This dataset adopts the FEVER methodology that consists of 1,535 real-world claims regarding climate-change collected on the internet."
... )
(...)

add_space_secret

< >

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

매개변수

  • repo_id (str) — 업데이트할 저장소의 ID입니다. 예: "bigcode/in-the-stack".
  • key (str) — 비밀 키. 예: "GITHUB_API_KEY"
  • value (str) — 비밀 값. 예: "your_github_api_key".
  • description (str, optional) — Secret description. Example: "Github API key to access the Github API".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Space에 시크릿을 추가하거나 업데이트합니다.

Secrets를 사용하면 Space에 시크릿 키나 토큰을 하드코딩하지 않고 설정할 수 있습니다. 자세한 내용은 https://huggingface.co/docs/hub/spaces-overview#managing-secrets를 참조하세요.

add_space_variable

< >

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

매개변수

  • repo_id (str) — 업데이트할 저장소의 ID입니다. 예: "bigcode/in-the-stack".
  • key (str) — 변수 키. 예: "MODEL_REPO_ID"
  • value (str) — 변수 값. 예: "the_model_repo_id".
  • description (str) — 변수의 설명입니다. 예: "Model Repo ID of the implemented model".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Space에 변수를 추가하거나 업데이트합니다.

Variables를 사용하면 Space에 환경 변수를 하드코딩하지 않고 설정할 수 있습니다. 자세한 내용은 https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables를 참조하세요.

auth_check

< >

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

매개변수

  • repo_id (str) — 액세스를 확인할 저장소입니다. 형식은 "user/repo_name"여야 합니다. 예: "user/my-cool-model".
  • repo_type (str, 선택 사항) — 저장소의 유형입니다. "model", "dataset", "space" 중 하나여야 합니다. 지정하지 않으면 기본값은 "model"입니다.
  • token (Union[bool, str, None], 선택) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참조: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.
  • write (bool, 선택 사항) — True인 경우, 사용자가 저장소에 콘텐츠 쓰기 권한이 있는지 확인합니다. False(기본값)인 경우, 읽기 접근 권한만 확인합니다.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 GatedRepoError

  • RepositoryNotFoundError — 리포지토리가 존재하지 않거나, 비공개이거나, 사용자가 액세스 권한이 없는 경우 발생. repo_id 또는 repo_type가 잘못되었거나, 리포지토리가 비공개이지만 사용자가 인증되지 않은 경우에도 발생할 수 있습니다.

  • GatedRepoError — 리포지토리가 존재하지만 게이트가 설정되어 있고 사용자가 액세스 권한이 없는 경우 발생합니다.

Hugging Face Hub의 특정 저장소에 대해 제공된 사용자 토큰이 접근 권한을 가지고 있는지 확인합니다.

이 메서드는 제공된 토큰으로 인증된 사용자가 지정된 repository에 접근할 수 있는지 확인합니다. repository를 찾을 수 없거나 사용자가 해당 repository에 접근하는 데 필요한 권한이 없는 경우, 이 메서드는 적절한 예외를 발생시킵니다.

예:

사용자가 저장소에 액세스할 수 있는지 확인합니다:

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

이 예시에서:

  • 사용자가 액세스 권한을 가지고 있으면 메서드가 성공적으로 완료됩니다.
  • 리포지토리가 게이트드 상태이거나 존재하지 않는 경우, 적절한 예외가 발생하여 사용자가 이에 따라 처리할 수 있습니다.

batch_bucket_files

< >

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

매개변수

  • bucket_id (str) — 버킷의 ID(예: "username/my-bucket").
  • add (list of tuple, 선택 사항) — 업로드할 파일입니다. 각 요소는 (source, destination) 튜플이며, 여기서 source는 로컬 파일의 경로(str 또는 Path) 또는 원시 bytes 콘텐츠이고, destination는 버킷 내의 경로입니다.
  • copy (list 의 tuple, 선택 사항) — xet 해시로 복사할 파일. 각 요소는 다음을 포함하는 (source_repo_type, source_repo_id, xet_hash, destination) 튜플입니다:
    • source_repo_type는 소스 저장소의 유형으로, "model", "dataset", "space" 또는 "bucket"입니다.
    • source_repo_id는 소스 저장소 또는 버킷의 ID입니다(예: "username/my-model").
    • xet_hash는 복사할 파일의 xet 해시입니다.
    • destination는 버킷 내의 대상 경로입니다. 이것은 서버 측 작업이며, 데이터가 다운로드되거나 다시 업로드되지 않습니다.
  • delete (list of str, 선택 사항) — 버킷에서 삭제할 파일의 경로.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

다음 예외가 발생합니다

BucketBatchError

  • BucketBatchError — 서버가 일부 작업이 실패했다고 보고하는 경우. 모든 작업이 전송된 후에 오류가 발생하므로, 배치의 다른 작업은 적용되었습니다.

버킷에서 파일을 추가, 복사 및/또는 삭제합니다.

이것은 비트랜잭션(non-transactional) 작업입니다. 처리 과정에서 오류가 발생하면 일부 파일은 업로드, 복사 또는 삭제되었을 수 있고, 다른 파일은 그렇지 않을 수 있습니다.

예:

>>> from huggingface_hub import batch_bucket_files

# Upload files
>>> batch_bucket_files(
...     "username/my-bucket",
...     add=[
...         ("./model.safetensors", "models/model.safetensors"),
...         (b'{{"key": "value"}}', "config.json"),
...     ],
... )

# Copy xet files from another bucket or repo (server-side, no data transfer)
>>> batch_bucket_files(
...     "username/my-bucket",
...     copy=[
...         ("bucket", "username/source-bucket", "<xethash_1>", "models/model.safetensors"),
...         ("model", "username/my-model", "<xethash_2>", "models/config.safetensors"),
...     ],
... )

# Delete files
>>> batch_bucket_files("username/my-bucket", delete=["old-model.bin"])

# Upload and delete in one batch
>>> batch_bucket_files(
...     "username/my-bucket",
...     add=[("./new.txt", "new.txt")],
...     delete=["old.txt"],
... )

bucket_info

< >

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

매개변수

  • bucket_id (str) — 버킷의 ID(예: "username/my-bucket").
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

BucketInfo

버킷 정보입니다.

다음 예외가 발생합니다

BucketNotFoundError 또는 or

  • BucketNotFoundError — 버킷을 찾을 수 없는 경우. 버킷이 존재하지 않기 때문일 수 있습니다.
  • or — private로 설정되어 있어 접근 권한이 없기 때문입니다.

Hub에서 특정 버킷에 대한 정보를 가져옵니다.

예:

>>> from huggingface_hub import bucket_info
>>> info = bucket_info(bucket_id="Wauplin/first-bucket")
>>> info.id
'Wauplin/first-bucket'
>>> info.private
False
>>> info.created_at
datetime.datetime(2026, 2, 6, 17, 37, 57, tzinfo=datetime.timezone.utc)
>>> info.size
551879671
>>> info.total_files
12

cancel_access_request

< >

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

매개변수

  • repo_id (str) — 액세스 요청을 취소할 저장소의 id입니다.
  • user (str, 선택 사항) — 액세스 요청을 취소할 사용자의 사용자 이름입니다. user 또는 request_id 중 정확히 하나만 제공해야 합니다.
  • request_id (str, 선택 사항) — 취소할 액세스 요청의 id입니다(AccessRequest 참조). 저장소가 요청자의 사용자 이름을 공유하지 않도록 구성된 경우 필수입니다. user 또는 request_id 중 정확히 하나만 제공해야 합니다.
  • repo_type (str, 선택 사항) — 액세스 요청을 취소할 저장소의 유형입니다. model, dataset, space 중 하나여야 합니다. 기본값은 model입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — 리포지토리가 게이트되지 않은 경우 HTTP 400.
  • HfHubHTTPError — 리포지토리에 읽기 전용 액세스 권한만 있는 경우 HTTP 403이 발생합니다. 리포지토리가 속해 있는 조직에서 write 또는 admin 역할을 가지고 있지 않거나, read 토큰을 전달한 경우 이러한 상황이 발생할 수 있습니다.
  • HfHubHTTPError — Hub에 해당 사용자가 존재하지 않으면 HTTP 404를 반환합니다.
  • HfHubHTTPError — 사용자 액세스 요청을 찾을 수 없는 경우 HTTP 404.
  • HfHubHTTPError — 사용자의 액세스 요청이 이미 대기 목록에 있는 경우 HTTP 404.

gated 리포지토리에 대한 사용자의 액세스 요청을 취소합니다.

취소된 요청은 대기 목록으로 돌아가며, 사용자는 저장소에 대한 액세스 권한을 잃습니다.

게이트된 리포지토리에 대한 자세한 내용은 https://huggingface.co/docs/hub/models-gated를 참고하세요.

cancel_job

< >

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

매개변수

  • job_id (str) — Job의 ID입니다.
  • namespace (str, 선택 사항) — Job이 실행되는 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face 인프라에서 compute Job을 취소합니다.

change_discussion_status

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • discussion_num (int) — Discussion 또는 Pull Request의 번호입니다. 엄밀히 양의 정수여야 합니다.
  • new_status (str) — 토론의 새 상태입니다. "open" 또는 "closed" 중 하나여야 합니다.
  • comment (str, 선택 사항) — 상태 변경과 함께 게시할 선택적 댓글입니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 업로드하는 경우 "dataset" 또는 "space"로, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

DiscussionStatusChange

상태 변경 이벤트

Discussion 또는 Pull Request를 닫거나 다시 엽니다.

예:

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

다음 오류를 발생시킵니다:

  • HuggingFace API가 오류를 반환하면 HTTPError
  • ValueError 일부 매개변수 값이 잘못된 경우
  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.

comment_discussion

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • discussion_num (int) — Discussion 또는 Pull Request의 번호입니다. 엄밀히 양의 정수여야 합니다.
  • comment (str) — 생성할 코멘트의 내용입니다. 코멘트는 마크다운 형식을 지원합니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 업로드하는 경우 "dataset" 또는 "space"로, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

DiscussionComment

새로 생성된 댓글

주어진 Discussion에 새 댓글을 생성합니다.

예:


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

다음 오류를 발생시킵니다:

  • HuggingFace API가 오류를 반환하면 HTTPError
  • ValueError 일부 매개변수 값이 잘못된 경우
  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.

copy_files

< >

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

매개변수

  • source (str) — hf:// URI 형식의 소스 위치입니다. 버킷 경로(예: "hf://buckets/my-bucket/path/to/file") 또는 저장소 경로(예: "hf://username/my-model/weights.bin", "hf://datasets/username/my-dataset/data/")일 수 있습니다.
  • destination (str) — hf:// URI를 사용하여 버킷(예: "hf://buckets/my-bucket/target/path") 또는 저장소(예: "hf://username/my-model/target/path")를 가리키는 대상 위치
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

다음 예외가 발생합니다

ValueError

  • ValueError — 소스/대상 URI가 잘못된 경우 또는 버킷에서 저장소로 복사하는 경우.

Hub의 위치 간 파일을 복사합니다.

버킷 또는 리포지토리(모델, 데이터셋, 스페이스)에서 버킷 또는 다른 리포지토리로 파일을 복사합니다. 개별 파일과 전체 폴더 모두 지원합니다.

폴더를 복사할 때, 소스 경로 끝에 /가 있으면 rsync 스타일 의미론이 적용됩니다. 즉, 소스 폴더 자체를 중첩하지 않고 내용만 대상에 복사합니다. /가 없으면, 소스 폴더가 대상 안에 중첩됩니다(cp -r와 유사).

리포지토리에서 버킷으로 복사할 때, .gitattributes 파일은 git 전용 메타데이터이며 버킷 컨텍스트와 관련이 없으므로 자동으로 제외됩니다.

리포지토리 간 복사는 내부적으로 CommitOperationCopy를 사용하며 대상 리포지토리에 커밋을 생성합니다. 버킷에서 리포지토리로의 복사는 지원되지 않습니다.

서버 측 복사본은 동일한 스토리지 리전 내에서만 작동합니다.

예:

>>> from huggingface_hub import copy_files

# Copy a single file between buckets
>>> copy_files("hf://buckets/my-bucket/data.bin", "hf://buckets/other-bucket/data.bin")

# Copy a folder into another bucket (nests: backup/models/...)
>>> copy_files("hf://buckets/my-bucket/models", "hf://buckets/other-bucket/backup/")

# Copy folder contents (trailing /): files go directly into backup/
>>> copy_files("hf://buckets/my-bucket/models/", "hf://buckets/other-bucket/backup/")

# Copy a file from a model repo to a bucket
>>> copy_files("hf://username/my-model/model.safetensors", "hf://buckets/my-bucket/")

# Copy an entire dataset to a bucket
>>> copy_files("hf://datasets/username/my-dataset/", "hf://buckets/my-bucket/datasets/")

# Copy files between repositories
>>> copy_files("hf://username/source-model/", "hf://username/dest-model/")

# Copy a file from one repo to another
>>> copy_files("hf://username/source-model/config.json", "hf://username/dest-model/config.json")

create_branch

< >

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

매개변수

  • repo_id (str) — 브랜치가 생성될 저장소입니다. 예: "user/my-cool-model".
  • branch (str) — 생성할 브랜치의 이름입니다.
  • revision (str, 선택 사항) — 분기(branch)를 생성할 git revision입니다. 분기 이름 또는 커밋의 OID/SHA를 16진수 문자열로 사용할 수 있습니다. 기본값은 "main" 분기의 head입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 브랜치를 생성하는 경우 "dataset" 또는 "space"로, 모델을 태그하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • exist_ok (bool, 선택 사항, 기본값 False) — True인 경우, 브랜치가 이미 존재해도 오류를 발생시키지 않습니다.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 BadRequestError 또는 HfHubHTTPError

  • RepositoryNotFoundError — 리포지토리가 찾을 수 없는 경우(에러 404): repo_id/repo_type가 잘못되었거나, 비공개이지만 인증되지 않았거나, 리포지토리가 존재하지 않는 경우.
  • BadRequestError — 브랜치의 잘못된 참조인 경우. 예: refs/pr/5 또는 ‘refs/foo/bar’.
  • HfHubHTTPError — 리포지토리에 해당 브랜치가 이미 존재하는 경우(에러 409)에 exist_ok가 False로 설정되어 있을 때 발생합니다.

Hub의 저장소에서 지정된 리비전(기본값은 main)을 기반으로 새 브랜치를 생성합니다. 필요에 맞는 리비전을 찾으려면 list_repo_refs() 또는 list_repo_commits()를 사용할 수 있습니다.

create_bucket

< >

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

매개변수

  • bucket_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 버킷 이름입니다. 네임스페이스가 제공되지 않으면 버킷은 현재 사용자의 네임스페이스에 생성됩니다.
  • private (bool, 선택 사항) — 버킷을 비공개로 만들지 여부를 지정합니다. None(기본값)인 경우, 조직의 기본 설정이 비공개가 아닌 한 버킷은 공개됩니다. visibility와 함께 전달할 수 없습니다.
  • visibility (Literal["public", "private"], 선택 사항) — 버킷의 가시성입니다. "public" 또는 "private"일 수 있습니다. None(기본값)인 경우, 조직의 기본값이 private가 아닌 한 버킷은 public이 됩니다.
  • resource_group_id (str, 선택 사항) — 버킷을 생성할 리소스 그룹입니다. 리소스 그룹은 Enterprise Hub 조직에서만 사용할 수 있으며, 조직 내에서 해당 리소스에 액세스할 수 있는 멤버를 정의하는 데 사용됩니다. 리소스 그룹의 ID는 Hub에서 해당 리소스 페이지의 URL에서 확인할 수 있습니다(예: "66670e5163145ca562cb1988"). 리소스 그룹에 대해 자세히 알아보려면 https://huggingface.co/docs/hub/en/security-resource-groups를 참조하세요.
  • region (Literal["us", "eu"], 선택 사항) — 버킷을 생성할 클라우드 리전입니다. "us" 또는 "eu" 중 하나여야 합니다. 지정하지 않으면 기본 리전에 버킷이 생성됩니다. Team 플랜 이상에서 사용할 수 있습니다.
  • exist_ok (bool, 선택 사항, 기본값 False) — True인 경우, 버킷이 이미 존재해도 오류를 발생시키지 않습니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

BucketUrl

endpoint, namespace, bucket_id와 같은 속성을 포함하는 새로 생성된 버킷의 URL입니다.

Hub에서 버킷을 생성합니다.

예:

>>> from huggingface_hub import create_bucket

>>> url = create_bucket(bucket_id="my-bucket")
>>> url.bucket_id
'user/my-bucket'
>>> url.url
'https://huggingface.co/buckets/user/my-bucket'
>>> url.uri.to_uri()
'hf://buckets/user/my-bucket'

>>> create_bucket(bucket_id="my-bucket", private=True, exist_ok=True)
BucketUrl(...)

>>> create_bucket(bucket_id="my-bucket", region="us")
BucketUrl(...)

create_collection

< >

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

매개변수

  • title (str) — 생성할 컬렉션의 제목. 예: "Recent models".
  • namespace (str, 선택 사항) — 생성할 collection의 네임스페이스(사용자 이름 또는 조직 이름)입니다. 기본값은 소유자 이름입니다.
  • description (str, 선택 사항) — 생성할 컬렉션의 설명입니다. 설명의 최대 길이는 150자입니다.
  • private (bool, 선택 사항) — 컬렉션이 비공개여야 하는지 여부입니다. 기본값은 False(즉, 공개 컬렉션)입니다.
  • resource_group_id (str, 선택 사항) — 컬렉션을 소유 조직의 리소스 그룹에 할당합니다. 조직 소유 컬렉션에만 유효합니다. 리소스 그룹 ID는 24자리의 16진수 문자열입니다.
  • exists_ok (bool, 선택 사항) — True인 경우, 컬렉션이 이미 존재해도 오류를 발생시키지 않습니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Hub에서 새 Collection을 생성합니다.

반환값: Collection

예:

>>> from huggingface_hub import create_collection
>>> collection = create_collection(
...     title="ICCV 2023",
...     description="Portfolio of models, papers and demos I presented at ICCV 2023",
... )
>>> collection.slug
"username/iccv-2023-64f9a55bb3115b4f513ec026"

create_commit

< >

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

매개변수

  • repo_id (str) — 커밋이 생성될 저장소입니다. 예를 들어: "username/custom_transformers"
  • operations (Iterable 의 ~hf_api.CommitOperation) — 커밋에 포함할 작업의 반복 가능한 객체. 다음 중 하나입니다:
    • ~hf_api.CommitOperationAdd를 사용하여 파일을 업로드합니다
    • ~hf_api.CommitOperationDelete를 사용하여 파일을 삭제합니다
    • ~hf_api.CommitOperationCopy를 사용하여 파일을 복사합니다

    Operation 객체는 업로드에 대한 정보를 포함하도록 변경됩니다. 여러 커밋에 동일한 객체를 재사용하지 마세요.

  • commit_message (str) — 생성될 커밋의 요약(첫 번째 줄)입니다.
  • commit_description (str, 선택 사항) — 생성될 커밋의 설명
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • repo_type (str, 선택 사항) — dataset, space 또는 kernel 저장소에 업로드하는 경우 "dataset", "space" 또는 "kernel"로 설정하고, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • revision (str, 선택 사항) — 커밋할 git 리비전입니다. 기본값은 "main" 브랜치의 헤드입니다.
  • create_pr (boolean, 선택 사항) — 해당 커밋으로 Pull Request를 생성할지 여부입니다. 기본값은 False입니다. revision이 설정되지 않은 경우, PR은 "main" 브랜치를 대상으로 열립니다. revision이 설정되어 있고 브랜치인 경우, PR은 해당 브랜치를 대상으로 열립니다. revision이 설정되어 있고 브랜치 이름이 아닌 경우(예: 커밋 oid), 서버는 RevisionNotFoundError를 반환합니다.
  • num_threads (int, 선택 사항) — 파일을 업로드할 때 사용할 동시 스레드 수입니다. 기본값은 5입니다. 2로 설정하면 최대 2개의 파일이 동시에 업로드됩니다.
  • parent_commit (str, 선택 사항) — 부모 커밋의 OID / SHA를 16진수 문자열로 나타낸 것입니다. 축약 표기(첫 7자)도 지원합니다. 지정되어 있고 create_pr가 False인 경우, revision이 parent_commit을 가리키지 않으면 커밋이 실패합니다. 지정되어 있고 create_pr 가 True인 경우, parent_commit에서 pull request가 생성됩니다. parent_commit을 지정하면 변경 사항을 커밋하기 전에 저장소가 변경되지 않았는지 확인할 수 있으며, 저장소가 동시에 업데이트 / 커밋되는 경우 특히 유용할 수 있습니다.
  • run_as_future (bool, 선택) — 이 메서드를 백그라운드에서 실행할지 여부입니다. 백그라운드 작업은 메인 스레드를 차단하지 않고 순차적으로 실행됩니다. run_as_future=True를 전달하면 Future 객체를 반환합니다. 기본값은 False입니다.

반환값

CommitInfo 또는 Future

새로 생성된 커밋에 대한 정보(커밋 해시, 커밋 URL, PR URL, 커밋 메시지 등)를 포함하는 CommitInfo 인스턴스입니다. run_as_future=True가 전달되면, 실행 시 결과를 포함하는 Future 객체를 반환합니다.

다음 예외가 발생합니다

ValueError 또는 RepositoryNotFoundError

  • ValueError — 커밋 메시지가 비어 있는 경우.
  • ValueError — 부모 커밋이 유효한 커밋 OID가 아닌 경우.
  • ValueError — 잘못된 metadata 섹션을 가진 README.md 파일이 커밋된 경우. 이 경우, 어떤 파일도 업로드를 시도하기 전에 커밋이 초기에 실패합니다.
  • ValueError — create_pr가 True이고 revision이 None도 "main"도 아닌 경우.
  • RepositoryNotFoundError — 리포지토리가 찾을 수 없는 경우(에러 404): repo_id/repo_type가 잘못되었거나, 비공개이지만 인증되지 않았거나, 리포지토리가 존재하지 않는 경우.

지정된 저장소에서 커밋을 생성하며, 필요에 따라 파일을 삭제하고 업로드합니다.

CommitOperation 입력 목록은 커밋 처리 중에 변경됩니다. 동일한 객체를 여러 커밋에 재사용하지 마세요.

create_commit은 Hub에 이미 저장소가 존재한다고 가정합니다. Client error 404가 발생하면 인증이 되어 있는지, 토큰에 필요한 권한이 있는지, repo_id와 repo_type가 올바르게 설정되어 있는지 확인하세요. 저장소가 존재하지 않는 경우 create_repo()를 사용하여 먼저 생성하세요.

create_commit은 25k개의 LFS 파일과 일반 파일의 1GB 페이로드로 제한됩니다.

create_discussion

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • title (str) — 토론의 제목입니다. 최대 200자, 최소 3자여야 하며, 앞뒤 공백은 제거됩니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • description (str, 선택) — Pull Request에 대한 선택적 설명입니다. 기본값은 "Discussion opened with the huggingface_hub Python library"입니다.
  • pull_request (bool, 선택 사항) — Pull Request 또는 discussion을 생성할지 여부입니다. True인 경우 Pull Request를 생성합니다. False인 경우 discussion을 생성합니다. 기본값은 False입니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 업로드하는 경우 "dataset" 또는 "space"로, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.

Discussion 또는 Pull Request를 생성합니다.

프로그램을 통해 생성된 Pull Requests는 "draft" 상태가 됩니다.

변경 사항을 포함하여 Pull Request를 생성하는 작업은 HfApi.create_commit()을 사용하여 한 번에 수행할 수도 있습니다.

반환값: DiscussionWithDetails

다음 오류를 발생시킵니다:

  • HuggingFace API가 오류를 반환하면 HTTPError
  • ValueError 일부 매개변수 값이 잘못된 경우
  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.

create_inference_endpoint

< >

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

매개변수

  • name (str) — 새로운 Inference Endpoint의 고유한 이름입니다.
  • repository (str) — Inference Endpoint와 연결된 모델 저장소의 이름 (예: "gpt2").
  • framework (str) — 모델에 사용되는 머신러닝 프레임워크 (예: "custom").
  • accelerator (str) — 추론에 사용할 하드웨어 가속기(예: "cpu").
  • instance_size (str) — 모델 호스팅에 사용할 인스턴스의 크기 또는 유형 (예: "x4").
  • instance_type (str) — Inference Endpoint가 배포될 클라우드 인스턴스 유형(예: "intel-icl")
  • region (str) — Inference Endpoint가 생성될 클라우드 리전(예: "us-east-1").
  • vendor (str) — Inference Endpoint가 호스팅될 클라우드 제공업체 또는 벤더(예: "aws").
  • account_id (str, 선택 사항) — 비추천되며 무시됩니다. AWS PrivateLink를 구성하려면 private_link_account_id와 private_link_region를 사용하세요.
  • private_link_account_id (str, 선택) — AWS PrivateLink를 통해 Inference Endpoint에 접근할 수 있는 AWS 계정 ID입니다. private_link_region이 필요합니다.
  • private_link_region (str, 선택 사항) — PrivateLink 엔트리 포인트의 AWS 리전("us-east-1" 또는 "eu-west-1")입니다. private_link_account_id의 VPC 엔드포인트가 연결될 리전입니다. 컴퓨트 region 및 vendor와 무관합니다.
  • min_replica (int, 선택 사항) — Inference Endpoint에서 계속 실행할 최소 리플리카(인스턴스) 수입니다. 스케일링을 0으로 설정하려면 이 값을 0으로 설정하고 scale_to_zero_timeout을 그에 맞게 조정하세요. 기본값은 1입니다.
  • max_replica (int, 선택 사항) — Inference Endpoint를 확장할 최대 리플리카(인스턴스) 수입니다. 기본값은 1입니다.
  • scaling_metric (str 또는 InferenceEndpointScalingMetric , 선택 사항) — 스케일링에 사용할 메트릭 참조입니다. 지정된 경우 “pendingRequests” 또는 “hardwareUsage” 중 하나여야 합니다. 기본값은 None이며, 이는 HF Endpoints 서비스가 메트릭을 지정하도록 한다는 의미입니다.
  • scaling_threshold (float, 선택 사항) — 스케일 업을 트리거하는 데 사용되는 스케일링 메트릭 임계값입니다. 스케일링 메트릭이 제공되지 않으면 무시됩니다. 기본값은 None입니다(의미: HF Endpoints 서비스가 임계값을 지정하도록 허용).
  • scale_to_zero_timeout (int, 선택 사항) — 비활성 엔드포인트가 0으로 스케일링되기까지의 시간(분)입니다. min_replica가 0이 아닌 경우 None으로 설정하면 0으로 스케일링하지 않습니다. 기본값은 None입니다.
  • revision (str, 선택 사항) — Inference Endpoint에 배포할 특정 모델 리비전(예: "6c0e6080953db56375760c0471a8c5f2929baf11").
  • task (str, 선택 사항) — 모델을 배포할 작업(예: "text-classification").
  • custom_image (dict, 선택 사항) — 실행할 컨테이너 이미지입니다. 이미지 변형별로 키를 가진 dict(예: {"vLLM": {"url": "vllm/vllm-openai:v0.23.0", "port": 8000}‌}, sGLang, tgi, tei, llamacpp, hfServe, …)로, 이 경우 그대로 전달되거나, 커스텀 컨테이너를 설명하는 평탄한 dict(예: {"url": ..., "port": ...})로, 이 경우 {"custom": ...}로 전송됩니다(예를 참조). 기본값은 Hugging Face가 관리하는 이미지입니다.
  • container_registry_username (str, 선택 사항) — 커스텀 컨테이너 이미지를 호스팅하는 레지스트리에 인증하는 데 사용되는 사용자 이름입니다.
  • container_registry_password (str, 선택 사항) — 커스텀 컨테이너 이미지를 호스팅하는 레지스트리에 인증하는 데 사용되는 비밀번호입니다. container_registry_username이 필요합니다. 제공되지 않으면 API 페이로드에서 생략됩니다.
  • container_command (list[str], 선택 사항) — 컨테이너 엔트리포인트 명령을 재정의합니다(API 페이로드의 model.command에 매핑됨). 관리형 엔진 이미지(vLLM, SGLang 등)와 커스텀 이미지 모두에서 작동합니다.
  • container_args (list[str], 선택 사항) — 컨테이너 엔트리포인트에 추가되는 인자(API 페이로드의 model.args에 매핑됨). 관리형 엔진 이미지(예: vLLM, SGLang)와 커스텀 이미지 모두에서 작동합니다.
  • env (dict[str, str], 선택 사항) — 컨테이너 환경에 주입할 비비밀 환경 변수입니다.
  • secrets (dict[str, str], 선택) — 컨테이너 환경에 주입할 시크릿 값입니다.
  • type ([`InferenceEndpointType], *optional*) -- The type of the Inference Endpoint, which can be “authenticated”(default),“public”or“private”`.
  • domain (str, 선택 사항) — Inference Endpoint 배포에 사용할 커스텀 도메인입니다. 설정된 경우, 해당 도메인에서 Inference Endpoint에 접근할 수 있습니다(예: "my-new-domain.cool-website.woof").
  • path (str, 선택 사항) — 배포된 모델의 사용자 지정 경로입니다. /로 시작해야 합니다(예: "/models/google-bert/bert-base-uncased").
  • cache_http_responses (bool, 선택 사항) — Inference Endpoint에서 반환된 HTTP 응답을 캐시할지 여부입니다. 기본값은 False입니다.
  • tags (list[str], 선택 사항) — Inference Endpoint에 연결할 태그 목록입니다.
  • namespace (str, 선택 사항) — Inference Endpoint가 생성될 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

InferenceEndpoint

업데이트된 Inference Endpoint에 대한 정보

새로운 Inference Endpoint를 생성합니다.

accelerator, instance_size, instance_type, region, vendor 값은 서로 의존성이 있으므로 list_inference_endpoints_hardware()를 사용하여 유효한 조합을 나열하세요.

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.create_inference_endpoint(
...     "my-endpoint-name",
...     repository="gpt2",
...     framework="pytorch",
...     task="text-generation",
...     accelerator="cpu",
...     vendor="aws",
...     region="us-east-1",
...     type="authenticated",
...     instance_size="x2",
...     instance_type="intel-icl",
... )
>>> endpoint
InferenceEndpoint(name='my-endpoint-name', status="pending",...)

# Run inference on the endpoint
>>> endpoint.client.text_generation(...)
"..."
# Start an Inference Endpoint running Zephyr-7b-beta on TGI
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.create_inference_endpoint(
...     "aws-zephyr-7b-beta-0486",
...     repository="HuggingFaceH4/zephyr-7b-beta",
...     framework="pytorch",
...     task="text-generation",
...     accelerator="gpu",
...     vendor="aws",
...     region="us-east-1",
...     type="authenticated",
...     instance_size="x1",
...     instance_type="nvidia-a10g",
...     env={
...           "MAX_BATCH_PREFILL_TOKENS": "2048",
...           "MAX_INPUT_LENGTH": "1024",
...           "MAX_TOTAL_TOKENS": "1512",
...           "MODEL_ID": "/repository"
...         },
...     custom_image={
...         "healthRoute": "/health",
...         "url": "ghcr.io/huggingface/text-generation-inference:1.1.0",
...     },
...    secrets={"MY_SECRET_KEY": "secret_value"},
...    tags=["dev", "text-generation"],
... )
# Start an Inference Endpoint running ProsusAI/finbert while scaling to zero in 15 minutes
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> endpoint = api.create_inference_endpoint(
...     "finbert-classifier",
...     repository="ProsusAI/finbert",
...     framework="pytorch",
...     task="text-classification",
...     min_replica=0,
...     scale_to_zero_timeout=15,
...     accelerator="cpu",
...     vendor="aws",
...     region="us-east-1",
...     type="authenticated",
...     instance_size="x2",
...     instance_type="intel-icl",
... )
>>> endpoint.wait(timeout=300)
# Run inference on the endpoint
>>> endpoint.client.text_generation(...)
TextClassificationOutputElement(label='positive', score=0.8983615040779114)

create_inference_endpoint_from_catalog

< >

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

매개변수

  • repo_id (str, 선택 사항) — Inference Endpoint로 배포할 카탈로그 내 모델의 ID입니다. recipe_id와 상호 배타적입니다.
  • recipe_id (str, 선택 사항) — 배포할 카탈로그 레시피의 ID입니다(InferenceCatalogRecipe 참고). repo_id와 상호 배타적입니다.
  • name (str, 선택 사항) — 새로운 Inference Endpoint에 대한 고유한 이름입니다. 제공되지 않으면 무작위 이름이 생성됩니다.
  • accelerator (str, 선택 사항) — 추론에 사용할 하드웨어 가속기입니다. 가능한 값에는 "cpu", "gpu", "neuron"가 있습니다. 제공되지 않으면 서버는 모델에 적합한 기본값을 사용합니다. repo_id와 함께만 유효합니다.
  • gguf_file (str, 선택 사항) — 배포할 GGUF 파일입니다. 양자화 방식별로 레시피가 하나씩 있는 모델(예: "Qwen2.5-Coder-32B-Instruct-Q4_K_M.gguf")에 사용됩니다. repo_id와 함께만 유효합니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조).
  • namespace (str, 선택 사항) — Inference Endpoint가 생성될 namespace입니다. 기본값은 현재 사용자의 namespace입니다.

반환값

InferenceEndpoint

새로운 Inference Endpoint에 대한 정보

Hugging Face Inference Catalog에서 새로운 Inference Endpoint를 생성합니다.

Inference Catalog의 목표는 추론에 최적화되고 기본 구성이 테스트된 모델의 큐레이션된 목록을 제공하는 것입니다. 카탈로그에서 사용할 수 있는 모델 목록은 https://huggingface.co/proxy/endpoints.huggingface.co/catalog에서 확인하세요.

각 카탈로그 모델은 레시피를 통해 배포됩니다. 레시피는 해당 모델에 대해 테스트가 완료된 하드웨어와 엔진의 조합입니다. repo_id를 전달하여 모델의 기본 레시피를 배포할 수 있으며, accelerator와 gguf_file로 선택적으로 범위를 좁힐 수도 있습니다. 또는 list_inference_catalog()에 나열된 정확한 레시피를 배포하려면 recipe_id를 전달합니다.

create_inference_endpoint_from_catalog는 실험적 기능입니다. 향후 API가 변경될 수 있습니다. 제안이나 요청 사항이 있으시면 피드백을 남겨 주세요.

create_pull_request

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • title (str) — 토론의 제목입니다. 최대 200자, 최소 3자여야 하며, 앞뒤 공백은 제거됩니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • description (str, 선택) — Pull Request에 대한 선택적 설명입니다. 기본값은 "Discussion opened with the huggingface_hub Python library"입니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 업로드하는 경우 "dataset" 또는 "space"로, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.

Pull Request을 생성합니다. 프로그래밍 방식으로 생성된 Pull Request는 "draft" 상태가 됩니다.

변경 사항을 포함하여 Pull Request를 생성하는 작업은 HfApi.create_commit()을 사용하여 한 번에 수행할 수도 있습니다;

이것은 HfApi.create_discussion()의 래퍼입니다.

반환값: DiscussionWithDetails

다음 오류를 발생시킵니다:

  • HuggingFace API가 오류를 반환하면 HTTPError
  • ValueError 일부 매개변수 값이 잘못된 경우
  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.

create_repo

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • private (bool, 선택 사항) — 리포지토리를 비공개로 만들지 여부를 지정합니다. None(기본값)인 경우, 조직의 기본 설정이 비공개가 아닌 한 리포지토리는 공개됩니다. 리포지토리가 이미 존재하면 이 값은 무시됩니다. visibility와 함께 전달할 수 없습니다.
  • visibility (Literal["public", "private", "protected"], 선택 사항) — 리포지토리의 가시성입니다. "public" 또는 "private"로 설정할 수 있으며, Spaces의 경우 "protected"도 가능합니다. None (기본값)인 경우, 조직의 기본 설정이 private가 아닌 한 리포지토리는 public으로 설정됩니다. 이미 리포지토리가 존재하는 경우 이 값은 무시됩니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 업로드하는 경우 "dataset" 또는 "space"로, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • exist_ok (bool, 선택 사항, 기본값 False) — True인 경우, 저장소가 이미 존재해도 오류를 발생시키지 않습니다.
  • resource_group_id (str, 선택) — 리포지토리를 생성할 리소스 그룹입니다. 리소스 그룹은 Enterprise Hub 조직에서만 사용할 수 있으며, 조직 내에서 해당 리소스에 액세스할 수 있는 멤버를 정의하는 데 사용됩니다. 리소스 그룹의 ID는 Hub에서 해당 리소스 페이지의 URL에서 확인할 수 있습니다(예: "66670e5163145ca562cb1988"). 리소스 그룹에 대해 자세히 알아보려면 https://huggingface.co/docs/hub/en/security-resource-groups를 참조하세요.
  • region (Literal["us", "eu"], 선택 사항) — 리포지토리를 생성할 클라우드 리전입니다. "us" 또는 "eu" 중 하나여야 합니다. 지정하지 않으면 기본 리전에 리포지토리가 생성됩니다. Team 플랜 이상에서 사용할 수 있습니다.
  • space_sdk (str, 선택 사항) — repo_type이 “space”인 경우 사용할 SDK를 선택합니다. “streamlit”, “gradio”, “docker”, “static” 중 하나를 지정할 수 있습니다. "static" Spaces는 모든 사용자에게 무료입니다. 다른 SDK는 컴퓨트에서 실행되며, 무료 cpu-basic 하드웨어의 경우 구독이 필요합니다(사용자는 PRO, 조직은 Team 또는 Enterprise). 유료 하드웨어의 경우 결제 수단과 선불 크레딧만 있으면 됩니다.
  • space_hardware (SpaceHardware 또는 str, 선택 사항) — repo_type이 “space”인 경우 사용할 하드웨어를 선택합니다. 전체 목록은 SpaceHardware를 참조하세요.
  • space_sleep_time (int, 선택 사항) — Space가 수면 상태로 전환되기 전까지 대기할 비활성 시간(초). Space가 수면 상태로 전환되지 않기를 원하면 -1로 설정하세요(업그레이드된 하드웨어의 기본 동작). 무료 하드웨어의 경우 수면 시간을 설정할 수 없으며(값이 48시간 비활성으로 고정됨), 자세한 내용은 https://huggingface.co/docs/hub/spaces-gpus#sleep-time을 참조하세요.
  • space_secrets (list[dict[str, str]], 선택) — Space에 설정할 시크릿 키 목록입니다. 각 항목은 {"key": ..., "value": ..., "description": ...} 형식이며 description은 선택 사항입니다. 자세한 내용은 https://huggingface.co/docs/hub/spaces-overview#managing-secrets를 참고하세요.
  • space_variables (list[dict[str, str]], 선택 사항) — Space에서 설정할 공개 환경 변수 목록입니다. 각 항목은 {"key": ..., "value": ..., "description": ...} 형식이며 description은 선택 사항입니다. 자세한 내용은 https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables를 참조하세요.
  • space_volumes (list[Volume], 선택 사항) — Space 생성 시 마운트할 Volume 객체의 목록입니다. 각 볼륨에는 type ("bucket", "model", "dataset" 또는 "space"), source(레포지토리 또는 버킷 ID), mount_path (컨테이너 내부 경로) 및 선택적인 revision, read_only, path 필드가 있습니다. repo_type이 “space”인 경우에만 적용됩니다.
  • space_template (str, 선택 사항) — 공식 템플릿을 기반으로 새로운 Space를 생성합니다. 템플릿 저장소 ID(예: "SpacesExamples/jupyterlab") 또는 짧은 이름(예: "JupyterLab")을 사용할 수 있습니다. 사용 가능한 템플릿 목록을 확인하려면 HfApi.list_space_templates()를 사용하세요. repo_type이 “space”인 경우에만 적용됩니다. 템플릿이 비공개로 권장되고 visibility가 명시적으로 설정되지 않은 경우, Space는 비공개로 생성됩니다.

반환값

RepoUrl

새로 생성된 저장소의 URL. 값은 endpoint, repo_type, repo_id와 같은 속성을 포함하는 str의 하위 클래스입니다.

HuggingFace Hub에서 빈 저장소를 생성합니다.

create_scheduled_job

< >

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

매개변수

  • image (str) — 사용할 Docker 이미지입니다. 예: "ubuntu", "python:3.12", "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel". Space의 이미지를 사용하는 예: "hf.co/spaces/lhoestq/duckdb".
  • command (list[str]) — 실행할 명령입니다. 예: ["echo", "hello"].
  • schedule (str) — “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly” 중 하나 또는 CRON 스케줄 표현식(예: 매주 월요일 오전 9시를 나타내는 ‘0 9 * * 1’)
  • suspend (bool, 선택 사항) — True인 경우, 예약된 Job이 일시 중지됩니다. 기본값은 False입니다.
  • concurrency (bool, 선택 사항) — True인 경우, 이 Job의 여러 인스턴스가 동시에 실행될 수 있습니다. 기본값은 False입니다.
  • env (dict[str, Any], 선택) — Job의 환경 변수를 정의합니다.
  • secrets (dict[str, Any], 선택) — Job의 비밀 환경 변수를 정의합니다.
  • flavor (str, 선택 사항) — 하드웨어의 Flavor입니다. 가능한 값은 JobHardware를 참조하세요. 기본값은 "cpu-basic"입니다.
  • timeout (Union[int, float, str], 선택 사항) — Job의 최대 지속 시간: s(초, 기본값), m(분), h(시간) 또는 d(일)를 접미사로 사용하는 int. 예: 5분은 300 또는 "5m".
  • attempts (int, 선택 사항) — 초기 시도를 포함하여 각 실행에 대한 최대 시도 횟수입니다. 기본값은 1입니다.
  • name (str, 선택 사항) — 예약된 Job에 대한 이름입니다. name 레이블로 저장됩니다. labels에 name 키와 함께 전달할 수 없습니다. 이름은 고유할 필요가 없습니다. 기본값은 이미지와 명령에서 파생된 이름(짧은 해시 접미사 포함)입니다.
  • labels (dict[str, str], 선택) — 작업에 연결할 라벨(키-값 쌍).
  • volumes (list[Volume], 선택 사항) — 잡 컨테이너에 볼륨으로 마운트할 Hugging Face Buckets 또는 Repos입니다. 각 볼륨은 Volume이며 type ("bucket", "model", "dataset" 또는 "space"), source (예: "username/my-bucket"), mount_path (예: "/data")를 가집니다.
  • expose (list[int], 선택 사항) — jobs 프록시를 통해 노출할 컨테이너 포트입니다. 나열된 각 포트는 공개 jobs 도메인(예: https://<job_id>--8000.hf.jobs)에서 접근할 수 있습니다. 접근에는 항상 해당 job의 namespace에 대한 읽기 권한이 있는 HF 토큰이 필요합니다. 인증되지 않은 접근을 사용하려면 expose_public을 사용하세요.
  • expose_public (list[int], 선택) — 인증 없이 Jobs 프록시를 통해 노출할 포트입니다. expose에 나열할 필요가 없습니다.
  • resource_group_id (str, 선택 사항) — 예약된 Job을 생성할 리소스 그룹의 ID입니다. 조직 내 리소스에 대한 액세스 제어 및 비용 귀속/지출 한도 기능을 위해 사용됩니다. 제공되지 않으면 예약된 Job은 어떤 리소스 그룹에도 속하지 않은 상태로 생성됩니다.
  • namespace (str, 선택 사항) — Job이 생성될 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face 인프라에서 예약된 compute Jobs를 생성합니다.

예:

첫 번째 예약 Job를 생성하세요:

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

CRON 스케줄 표현식을 사용하세요:

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

예약된 GPU Job를 생성합니다:

>>> from huggingface_hub import create_scheduled_job
>>> image = "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"
>>> command = ["python", "-c", "import torch; print(f'This code ran with the following GPU: {torch.cuda.get_device_name()}')"]
>>> create_scheduled_job(image=image, command=command, flavor="a10g-small", schedule="@hourly")

create_scheduled_uv_job

< >

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

매개변수

  • script (str) — UV 스크립트의 경로 또는 URL, 또는 명령어.
  • script_args (list[str], 선택 사항) — 스크립트 또는 명령에 전달할 인자.
  • schedule (str) — “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly” 중 하나 또는 CRON 스케줄 표현식(예: 매주 월요일 오전 9시를 나타내는 ‘0 9 * * 1’)
  • suspend (bool, 선택 사항) — True인 경우, 예약된 Job이 일시 중지됩니다. 기본값은 False입니다.
  • concurrency (bool, 선택 사항) — True인 경우, 이 Job의 여러 인스턴스가 동시에 실행될 수 있습니다. 기본값은 False입니다.
  • dependencies (list[str], 선택 사항) — UV 스크립트를 실행하는 데 사용할 종속성입니다.
  • python (str, 선택 사항) — 특정 Python 버전을 사용합니다. 기본값은 3.12입니다.
  • image (str, 선택 사항, 기본값 “ghcr.io/astral-sh/uv —python3.12-bookworm”): uv가 설치된 사용자 지정 Docker 이미지를 사용합니다.
  • env (dict[str, Any], 선택) — Job의 환경 변수를 정의합니다.
  • secrets (dict[str, Any], 선택) — Job의 비밀 환경 변수를 정의합니다.
  • flavor (str, 선택 사항) — 하드웨어의 Flavor입니다. 가능한 값은 JobHardware를 참조하세요. 기본값은 "cpu-basic"입니다.
  • timeout (Union[int, float, str], 선택 사항) — Job의 최대 지속 시간: s(초, 기본값), m(분), h(시간) 또는 d(일)를 접미사로 사용하는 int. 예: 5분은 300 또는 "5m".
  • attempts (int, 선택 사항) — 초기 시도를 포함하여 각 실행에 대한 최대 시도 횟수입니다. 기본값은 1입니다.
  • name (str, 선택 사항) — 예약된 Job에 대한 이름입니다. name 레이블로 저장됩니다. labels에 name 키와 함께 전달할 수 없습니다. 이름은 고유할 필요가 없습니다. 기본값은 스크립트와 그 인자에서 파생된 이름(짧은 해시 접미사 포함)입니다.
  • labels (dict[str, str], 선택) — 작업에 연결할 라벨(키-값 쌍).
  • volumes (list[Volume], 선택 사항) — 잡 컨테이너에 볼륨으로 마운트할 Hugging Face Buckets 또는 Repos입니다. 각 볼륨은 Volume이며 type ("bucket", "model", "dataset" 또는 "space"), source (예: "username/my-bucket"), mount_path (예: "/data")를 가집니다.
  • expose (list[int], 선택 사항) — jobs 프록시를 통해 노출할 컨테이너 포트입니다. 나열된 각 포트는 공개 jobs 도메인(예: https://<job_id>--8000.hf.jobs)에서 접근할 수 있습니다. 접근에는 항상 해당 job의 namespace에 대한 읽기 권한이 있는 HF 토큰이 필요합니다. 인증되지 않은 접근을 사용하려면 expose_public을 사용하세요.
  • expose_public (list[int], 선택) — 인증 없이 Jobs 프록시를 통해 노출할 포트입니다. expose에 나열할 필요가 없습니다.
  • resource_group_id (str, 선택 사항) — 예약된 Job을 생성할 리소스 그룹의 ID입니다. 조직 내 리소스에 대한 액세스 제어 및 비용 귀속/지출 한도 기능을 위해 사용됩니다. 제공되지 않으면 예약된 Job은 어떤 리소스 그룹에도 속하지 않은 상태로 생성됩니다.
  • namespace (str, 선택 사항) — Job이 생성될 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face 인프라에서 UV 스크립트 Job을 실행합니다.

hf jobs uv run와 달리, 이 메서드는 UV 스크립트가 PEP 723 헤더에 포함할 수 있는 선택적 [tool.hf-jobs] 테이블(Jobs 가이드 참고)을 무시합니다. 따라서 여기서 런치 구성은 명시적으로 전달해야 합니다.

예:

URL에서 스크립트 예약:

>>> from huggingface_hub import create_scheduled_uv_job
>>> script = "https://raw.githubusercontent.com/huggingface/trl/refs/heads/main/trl/scripts/sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small", schedule="@weekly")

로컬 스크립트 예약:

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

명령을 예약합니다:

>>> from huggingface_hub import create_scheduled_uv_job
>>> script = "lighteval"
>>> script_args= ["endpoint", "inference-providers", "model_name=openai/gpt-oss-20b,provider=auto", "lighteval|gsm8k|0|0"]
>>> create_scheduled_uv_job(script, script_args=script_args, dependencies=["lighteval"], flavor="a10g-small", schedule="@weekly")

create_tag

< >

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

매개변수

  • repo_id (str) — 커밋에 태그를 지정할 저장소입니다. 예: "user/my-cool-model".
  • tag (str) — 생성할 태그의 이름.
  • tag_message (str, 선택 사항) — 생성할 태그의 설명입니다.
  • revision (str, 선택 사항) — 태그할 git revision입니다. 브랜치 이름 또는 커밋의 OID/SHA를 16진수 문자열로 사용할 수 있습니다. 약어(첫 7자)도 지원합니다. 기본값은 "main" 브랜치의 head입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 태그를 지정하는 경우 "dataset" 또는 "space"로, 모델에 태그를 지정하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • exist_ok (bool, 선택 사항, 기본값 False) — True인 경우, 태그가 이미 존재해도 오류를 발생시키지 않습니다.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 RevisionNotFoundError 또는 HfHubHTTPError

  • RepositoryNotFoundError — 리포지토리가 찾을 수 없는 경우(에러 404): repo_id/repo_type가 잘못되었거나, 비공개이지만 인증되지 않았거나, 리포지토리가 존재하지 않는 경우.
  • RevisionNotFoundError — 리포지토리에서 revision을 찾을 수 없는 경우(에러 404).
  • HfHubHTTPError — 리포지토리에 해당 브랜치가 이미 존재하는 경우(에러 409)에 exist_ok가 False로 설정되어 있을 때 발생합니다.

Hub의 저장소에서 특정 커밋에 태그를 지정합니다.

create_webhook

< >

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

매개변수

  • url (str) — payload를 전송할 URL입니다.
  • job_id (str) — 환경 변수 WEBHOOK_PAYLOAD의 웹훅 페이로드로 트리거할 소스 Job의 ID입니다. 편의상 추가 환경 변수 WEBHOOK_REPO_ID, WEBHOOK_REPO_TYPE, WEBHOOK_SECRET이 사용할 수 있습니다.
  • watched (list[WebhookWatchedItem]) — webhook이 감시할 WebhookWatchedItem 목록입니다. 사용자, 조직, 모델, 데이터셋, 스페이스 또는 버킷일 수 있습니다. 감시 대상 항목은 일반 딕셔너리 형태로도 제공할 수 있습니다.
  • domains (list[Literal["repo", "discussion"]], optional) — 감시할 도메인의 목록입니다. “repo”, “discussion” 또는 둘 다를 지정할 수 있습니다. 기본값은 둘 다입니다.
  • secret (str, 선택 사항) — payload에 서명할 시크릿입니다.
  • secrets (dict[str, str], optional) — Webhook에 의해 트리거된 Job의 비밀 환경 변수입니다(예: {"HF_TOKEN": "hf_***"}). job_id와 함께 사용할 때만 유효합니다. 소스 Job의 secrets는 Webhook으로 복사되지 않으므로, 여기에서 전달해야 합니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다(자세한 내용은 https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

WebhookInfo

새로 생성된 웹훅에 대한 정보.

새 웹훅을 생성합니다.

Webhook은 URL로 페이로드를 전송하거나 Hugging Face 인프라에서 Job을 실행하도록 트리거할 수 있습니다. 이 함수는 url 또는 job_id 중 하나만 사용하여 호출해야 하며, 둘 다 사용할 수 없습니다.

예:

URL로 페이로드를 전송하는 웹훅을 생성합니다

>>> from huggingface_hub import create_webhook
>>> payload = create_webhook(
...     watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}],
...     url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
...     domains=["repo", "discussion"],
...     secret="my-secret",
... )
>>> print(payload)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    job=None,
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=False,
)

Job을 실행한 다음, 이 Job을 트리거하는 웹훅을 만듭니다

>>> from huggingface_hub import create_webhook, run_job
>>> job = run_job(
...     image="ubuntu",
...     command=["bash", "-c", r"echo An event occurred in $WEBHOOK_REPO_ID: $WEBHOOK_PAYLOAD"],
... )
>>> payload = create_webhook(
...     watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}],
...     job_id=job.id,
...     domains=["repo", "discussion"],
...     secret="my-secret",
... )
>>> print(payload)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    url=None,
    job=JobSpec(
        docker_image='ubuntu',
        space_id=None,
        command=['bash', '-c', 'echo An event occurred in $WEBHOOK_REPO_ID: $WEBHOOK_PAYLOAD'],
        arguments=[],
        environment={},
        secrets=[],
        flavor='cpu-basic',
        timeout=None,
        tags=None,
        arch=None
    ),
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=False,
)

dataset_info

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • revision (str, 선택 사항) — 정보를 가져올 데이터셋 저장소의 리비전입니다.
  • timeout (float, 선택 사항) — Hub에 대한 요청에 타임아웃을 설정할지 여부.
  • files_metadata (bool, 선택 사항) — 리포지토리의 파일 메타데이터(크기, LFS 메타데이터 등)를 가져올지 여부입니다. 기본값은 False입니다.
  • expand (list[ExpandDatasetProperty_T], 선택 사항) — 응답에 반환할 속성 목록입니다. 이 매개변수를 사용하면 목록에 포함된 속성만 반환됩니다. files_metadata가 전달된 경우 이 매개변수를 사용할 수 없습니다. 가능한 값은 "author", "cardData", "citation", "createdAt", "disabled", "description", "downloads", "downloadsAllTime", "gated", "lastModified", "likes", "mainSize", "paperswithcode_id", "private", "siblings", "sha", "tags", "trendingScore", "usedStorage", "resourceGroup"입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

hf_api.DatasetInfo

데이터셋 저장소 정보.

huggingface.co의 특정 데이터셋에 대한 정보를 가져옵니다.

Dataset은 허용되는 토큰을 전달하면 비공개로 설정할 수 있습니다.

다음 오류를 발생시킵니다:

  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.
  • RevisionNotFoundError 다운로드할 수 없는 리비전이 발견되지 않는 경우.

delete_branch

< >

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

매개변수

  • repo_id (str) — 브랜치가 삭제될 저장소입니다. 예: "user/my-cool-model".
  • branch (str) — 삭제할 브랜치의 이름입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 브랜치를 생성하는 경우 "dataset" 또는 "space"로, 모델을 태그하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 HfHubHTTPError

  • RepositoryNotFoundError — 리포지토리가 찾을 수 없는 경우(에러 404): repo_id/repo_type가 잘못되었거나, 비공개이지만 인증되지 않았거나, 리포지토리가 존재하지 않는 경우.
  • HfHubHTTPError — 보호된 브랜치를 삭제하려고 할 때 발생합니다. 예: main은 삭제할 수 없습니다.
  • HfHubHTTPError — 존재하지 않는 브랜치를 삭제하려고 할 때 발생합니다.

Hub의 저장소에서 브랜치를 삭제합니다.

delete_bucket

< >

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

매개변수

  • bucket_id (str) — 버킷의 ID(예: "username/my-bucket").
  • missing_ok (bool, 선택 사항, 기본값 False) — True인 경우, 버킷이 존재하지 않아도 오류를 발생시키지 않습니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

다음 예외가 발생합니다

BucketNotFoundError

  • BucketNotFoundError — 버킷을 찾을 수 없고 missing_ok이 False(기본값)로 설정된 경우.

Hub에서 버킷을 삭제합니다.

예:

>>> from huggingface_hub import delete_bucket
>>> delete_bucket(bucket_id="Wauplin/first-bucket")
>>> delete_bucket(bucket_id="Wauplin/first-bucket", missing_ok=True)

delete_collection

< >

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

매개변수

  • collection_slug (str) — 삭제할 collection의 slug입니다. 예: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • missing_ok (bool, 선택 사항) — True인 경우, 컬렉션이 존재하지 않아도 오류를 발생시키지 않습니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Hub에서 컬렉션을 삭제합니다.

예:

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

이 작업은 되돌릴 수 없습니다. 삭제된 컬렉션은 복원할 수 없습니다.

delete_collection_item

< >

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

매개변수

  • collection_slug (str) — 업데이트할 collection의 slug입니다. 예: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • item_object_id (str) — 컬렉션 내 항목의 ID입니다. 이는 Hub에서 해당 항목의 ID(repo_id 또는 paper id)가 아닙니다. CollectionItem 객체에서 가져와야 합니다. 예: collection.items[0].item_object_id.
  • missing_ok (bool, 선택 사항) — True인 경우, 항목이 존재하지 않아도 오류를 발생시키지 않습니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

컬렉션에서 항목을 삭제합니다.

예:

>>> from huggingface_hub import get_collection, delete_collection_item

# Get collection first
>>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")

# Delete item based on its ID
>>> delete_collection_item(
...     collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026",
...     item_object_id=collection.items[-1].item_object_id,
... )

delete_file

< >

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

매개변수

  • path_in_repo (str) — 레포지토리 내 상대 파일 경로, 예: "checkpoints/1fec34a/weights.bin"
  • repo_id (str) — 파일이 삭제될 저장소입니다. 예를 들어: "username/custom_transformers"
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • repo_type (str, 선택 사항) — 파일이 dataset 또는 space에 있는 경우 "dataset" 또는 "space"로, model에 있는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • revision (str, 선택 사항) — 커밋할 git 리비전입니다. 기본값은 "main" 브랜치의 헤드입니다.
  • commit_message (str, 선택 사항) — 생성된 커밋의 요약 / 제목 / 첫 번째 줄입니다. 기본값은 f"Delete {path_in_repo} with huggingface_hub"입니다.
  • commit_description (str, 선택 사항) — 생성된 커밋의 설명
  • create_pr (boolean, 선택 사항) — 해당 커밋으로 Pull Request를 생성할지 여부입니다. 기본값은 False입니다. revision이 설정되지 않은 경우, PR은 "main" 브랜치를 대상으로 열립니다. revision이 설정되어 있고 브랜치인 경우, PR은 해당 브랜치를 대상으로 열립니다. revision이 설정되어 있고 브랜치 이름이 아닌 경우(예: 커밋 oid), 서버는 RevisionNotFoundError를 반환합니다.
  • parent_commit (str, 선택 사항) — 부모 커밋의 OID / SHA를 16진수 문자열로 나타낸 것입니다. 약식 표기(첫 7자리)도 지원합니다. 지정되어 있고 create_pr가 False인 경우, revision이 parent_commit을 가리키지 않으면 커밋이 실패합니다. 지정되어 있고 create_pr가 True인 경우, parent_commit에서 pull request가 생성됩니다. parent_commit을 지정하면 변경 사항을 커밋하기 전에 저장소가 변경되지 않았는지 확인할 수 있으며, 저장소가 동시에 업데이트되거나 커밋되는 경우 특히 유용합니다.

repo에서 파일을 삭제합니다.

다음 오류를 발생시킵니다:

  • HuggingFace API가 오류를 반환하면 HTTPError
  • ValueError 일부 매개변수 값이 잘못된 경우
  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.
  • RevisionNotFoundError 다운로드할 수 없는 리비전이 발견되지 않는 경우.
  • EntryNotFoundError 다운로드할 파일을 찾을 수 없는 경우.

delete_files

< >

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

매개변수

  • repo_id (str) — 폴더가 삭제될 저장소입니다. 예를 들어: "username/custom_transformers"
  • delete_patterns (list[str]) — 삭제할 파일 또는 폴더 목록. 각 문자열은 파일 경로, 폴더 경로 또는 와일드카드 패턴일 수 있습니다. 패턴은 여기에 문서화된 표준 와일드카드(globbing 패턴)입니다. 패턴 매칭은 fnmatch에 기반합니다. 전통적인 Unix 셸 globbing과 달리 fnmatch는 *가 경로 경계를 넘어 매칭된다는 점에 유의하세요. 예: ["file.txt", "folder/", "data/*.parquet"]
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 저장된 토큰에 False를 전달하세요.
  • repo_type (str, 선택 사항) — 파일을 삭제할 저장소의 유형입니다. "model", "dataset" 또는 "space"일 수 있습니다. 기본값은 "model"입니다.
  • revision (str, 선택 사항) — 커밋할 git 리비전입니다. 기본값은 "main" 브랜치의 헤드입니다.
  • commit_message (str, 선택 사항) — 생성된 커밋의 요약(첫 번째 줄)입니다. 기본값은 f"Delete files using huggingface_hub"입니다.
  • commit_description (str, 선택 사항) — 생성된 커밋의 설명입니다.
  • create_pr (boolean, 선택 사항) — 해당 커밋으로 Pull Request를 생성할지 여부입니다. 기본값은 False입니다. revision이 설정되지 않은 경우, PR은 "main" 브랜치를 대상으로 열립니다. revision이 설정되어 있고 브랜치인 경우, PR은 해당 브랜치를 대상으로 열립니다. revision이 설정되어 있고 브랜치 이름이 아닌 경우(예: 커밋 oid), 서버는 RevisionNotFoundError를 반환합니다.
  • parent_commit (str, 선택 사항) — 부모 커밋의 OID / SHA를 16진수 문자열로 나타낸 것입니다. 약식 표기(첫 7자리)도 지원합니다. 지정되어 있고 create_pr가 False인 경우, revision이 parent_commit을 가리키지 않으면 커밋이 실패합니다. 지정되어 있고 create_pr가 True인 경우, parent_commit에서 pull request가 생성됩니다. parent_commit을 지정하면 변경 사항을 커밋하기 전에 저장소가 변경되지 않았는지 확인할 수 있으며, 저장소가 동시에 업데이트되거나 커밋되는 경우 특히 유용합니다.

Hub의 저장소에서 파일을 삭제합니다.

폴더 경로가 제공되면 해당 폴더와 그 안에 포함된 모든 파일이 삭제됩니다.

delete_folder

< >

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

매개변수

  • path_in_repo (str) — 레포지토리 내 상대 폴더 경로입니다. 예: "checkpoints/1fec34a".
  • repo_id (str) — 폴더가 삭제될 저장소입니다. 예를 들어: "username/custom_transformers"
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 저장된 토큰에 False를 전달하세요.
  • repo_type (str, 선택 사항) — 폴더가 dataset 또는 space에 있는 경우 "dataset" 또는 "space"로, model에 있는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • revision (str, 선택 사항) — 커밋할 git 리비전입니다. 기본값은 "main" 브랜치의 헤드입니다.
  • commit_message (str, 선택 사항) — 생성된 커밋의 요약 / 제목 / 첫 번째 줄입니다. 기본값은 f"Delete folder {path_in_repo} with huggingface_hub"입니다.
  • commit_description (str, 선택 사항) — 생성된 커밋의 설명입니다.
  • create_pr (boolean, 선택 사항) — 해당 커밋으로 Pull Request를 생성할지 여부입니다. 기본값은 False입니다. revision이 설정되지 않은 경우, PR은 "main" 브랜치를 대상으로 열립니다. revision이 설정되어 있고 브랜치인 경우, PR은 해당 브랜치를 대상으로 열립니다. revision이 설정되어 있고 브랜치 이름이 아닌 경우(예: 커밋 oid), 서버는 RevisionNotFoundError를 반환합니다.
  • parent_commit (str, 선택 사항) — 부모 커밋의 OID / SHA를 16진수 문자열로 나타낸 것입니다. 약식 표기(첫 7자리)도 지원합니다. 지정되어 있고 create_pr가 False인 경우, revision이 parent_commit을 가리키지 않으면 커밋이 실패합니다. 지정되어 있고 create_pr가 True인 경우, parent_commit에서 pull request가 생성됩니다. parent_commit을 지정하면 변경 사항을 커밋하기 전에 저장소가 변경되지 않았는지 확인할 수 있으며, 저장소가 동시에 업데이트되거나 커밋되는 경우 특히 유용합니다.

repo에서 폴더를 삭제합니다.

create_commit() 메서드를 간단하게 감싸는 래퍼입니다.

delete_inference_endpoint

< >

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

매개변수

  • name (str) — 삭제할 Inference Endpoint의 이름입니다.
  • namespace (str, 선택 사항) — Inference Endpoint가 위치한 namespace입니다. 기본값은 현재 사용자입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Inference Endpoint를 삭제합니다.

이 작업은 되돌릴 수 없습니다. Inference Endpoint에 대한 요금이 부과되는 것을 원하지 않는다면, pause_inference_endpoint()로 일시중지하거나 scale_to_zero_inference_endpoint()로 규모를 0으로 줄이는 것이 좋습니다.

편의상 InferenceEndpoint.delete()를 사용하여 Inference Endpoint를 삭제할 수도 있습니다.

delete_repo

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 업로드하는 경우 "dataset" 또는 "space"로, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다.
  • missing_ok (bool, 선택 사항, 기본값 False) — True인 경우, 저장소가 존재하지 않아도 오류를 발생시키지 않습니다.

다음 예외가 발생합니다

RepositoryNotFoundError

  • RepositoryNotFoundError — 삭제할 저장소를 찾을 수 없고 missing_ok이 False(기본값)로 설정된 경우.

HuggingFace Hub에서 저장소를 삭제합니다. 주의: 이 작업은 되돌릴 수 없습니다.

delete_scheduled_job

< >

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

매개변수

  • scheduled_job_id (str) — 예약된 Job의 ID입니다.
  • namespace (str, 선택 사항) — 예약된 Job이 있는 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face 인프라에서 예약된 compute Job을 삭제합니다.

delete_space_secret

< >

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

매개변수

  • repo_id (str) — 업데이트할 저장소의 ID입니다. 예: "bigcode/in-the-stack".
  • key (str) — 비밀 키. 예: "GITHUB_API_KEY".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Space에서 시크릿을 삭제합니다.

Secrets를 사용하면 Space에 시크릿 키나 토큰을 하드코딩하지 않고 설정할 수 있습니다. 자세한 내용은 https://huggingface.co/docs/hub/spaces-overview#managing-secrets를 참조하세요.

delete_space_variable

< >

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

매개변수

  • repo_id (str) — 업데이트할 저장소의 ID입니다. 예: "bigcode/in-the-stack".
  • key (str) — 변수 키. 예: "MODEL_REPO_ID"
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Space에서 변수를 삭제합니다.

Variables를 사용하면 Space에 환경 변수를 하드코딩하지 않고 설정할 수 있습니다. 자세한 내용은 https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables를 참조하세요.

delete_space_volumes

< >

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

매개변수

  • repo_id (str) — 업데이트할 Space의 ID입니다. 예: "username/my-space".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

다음 예외가 발생합니다

BadRequestError

  • BadRequestError — Space에 볼륨이 연결되어 있지 않은 경우.

Space에서 모든 볼륨을 제거합니다.

예:

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

delete_tag

< >

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

매개변수

  • repo_id (str) — 태그가 삭제될 저장소입니다. 예: "user/my-cool-model".
  • tag (str) — 삭제할 태그의 이름.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 태그를 지정하는 경우 "dataset" 또는 "space"로, 모델에 태그를 지정하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 RevisionNotFoundError

  • RepositoryNotFoundError — 리포지토리가 찾을 수 없는 경우(에러 404): repo_id/repo_type가 잘못되었거나, 비공개이지만 인증되지 않았거나, 리포지토리가 존재하지 않는 경우.
  • RevisionNotFoundError — 태그를 찾을 수 없는 경우.

Hub의 저장소에서 태그를 삭제합니다.

delete_webhook

< >

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

매개변수

  • webhook_id (str) — 삭제할 Webhook의 고유 식별자입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다(자세한 내용은 https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

None

Webhook을 삭제합니다.

예:

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

disable_space_dev_mode

< >

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

매개변수

  • repo_id (str) — dev mode를 비활성화할 Space의 ID입니다. 예: "Salesforce/BLIP2".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

SpaceRuntime

Space에 대한 런타임 정보.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 HfHubHTTPError 또는 BadRequestError

  • RepositoryNotFoundError — Space가 찾을 수 없는 경우(에러 404). 가장 가능성 높은 원인은 잘못된 repo_id이거나, Space가 비공개인데 인증되지 않은 상태입니다.
  • HfHubHTTPError — 403 Forbidden: Space의 소유자만 dev mode를 설정할 수 있습니다. 소유하지 않은 Space를 처리하려면 Discussion을 열어 소유자에게 요청하거나 Space를 복제하세요.
  • BadRequestError — Space가 정적 Space인 경우입니다. 정적 Space는 항상 실행되며 과금되지 않습니다. 정적 Space를 숨기려면 비공개로 설정할 수 있습니다.

Space에서 dev 모드를 비활성화합니다.

Spaces Dev Mode은 Space 컨테이너 자체를 중지하지 않고 애플리케이션을 재시작할 수 있도록 하여 애플리케이션 디버깅을 용이하게 하고 Spaces 반복 개발 속도를 높입니다. Dev Mode를 활성화하려면 PRO 또는 Team & Enterprise 플랜이 필요하지만, 비활성화는 항상 허용됩니다(예: 구독 만료 후). 자세한 내용은 https://huggingface.co/docs/hub/spaces-dev-mode를 참조하세요.

disable_webhook

< >

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

매개변수

  • webhook_id (str) — 비활성화할 Webhook의 고유 식별자입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다(자세한 내용은 https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

WebhookInfo

비활성화된 웹훅에 대한 정보입니다.

웹훅 비활성화(“비활성화” 상태로 변경).

예:

>>> from huggingface_hub import disable_webhook
>>> disabled_webhook = disable_webhook("654bbbc16f2ec14d77f109cc")
>>> disabled_webhook
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    jon=None,
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=True,
)

download_bucket_files

< >

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

매개변수

  • bucket_id (str) — 버킷의 ID(예: "username/my-bucket").
  • files (list[tuple[Union[str, BucketFile], Union[str, Path]]]) — (source, destination) 튜플의 목록으로 다운로드할 파일입니다. 형식 세부 사항은 위의 설명을 참조하세요.
  • raise_on_missing_files (bool, 선택 사항) — True인 경우, 요청한 파일이 버킷에 존재하지 않으면 EntryNotFoundError를 발생시킵니다. False(기본값)인 경우, 존재하지 않는 파일은 경고와 함께 건너뜁니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Download files from a bucket.

Files 입력은 (remote file, local file) 튜플의 목록이며, 여기서 remote file은 버킷 내 파일의 경로 또는 BucketFile 객체이고, local file은 로컬 파일 시스템의 대상 경로입니다. BucketFile 객체(list_bucket_tree()에서 가져온 것)를 전달하면 메서드는 메타데이터 가져오기 단계를 건너뛰고 파일을 바로 다운로드합니다.

예:

>>> from huggingface_hub import download_bucket_files

>>> download_bucket_files(
...     bucket_id="username/my-bucket",
...     files=[
...         ("models/model.safetensors", "./local/model.safetensors"),
...         ("config.json", "./local/config.json"),
...     ],
... )
>>> from huggingface_hub import download_bucket_files

>>> parquet_files = [file for file in list_bucket_tree(bucket_id="username/my-bucket") if file.path.endswith(".parquet")]
>>> download_bucket_files(
...     bucket_id="username/my-bucket",
...     files=[(file, f"./local/{file.path}") for file in parquet_files],
... )

duplicate_repo

< >

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

매개변수

  • from_id (str) — 복제할 저장소의 ID입니다. 예: "openai/gdpval".
  • to_id (str, 선택 사항) — 새 리포지토리의 ID입니다. 예: "myorg/my-gdpval". 제공하지 않으면 새 리포지토리는 원래 리포지토리와 동일한 이름을 사용하되, 사용자의 계정 아래에 생성됩니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 Space를 복제하는 경우 "dataset" 또는 "space"로, 모델을 복제하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • private (bool, 선택 사항) — 새 저장소가 비공개여야 하는지 여부입니다. 기본값은 원본 저장소와 동일한 프라이버시입니다. visibility와 함께 전달할 수 없습니다.
  • visibility (Literal["public", "private", "protected"], 선택 사항) — 새 리포지토리의 가시성입니다. "public" 또는 "private"를 사용할 수 있으며, Spaces의 경우 "protected"를 사용할 수 있습니다. 기본값은 원래 리포지토리와 동일한 가시성입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • exist_ok (bool, 선택 사항, 기본값 False) — True인 경우, 저장소가 이미 존재해도 오류를 발생시키지 않습니다.
  • resource_group_id (str, 선택 사항) — 새 리포지토리를 생성할 리소스 그룹입니다. 리소스 그룹은 Enterprise Hub 조직에서만 사용할 수 있으며, 조직 내에서 해당 리소스에 액세스할 수 있는 멤버를 정의하는 데 사용됩니다. 리소스 그룹의 ID는 Hub에서 해당 리소스 페이지의 URL에서 확인할 수 있습니다(예: "66670e5163145ca562cb1988"). 리소스 그룹에 대해 자세히 알아보려면 https://huggingface.co/docs/hub/en/security-resource-groups를 참조하세요.
  • space_hardware (SpaceHardware 또는 str, 선택 사항) — repo_type이 “space”인 경우 사용할 하드웨어를 선택합니다. 예: "t4-medium". 전체 목록은 SpaceHardware를 참조하세요.
  • space_sleep_time (int, 선택 사항) — Space가 수면 상태로 전환되기 전까지 대기할 비활성 시간(초). Space가 수면 상태로 전환되지 않기를 원하면 -1로 설정하세요(업그레이드된 하드웨어의 기본 동작). 무료 하드웨어의 경우 수면 시간을 설정할 수 없습니다(값이 48시간 비활성으로 고정됨). repo_type이 “space”인 경우에만 적용됩니다. 자세한 내용은 https://huggingface.co/docs/hub/spaces-gpus#sleep-time을 참조하세요.
  • space_secrets (list[dict[str, str]], 선택) — Space에 설정할 시크릿 키 목록입니다. 각 항목은 {"key": ..., "value": ..., "description": ...} 형식이며 description은 선택 사항입니다. repo_type이 “space”인 경우에만 적용됩니다. 자세한 내용은 https://huggingface.co/docs/hub/spaces-overview#managing-secrets를 참조하세요.
  • space_variables (list[dict[str, str]], 선택 사항) — Space에 설정할 공개 환경 변수 목록입니다. 각 항목은 {"key": ..., "value": ..., "description": ...} 형식이며 description은 선택 사항입니다. repo_type이 “space”인 경우에만 적용됩니다. 자세한 내용은 https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables를 참조하세요.
  • space_volumes (list[Volume], 선택 사항) — Space 복제 시 마운트할 Volume 객체의 목록입니다. 각 볼륨에는 type ("bucket", "model", "dataset" 또는 "space"), source(레포지토리 또는 버킷 ID), mount_path (컨테이너 내부 경로) 및 선택적인 revision, read_only, path 필드가 있습니다. repo_type이 “space”인 경우에만 적용됩니다.

반환값

DuplicatedRepoUrl

새로 생성된 저장소의 URL. 값은 endpoint, repo_type, repo_id, files_copy_pending와 같은 속성을 포함하는 RepoUrl(그리고 str)의 하위 클래스입니다.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 HfHubHTTPError

  • RepositoryNotFoundError — from_id 또는 to_id 중 하나를 찾을 수 없는 경우. 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.
  • HfHubHTTPError — HuggingFace API가 오류를 반환한 경우

Hub의 저장소(모델, 데이터셋 또는 Space)를 복제합니다.

이 작업은 로컬 다운로드/업로드 왕복을 요구하지 않고 전체 git 히스토리와 LFS 객체를 보존하는 서버 측 복사를 수행합니다.

git 히스토리는 즉시 복사되지만, 이 메서드가 반환된 후에도 LFS/Xet 파일은 백그라운드에서 복사 중일 수 있습니다. 이 경우 반환 값의 files_copy_pending이 True이며, 복사가 완료될 때까지 새 저장소에서 이 파일들을 다운로드하는 작업이 실패할 수 있습니다.

예:

>>> from huggingface_hub import duplicate_repo

# Duplicate a model to your account
>>> repo_url = duplicate_repo("google/gemma-7b")
>>> repo_url
RepoUrl('https://huggingface.co/nateraw/gemma-7b',...)
>>> repo_url.files_copy_pending
True

# Duplicate a dataset with a custom name
>>> duplicate_repo("openai/gdpval", to_id="myorg/my-gdpval", repo_type="dataset")
RepoUrl('https://huggingface.co/datasets/myorg/my-gdpval',...)

# Duplicate a Space with custom hardware
>>> duplicate_repo("multimodalart/dreambooth-training", repo_type="space", space_hardware="t4-medium")
RepoUrl('https://huggingface.co/spaces/nateraw/dreambooth-training',...)

edit_discussion_comment

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • discussion_num (int) — Discussion 또는 Pull Request의 번호입니다. 엄밀히 양의 정수여야 합니다.
  • comment_id (str) — 수정할 댓글의 ID입니다.
  • new_content (str) — 댓글의 새 내용입니다. 댓글은 마크다운 형식을 지원합니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 업로드하는 경우 "dataset" 또는 "space"로, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

DiscussionComment

수정된 댓글

Discussion / Pull Request의 댓글을 수정합니다.

다음 오류를 발생시킵니다:

  • HuggingFace API가 오류를 반환하면 HTTPError
  • ValueError 일부 매개변수 값이 잘못된 경우
  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.

enable_space_dev_mode

< >

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

매개변수

  • repo_id (str) — dev 모드를 활성화할 Space의 ID입니다. 예: "Salesforce/BLIP2".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

SpaceRuntime

Space에 대한 런타임 정보.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 HfHubHTTPError 또는 BadRequestError

  • RepositoryNotFoundError — Space가 찾을 수 없는 경우(에러 404). 가장 가능성 높은 원인은 잘못된 repo_id이거나, Space가 비공개인데 인증되지 않은 상태입니다.
  • HfHubHTTPError — 403 Forbidden: Space의 소유자만 dev mode를 설정할 수 있습니다. 소유하지 않은 Space를 처리하려면 Discussion을 열어 소유자에게 요청하거나 Space를 복제하세요.
  • BadRequestError — Space가 정적 Space인 경우입니다. 정적 Space는 항상 실행되며 과금되지 않습니다. 정적 Space를 숨기려면 비공개로 설정할 수 있습니다.

Space에서 개발 모드를 활성화합니다.

Spaces Dev Mode은 Space 컨테이너 자체를 중지하지 않고 애플리케이션을 재시작할 수 있도록 하여 애플리케이션 디버깅을 용이하게 하고 Spaces 반복 개발 속도를 높입니다. 이 기능은 PRO 또는 Team & Enterprise 플랜의 일부로 제공됩니다. 자세한 내용은 https://huggingface.co/docs/hub/spaces-dev-mode를 참조하세요.

enable_webhook

< >

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

매개변수

  • webhook_id (str) — 활성화할 웹훅의 고유 식별자입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다(자세한 내용은 https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

WebhookInfo

활성화된 웹훅에 대한 정보.

웹훅 활성화(“활성”으로 설정).

예:

>>> from huggingface_hub import enable_webhook
>>> enabled_webhook = enable_webhook("654bbbc16f2ec14d77f109cc")
>>> enabled_webhook
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    job=None,
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo", "discussion"],
    secret="my-secret",
    disabled=False,
)

fetch_job_logs

< >

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

매개변수

  • job_id (str) — Job의 ID입니다.
  • namespace (str, 선택 사항) — Job이 실행되는 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • follow (bool, 선택) — True인 경우, 작업이 완료될 때까지 실시간으로 로그를 스트리밍합니다(블로킹). False(기본값)인 경우, 현재 사용 가능한 로그만 가져오고 즉시 반환합니다(논블로킹).
  • tail (int, 선택 사항) — 로그에서 반환할 최대 줄 수입니다. follow=True와 함께 사용할 경우, 마지막 N줄부터 시작하여 새로운 로그를 계속 스트리밍합니다. follow=False인 경우, 현재 사용 가능한 로그에서 마지막 N줄만 반환합니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face 인프라의 compute Job에서 모든 로그를 가져옵니다.

예:

>>> from huggingface_hub import fetch_job_logs, run_job
>>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"])
>>> for log in fetch_job_logs(job_id=job.id):
...     print(log)
Hello from HF compute!

>>> # Non-blocking: fetch only currently available logs
>>> for log in fetch_job_logs(job_id=job.id, follow=False):
...     print(log)

>>> # Stream logs starting from the last 100 lines
>>> for log in fetch_job_logs(job_id=job.id, follow=True, tail=100):
...     print(log)

fetch_job_metrics

< >

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

매개변수

  • job_id (str) — Job의 ID입니다.
  • namespace (str, 선택 사항) — Job이 실행되는 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • follow (bool, 선택) — True인 경우, 작업이 완료될 때까지 실시간으로 스트림 메트릭을 수신합니다(블로킹). False(기본값)인 경우, 현재 메트릭만 가져와 반환합니다(논블로킹).
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face 인프라의 compute Job에서 실시간 메트릭을 가져옵니다.

예:

>>> from huggingface_hub import fetch_job_metrics, run_job
>>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"], flavor="a10g-small")
>>> for metrics in fetch_job_metrics(job_id=job.id):
...     print(metrics)
{
    "cpu_usage_pct": 0,
    "cpu_millicores": 3500,
    "memory_used_bytes": 1306624,
    "memory_total_bytes": 15032385536,
    "rx_bps": 0,
    "tx_bps": 0,
    "gpus": {
        "882fa930": {
            "utilization": 0,
            "memory_used_bytes": 0,
            "memory_total_bytes": 22836000000
        }
    },
    "replica": "57vr7"
}

>>> # Stream metrics until the job completes
>>> for metrics in fetch_job_metrics(job_id=job.id, follow=True):
...     print(metrics)

fetch_space_logs

< >

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

매개변수

  • repo_id (str) — Space의 ID입니다. 예: "bigcode/in-the-stack".
  • build (bool, 선택 사항, 기본값 False) — True인 경우 컨테이너 빌드 로그를 가져옵니다(BUILD_ERROR 상태에 멈춰 있는 Space의 경우 유용합니다). False(기본값)인 경우 실행 로그, 즉 실행 중인 애플리케이션의 stdout/stderr를 가져옵니다.
  • follow (bool, 선택 사항, 기본값 False) — True인 경우, 서버가 스트림을 닫거나 KeyboardInterrupt가 발생하기까지 실시간으로(블로킹) 스트림 로그를 출력합니다. False(기본값)인 경우, 현재 버퍼에 있는 로그만 가져오고 즉시 반환합니다(논블로킹, docker logs와 유사).
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰입니다. 기본값은 로컬에 저장된 토큰이며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정합니다. https://huggingface.co/docs/huggingface_hub/quick-start#authentication를 참조하세요.

반환값

Iterable[str]

사용 가능해짐에 따라 로그 줄을 생성하는 생성기(generator).

Hub의 Space 실행 또는 빌드 로그를 가져옵니다.

빌드가 실패하거나 런타임에 크래시되는 Space를 디버깅하는 데 유용하며, 특히 브라우저에서 로그를 읽을 수 없는 스크립트 또는 에이전틱 워크플로에서 유용합니다.

예:

>>> from huggingface_hub import fetch_space_logs
>>> # Non-blocking: print currently available run logs and exit.
>>> for line in fetch_space_logs("username/my-space"):
...     print(line, end="")

>>> # Debug a build failure:
>>> for line in fetch_space_logs("username/my-space", build=True):
...     print(line, end="")

>>> # Stream run logs until the server closes the stream.
>>> for line in fetch_space_logs("username/my-space", follow=True):
...     print(line, end="")

file_exists

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • filename (str) — 확인할 파일의 이름, 예: "config.json"
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에서 저장소 정보를 가져오는 경우 "dataset" 또는 "space"로 설정하고, 모델에서 저장소 정보를 가져오는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • revision (str, 선택 사항) — 정보를 가져올 저장소의 리비전입니다. 기본값은 "main" 브랜치입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Hugging Face Hub의 저장소에 파일이 존재하는지 확인합니다.

예:

>>> from huggingface_hub import file_exists
>>> file_exists("bigcode/starcoder", "config.json")
True
>>> file_exists("bigcode/starcoder", "not-a-file")
False
>>> file_exists("bigcode/not-a-repo", "config.json")
False

get_bucket_file_metadata

< >

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

매개변수

  • bucket_id (str) — 버킷의 ID(예: "username/my-bucket").
  • remote_path (str) — 버킷 내 파일의 경로입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

BucketFileMetadata

크기와 xet 정보를 포함하는 파일 메타데이터입니다.

bucket의 파일 메타데이터를 가져옵니다.

예:

>>> from huggingface_hub import get_bucket_file_metadata
>>> metadata = get_bucket_file_metadata(
...     bucket_id="username/my-bucket",
...     remote_path="models/model.safetensors",
... )
>>> metadata.size
42000

get_bucket_paths_info

< >

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

매개변수

  • bucket_id (str) — 버킷의 ID(예: "username/my-bucket").
  • paths (Iterable[str]) — 정보를 가져올 경로입니다. 경로가 존재하지 않으면 예외를 발생시키지 않고 무시됩니다. 파일 경로만 지원됩니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[BucketFile]

The information about the paths, as an iterable of BucketFile objects.

Get information about a bucket’s paths.

호출은 1000개 경로씩 배치로 수행됩니다. 결과가 수신되는 대로 반환됩니다.

예:

>>> from huggingface_hub import get_bucket_paths_info
>>> paths_info = get_bucket_paths_info("username/my-bucket", ["file.txt", "checkpoints/model.safetensors"])
>>> for info in paths_info:
...     print(info)
BucketFile(type='file', path='file.txt', size=2379, xet_hash='96e637d9665bd35477b1908a23f2e254edfba0618dbd2d62f90a6baee7d139cf', mtime=datetime.datetime(2024, 9, 25, 15, 31, 2, 346000, tzinfo=datetime.timezone.utc))
BucketFile(type='file', path='checkpoints/model.safetensors', size=2408828, xet_hash='3ed0e9fefe788ddd61d1e26eba67057e9740a064b009256fbafadf6bb95785ca', mtime=datetime.datetime(2024, 9, 25, 15, 31, 2, 346000, tzinfo=datetime.timezone.utc))

get_collection

< >

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

매개변수

  • collection_slug (str) — Hub의 컬렉션 슬러그입니다. 예: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Hub의 Collection에 대한 정보를 가져옵니다.

반환값: Collection

예:

>>> from huggingface_hub import get_collection
>>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")
>>> collection.title
'Recent models'
>>> len(collection.items)
37
>>> collection.items[0]
CollectionItem(
    item_object_id='651446103cd773a050bf64c2',
    item_id='TheBloke/U-Amethyst-20B-AWQ',
    item_type='model',
    position=88,
    note=None
)

get_dataset_leaderboard

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름입니다. 예: "allenai/olmOCR-bench".
  • base_model_only (bool 또는 None, 선택 사항) — 기본적으로 리더보드에는 선언된 base_model 관계가 없는 모델(즉, canonical/root 저장소)만 포함되며, 이는 Hub의 기본 리더보드 뷰와 일치합니다. 부모 모델을 선언한 fine-tuned 또는 derivative 저장소는 제외됩니다. 이 필터를 비활성화하고 모델이 base model 관계를 선언했는지 여부와 관계없이 모든 제출된 결과를 포함하려면 base_model_only=False를 전달하세요.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • timeout (float, 선택 사항) — Hub에 대한 요청에 타임아웃을 설정할지 여부.

반환값

list[DatasetLeaderboardEntry]

랭크 순으로 정렬된 리더보드 항목을 나타내는 DatasetLeaderboardEntry 객체의 목록입니다.

Hub의 데이터셋에 대한 리더보드를 가져옵니다.

리더보드는 주어진 벤치마크 데이터셋에 대한 평가 점수를 기준으로 모델을 순위 매깁니다. 모든 데이터셋에 리더보드가 있는 것은 아니며, 평가 결과가 제출된 벤치마크 데이터셋에만 리더보드가 있습니다. 이를 통해 데이터셋 중심의 점수 관점을 제공합니다. 모델 중심의 관점을 보려면 expand=["evalResults"]를 사용하여 model_info()를 사용하세요.

다음 오류를 발생시킵니다:

  • RepositoryNotFoundError 저장소를 찾을 수 없는 경우. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.
  • HfHubHTTPError 데이터셋에 리더보드가 없는 경우.

예:

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

< >

( )

…

get_discussion_details

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • discussion_num (int) — Discussion 또는 Pull Request의 번호입니다. 엄밀히 양의 정수여야 합니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 업로드하는 경우 "dataset" 또는 "space"로, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Hub에서 Discussion / Pull Request의 세부 정보를 가져옵니다.

반환값: DiscussionWithDetails

다음 오류를 발생시킵니다:

  • HuggingFace API가 오류를 반환하면 HTTPError
  • ValueError 일부 매개변수 값이 잘못된 경우
  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.

get_full_repo_name

< >

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

매개변수

  • model_id (str) — 모델의 이름입니다.
  • organization (str, 선택 사항) — 값이 전달되면, 저장소 이름이 사용자 네임스페이스 대신 조직 네임스페이스에 생성됩니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

str

조직이 전달되지 않으면 사용자 네임스페이스의 저장소 이름 ({username}/{model_id}), 그렇지 않으면 조직 네임스페이스의 ({organization}/{model_id})입니다.

주어진 모델 ID와 선택적 조직에 대해 저장소 이름을 반환합니다.

get_hf_file_metadata

< >

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

매개변수

  • url (str) — hf_hub_url()에서 반환된 것과 같은 파일 URL
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • timeout (float, 선택 사항, 기본값 10) — 서버가 메타데이터를 보내기까지 대기할 초 단위입니다.

주어진 url에 대해 Hub에서 버전 관리된 파일의 메타데이터를 가져옵니다.

get_inference_endpoint

< >

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

매개변수

  • name (str) — 정보를 가져올 Inference Endpoint의 이름입니다.
  • namespace (str, 선택 사항) — Inference Endpoint가 위치한 namespace입니다. 기본값은 현재 사용자입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

InferenceEndpoint

요청한 Inference Endpoint에 대한 정보.

Inference Endpoint에 대한 정보를 가져옵니다.

예:

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

< >

( )

…

get_organization_overview

< >

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

매개변수

  • organization (str) — 개요를 가져올 조직의 이름.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다(자세한 내용은 https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Organization

조직 개요가 포함된 Organization 객체입니다.

다음 예외가 발생합니다

HTTPError

  • HTTPError — Hub에 해당 조직이 존재하지 않는 경우 HTTP 404

Hub에서 조직에 대한 개요를 확인합니다.

get_paths_info

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • paths (Union[list[str], str], 선택 사항) — 정보를 가져올 경로입니다. 경로가 존재하지 않으면 예외를 발생시키지 않고 무시됩니다.
  • expand (bool, 선택 사항, 기본값 False) — 경로에 대한 추가 정보(예: 마지막 커밋 및 파일 보안 스캔 결과)를 가져올지 여부입니다. 이 작업은 서버에 더 많은 부하를 주기 때문에 페이지당 50개 결과만 반환됩니다(1000개가 아님). 페이지네이션은 huggingface_hub에서 구현되어 있으므로, 결과를 가져오는 데 걸리는 시간만 제외하면 사용자에게는 투명하게 처리됩니다.
  • revision (str, 선택 사항) — 정보를 가져올 저장소의 리비전입니다. 기본값은 "main" 브랜치입니다.
  • repo_type (str, 선택 사항) — 정보를 가져올 저장소의 유형입니다. ("model", "dataset" 또는 "space". 기본값은 "model"입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

list[Union[RepoFile, RepoFolder]]

The information about the paths, as a list of RepoFile and RepoFolder objects.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 RevisionNotFoundError

  • RepositoryNotFoundError — 리포지토리가 찾을 수 없는 경우(에러 404): repo_id/repo_type이(가) 잘못되었거나, 비공개이지만 인증되지 않았거나, 리포지토리가 존재하지 않는 경우.
  • RevisionNotFoundError — 리포지토리에서 revision을 찾을 수 없는 경우(에러 404).

레포지토리의 경로에 대한 정보를 가져옵니다.

예:

>>> from huggingface_hub import get_paths_info
>>> paths_info = get_paths_info("allenai/c4", ["README.md", "en"], repo_type="dataset")
>>> paths_info
[
    RepoFile(path='README.md', size=2379, blob_id='f84cb4c97182890fc1dbdeaf1a6a468fd27b4fff', lfs=None, last_commit=None, security=None),
    RepoFolder(path='en', tree_id='dc943c4c40f53d02b31ced1defa7e5f438d5862e', last_commit=None)
]

get_repo_discussions

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • author (str, 선택 사항) — 토론 작성자로 필터링할 값을 전달합니다. None은 필터링하지 않음을 의미합니다. 기본값은 None입니다.
  • discussion_type (str, 선택 사항) — 풀 리퀘스트만 가져오려면 "pull_request"로, 디스커션만 가져오려면 "discussion"으로 설정합니다. 둘 다 가져오려면 "all" 또는 None으로 설정합니다. 기본값은 None입니다.
  • discussion_status (str, 선택 사항) — "open"(각각 "closed")로 설정하면 열려 있는(각각 닫혀 있는) 토론만 가져옵니다. "all" 또는 None으로 설정하면 둘 다 가져옵니다. 기본값은 None입니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에서 가져오는 경우 "dataset" 또는 "space"로, 모델에서 가져오는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterator[Discussion]

Discussion 객체의 반복자입니다.

지정된 저장소의 Discussions와 Pull Requests를 가져옵니다.

예:

리포지토리의 모든 토론을 목록으로 수집하기:

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

리포지토리의 토론 반복:

>>> from huggingface_hub import get_repo_discussions
>>> for discussion in get_repo_discussions(repo_id="bert-base-uncased"):
...     print(discussion.num, discussion.title)

get_safetensors_metadata

< >

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

매개변수

  • repo_id (str) — /로 구분된 사용자 또는 조직 이름과 저장소 이름.
  • repo_type (str, 선택 사항) — 파일이 dataset 또는 space에 있는 경우 "dataset" 또는 "space"로 설정하고, model에 있는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • revision (str, 선택 사항) — 파일을 가져올 git revision입니다. 브랜치 이름, 태그 또는 커밋 해시를 사용할 수 있습니다. 기본값은 "main" 브랜치의 head입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • timeout (float, 선택 사항, 기본값 10) — safetensors 파일 헤더를 가져오는 각 요청에 대해 서버가 데이터를 보내기까지 대기할 초 수입니다. 타임아웃을 비활성화하려면 None으로 설정하십시오(추천하지 않습니다. 연결이 중단되면 호출이 무한정 멈출 수 있습니다).

반환값

SafetensorsRepoMetadata

safetensors 저장소와 관련된 정보

다음 예외가 발생합니다

NotASafetensorsRepoError 또는 SafetensorsParsingError

  • NotASafetensorsRepoError — 리포지토리가 safetensors 리포지토리가 아닌 경우, 즉 model.safetensors 또는 model.safetensors.index.json 파일이 없는 경우.
  • SafetensorsParsingError — safetensors 파일 헤더를 올바르게 파싱하지 못한 경우.

Hub의 safetensors 저장소에 대한 메타데이터를 파싱합니다.

먼저 저장소가 단일 safetensors 파일인지, 아니면 샤드된 safetensors 저장소인지 확인합니다. 단일 safetensors 파일인 경우, 해당 파일에서 메타데이터를 파싱합니다. 샤드된 safetensors 저장소인 경우, 인덱스 파일에서 메타데이터를 파싱한 후 각 샤드에서 메타데이터를 파싱합니다.

단일 safetensors 파일에서 메타데이터를 파싱하려면 parse_safetensors_file_metadata()를 사용합니다. main에서 샤드된 모델의 모든 샤드 헤더를 한 번의 요청으로 가져오려면 get_sharded_safetensors_metadata()를 사용합니다.

safetensors 형식에 대한 자세한 내용은 https://huggingface.co/docs/safetensors/index#format을 확인하세요.

예:

# Parse repo with single weights file
>>> metadata = get_safetensors_metadata("bigscience/bloomz-560m")
>>> metadata
SafetensorsRepoMetadata(
    metadata=None,
    sharded=False,
    weight_map={'h.0.input_layernorm.bias': 'model.safetensors', ...},
    files_metadata={'model.safetensors': SafetensorsFileMetadata(...)}
)
>>> metadata.files_metadata["model.safetensors"].metadata
{'format': 'pt'}

# Parse repo with sharded model
>>> metadata = get_safetensors_metadata("bigscience/bloom")
Parse safetensors files: 100%|██████████████████████████████████████████| 72/72 [00:12<00:00,  5.78it/s]
>>> metadata
SafetensorsRepoMetadata(metadata={'total_size': 352494542848}, sharded=True, weight_map={...}, files_metadata={...})
>>> len(metadata.files_metadata)
72  # All safetensors files have been fetched

# Parse repo with sharded model
>>> get_safetensors_metadata("runwayml/stable-diffusion-v1-5")
NotASafetensorsRepoError: 'runwayml/stable-diffusion-v1-5' is not a safetensors repo. Couldn't find 'model.safetensors.index.json' or 'model.safetensors' files.

get_sharded_safetensors_metadata

< >

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

매개변수

  • repo_id (str) — /로 구분된 사용자 또는 조직 이름과 저장소 이름.
  • filename (str, 선택 사항) — 리포지토리에서 safetensors 인덱스 파일의 경로입니다. 기본값은 "model.safetensors.index.json"입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • timeout (float, 선택 사항, 기본값 10) — 서버가 데이터를 보내기까지 대기할 초 수입니다. 타임아웃을 비활성화하려면 None으로 설정하세요(추천하지 않습니다. 연결이 중단되면 호출이 무한정 멈출 수 있습니다).

반환값

SafetensorsRepoMetadata

get_safetensors_metadata()와 동일한 메타데이터

main의 Hub에서 샤드화된 safetensors 모델의 모든 샤드 메타데이터를 get_safetensors_metadata()가 각 샤드 헤더를 파싱하는 대신 단일 요청으로 가져옵니다. Hugging Face Hub 전용입니다.

예:

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

get_space_runtime

< >

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

매개변수

  • repo_id (str) — 업데이트할 저장소의 ID입니다. 예: "bigcode/in-the-stack".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

SpaceRuntime

Space의 스테이지와 하드웨어를 포함한 런타임 정보

Space에 대한 런타임 정보를 가져옵니다.

get_space_secrets

< >

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

매개변수

  • repo_id (str) — 쿼리할 저장소의 ID. 예: "bigcode/in-the-stack".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

dict[str, SpaceSecret]

비밀 이름으로 키가 지정된 SpaceSecret 객체의 사전입니다.

Space에서 모든 secrets를 가져옵니다.

Secret 값은 쓰기 전용이며 다시 읽을 수 없습니다. 키, 설명, 마지막 업데이트 시간만 반환됩니다.

Secrets를 사용하면 Space에 시크릿 키나 토큰을 하드코딩하지 않고 설정할 수 있습니다. 자세한 내용은 https://huggingface.co/docs/hub/spaces-overview#managing-secrets를 참조하세요.

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.get_space_secrets("username/my-space")
{'HF_TOKEN': SpaceSecret(key='HF_TOKEN', description='...', updated_at=datetime.datetime(...))}

get_space_variables

< >

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

매개변수

  • repo_id (str) — 쿼리할 저장소의 ID. 예: "bigcode/in-the-stack".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Space에서 모든 변수를 가져옵니다.

Variables를 사용하면 Space에 환경 변수를 하드코딩하지 않고 설정할 수 있습니다. 자세한 내용은 https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables를 참조하세요.

get_user_overview

< >

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

매개변수

  • username (str) — 개요를 가져올 사용자의 사용자 이름입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

User

사용자 개요를 포함하는 User 객체.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — Hub에 해당 사용자가 없는 경우 HTTP 404.

Hub에서 사용자의 개요를 확인합니다.

get_webhook

< >

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

매개변수

  • webhook_id (str) — 가져올 webhook의 고유 식별자입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다(자세한 내용은 https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

WebhookInfo

웹훅에 대한 정보입니다.

id로 웹훅을 가져옵니다.

예:

>>> from huggingface_hub import get_webhook
>>> webhook = get_webhook("654bbbc16f2ec14d77f109cc")
>>> print(webhook)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    job=None,
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    secret="my-secret",
    domains=["repo", "discussion"],
    disabled=False,
)

get_zero_gpu_quota

< >

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

매개변수

  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 세분화된 토큰은 “Billing > Read billing usage and payment method status” 권한이 필요하고, OAuth 토큰은 read-billing 스코프가 필요합니다.

반환값

ZeroGpuQuota

인증된 사용자의 ZeroGPU 할당량입니다.

인증된 사용자의 ZeroGPU 할당량을 가져옵니다.

ZeroGPU Spaces를 프로그래매틱하게 호출할 때(예: 앱, 에이전트 또는 MCP 서버에서) ZeroGPU 사용량을 추적하는 데 유용합니다. 자세한 내용은 https://huggingface.co/docs/hub/spaces-zerogpu를 참조하세요.

예:

>>> from huggingface_hub import get_zero_gpu_quota
>>> quota = get_zero_gpu_quota()
>>> quota
ZeroGpuQuota(base=2400, remaining=1810, resets_at=datetime.datetime(2026, 9, 30, 9, 12, 3, tzinfo=datetime.timezone.utc), overquota_used=0)
>>> print(f"{quota.remaining / 60:.1f} minutes left")
30.2 minutes left

grant_access

< >

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

매개변수

  • repo_id (str) — 액세스를 부여할 저장소의 ID입니다.
  • user (str) — 액세스를 부여할 사용자의 사용자 이름입니다.
  • repo_type (str, 선택 사항) — 액세스를 부여할 저장소의 유형입니다. model, dataset, space 중 하나여야 합니다. 기본값은 model입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — 리포지토리가 게이트되지 않은 경우 HTTP 400.
  • HfHubHTTPError — 사용자가 이미 저장소에 액세스 권한이 있는 경우 HTTP 400.
  • HfHubHTTPError — 리포지토리에 읽기 전용 액세스 권한만 있는 경우 HTTP 403이 발생합니다. 리포지토리가 속해 있는 조직에서 write 또는 admin 역할을 가지고 있지 않거나, read 토큰을 전달한 경우 이러한 상황이 발생할 수 있습니다.
  • HfHubHTTPError — Hub에 해당 사용자가 존재하지 않으면 HTTP 404를 반환합니다.

gated 리포지토리에 대해 특정 사용자에게 액세스 권한을 부여합니다.

액세스를 부여하면 사용자가 직접 액세스 요청을 보내야 할 필요가 없습니다. 사용자는 자동으로 승인 목록에 추가되어 파일을 다운로드할 수 있습니다. cancel_access_request() 또는 reject_access_request()를 사용하여 언제든 부여된 액세스를 취소할 수 있습니다.

게이트된 리포지토리에 대한 자세한 내용은 https://huggingface.co/docs/hub/models-gated를 참고하세요.

hf_hub_download

< >

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

매개변수

  • repo_id (str) — /로 구분된 사용자 또는 조직 이름과 저장소 이름.
  • filename (str) — 리포지토리 내 파일 이름.
  • subfolder (str, 선택 사항) — 저장소 안의 폴더에 해당하는 선택적 값입니다.
  • repo_type (str, 선택 사항) — dataset 또는 space에서 다운로드하는 경우 "dataset" 또는 "space"로 설정하고, model에서 다운로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • revision (str, 선택 사항) — 브랜치 이름, 태그 또는 커밋 해시일 수 있는 선택적 Git 리비전 ID입니다.
  • cache_dir (str, Path, 선택 사항) — 캐시된 파일이 저장되는 폴더의 경로입니다.
  • local_dir (str 또는 Path, 선택 사항) — 제공된 경우, 다운로드된 파일은 이 디렉터리 아래에 저장됩니다.
  • force_download (bool, 선택 사항, 기본값 False) — 로컬 캐시에 이미 존재하더라도 파일을 다운로드할지 여부.
  • etag_timeout (float, 선택 사항, 기본값 10) — ETag를 가져올 때 서버가 데이터를 보내기까지 대기할 초 수입니다. 이 값은 httpx2.request에 전달됩니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • local_files_only (bool, 선택 사항, 기본값 False) — True인 경우, 파일을 다운로드하지 않고 로컬 캐시 파일이 존재하면 해당 파일의 경로를 반환합니다.
  • tqdm_class (tqdm, 선택 사항) — 지정하면 진행 표시줄의 기본 동작을 덮어씁니다. 전달된 인수는 tqdm.auto.tqdm을 상속하거나 최소한 그 동작을 모방해야 합니다. 기본값은 HF_HUB_DISABLE_PROGRESS_BARS 환경 변수를 설정하여 비활성화할 수 있는 HF의 사용자 정의 진행 표시줄입니다.
  • dry_run (bool, 선택 사항, 기본값 False) — True인 경우, 파일을 실제로 다운로드하지 않고 dry run을 수행합니다. 다운로드될 내용에 대한 정보를 포함하는 DryRunFileInfo 객체를 반환합니다.

반환값

str 또는 DryRunFileInfo

  • dry_run=False인 경우: 파일의 로컬 경로 또는 네트워크가 꺼져 있는 경우 디스크에 캐시된 파일의 마지막 버전.
  • dry_run=True인 경우: 다운로드 정보를 포함하는 DryRunFileInfo 객체.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 RevisionNotFoundError 또는 ~utils.RemoteEntryNotFoundError 또는 LocalEntryNotFoundError 또는 EnvironmentError 또는 OSError 또는 ValueError

  • RepositoryNotFoundError — 다운로드할 저장소를 찾을 수 없는 경우. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.
  • RevisionNotFoundError — 다운로드할 리비전이 찾을 수 없는 경우.
  • ~utils.RemoteEntryNotFoundError — 다운로드할 파일을 찾을 수 없는 경우.
  • LocalEntryNotFoundError — 네트워크가 비활성화되었거나 사용할 수 없고 캐시에서 파일을 찾을 수 없는 경우.
  • EnvironmentError — token=True이지만 토큰을 찾을 수 없는 경우.
  • OSError — ETag을 결정할 수 없는 경우.
  • ValueError — 일부 매개변수 값이 잘못된 경우.

local cache에 이미 존재하지 않는 경우 주어진 파일을 다운로드합니다.

새로운 캐시 파일 레이아웃은 다음과 같습니다:

  • 캐시 디렉터리에는 repo_id별로(리포 유형으로 네임스페이스가 지정된) 하위 폴더가 하나씩 포함되어 있습니다
  • 각 저장소 폴더 안에는:
    • refs는 최신 알려진 revision => commit_hash 쌍의 목록입니다
    • blobs에는 실제 파일 blobs가 포함됩니다(LFS 파일인지 여부에 따라 git-sha 또는 sha256으로 식별됩니다).
    • snapshots에는 커밋별로 하나의 하위 폴더가 포함되어 있으며, 각 “commit”에는 해당 특정 커밋에서 해결된 파일의 부분 집합이 들어 있습니다. 각 파일 이름은 해당 특정 커밋의 blob으로 향하는 심볼릭 링크입니다.
[  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

local_dir가 제공되면, 저장소의 파일 구조가 해당 위치에 복제됩니다. 이 옵션을 사용할 경우 cache_dir은 사용되지 않으며, 다운로드된 파일과 관련된 일부 메타데이터를 저장하기 위해 local_dir의 루트에 .cache/huggingface/ 폴더가 생성됩니다. 이 메커니즘은 메인 캐시 시스템만큼 견고하지는 않지만, 저장소의 최신 버전을 정기적으로 가져오는 작업에 최적화되어 있습니다.

토론 댓글 숨기기

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • discussion_num (int) — Discussion 또는 Pull Request의 번호입니다. 엄밀히 양의 정수여야 합니다.
  • comment_id (str) — 수정할 댓글의 ID입니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 업로드하는 경우 "dataset" 또는 "space"로, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

DiscussionComment

숨겨진 댓글

Discussion / Pull Request의 댓글을 숨깁니다.

숨겨진 댓글의 내용은 더 이상 검색할 수 없습니다. 댓글을 숨기는 작업은 되돌릴 수 없습니다.

다음 오류를 발생시킵니다:

  • HuggingFace API가 오류를 반환하면 HTTPError
  • ValueError 일부 매개변수 값이 잘못된 경우
  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.

inspect_job

< >

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

매개변수

  • job_id (str) — Job의 ID입니다.
  • namespace (str, 선택 사항) — Job이 실행되는 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face 인프라에서 compute Job을 검사합니다.

예:

>>> from huggingface_hub import inspect_job, run_job
>>> job = run_job(image="python:3.12", command=["python", "-c" ,"print('Hello from HF compute!')"])
>>> inspect_job(job_id=job.id)
JobInfo(
    id='68780d00bbe36d38803f645f',
    created_at=datetime.datetime(2025, 7, 16, 20, 35, 12, 808000, tzinfo=datetime.timezone.utc),
    docker_image='python:3.12',
    space_id=None,
    command=['python', '-c', "print('Hello from HF compute!')"],
    arguments=[],
    environment={},
    secrets={},
    flavor='cpu-basic',
    status=JobStatus(stage='RUNNING', message=None)
)

inspect_scheduled_job

< >

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

매개변수

  • scheduled_job_id (str) — 예약된 Job의 ID입니다.
  • namespace (str, 선택 사항) — 예약된 Job이 있는 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face 인프라에서 예약된 compute Job을 검사합니다.

예:

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

kernel_info

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • revision (str, 선택 사항) — 정보를 가져올 커널 저장소의 리비전입니다.
  • timeout (float, 선택 사항) — Hub에 대한 요청에 타임아웃을 설정할지 여부.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

ModelInfo

커널 저장소 정보

huggingface.co에서 특정 커널 하나에 대한 정보를 가져옵니다.

list_accepted_access_requests

< >

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

매개변수

  • repo_id (str) — 액세스 요청을 가져올 저장소의 id입니다.
  • repo_type (str, 선택 사항) — 액세스 요청을 가져올 리포지토리의 유형입니다. model, dataset, space 중 하나여야 합니다. 기본값은 model입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[AccessRequest]

AccessRequest 객체의 반복 가능한 객체입니다. 각 항목에는 username, request_id, email, status, timestamp 속성이 포함됩니다. 게이트된 저장소에 사용자 정의 양식이 있는 경우, fields 속성에 사용자의 답변이 채워집니다.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — 리포지토리가 게이트되지 않은 경우 HTTP 400.
  • HfHubHTTPError — 리포지토리에 읽기 전용 액세스 권한만 있는 경우 HTTP 403이 발생합니다. 리포지토리가 속해 있는 조직에서 write 또는 admin 역할을 가지고 있지 않거나, read 토큰을 전달한 경우 이러한 상황이 발생할 수 있습니다.

gated 리포지토리에 대한 승인된 액세스 요청을 가져옵니다.

승인된 요청은 사용자가 저장소 접근을 요청했고 해당 요청이 승인되었음을 의미합니다. 사용자는 저장소의 모든 파일을 다운로드할 수 있습니다. 승인 모드가 자동인 경우, 이 목록에는 기본적으로 모든 요청이 포함되어야 합니다. 승인된 요청은 cancel_access_request()와 reject_access_request()를 사용하여 언제든지 취소하거나 거절할 수 있습니다. 취소된 요청은 대기 목록으로 돌아가고, 거절된 요청은 거절 목록으로 이동합니다. 두 경우 모두 사용자는 저장소 접근 권한을 잃게 됩니다.

게이트된 리포지토리에 대한 자세한 내용은 https://huggingface.co/docs/hub/models-gated를 참고하세요.

예:

>>> from huggingface_hub import list_accepted_access_requests

>>> requests = list(list_accepted_access_requests("meta-llama/Llama-2-7b"))
>>> len(requests)
411
>>> requests[0]
[
    AccessRequest(
        username='clem',
        request_id='655f3a1c9e6b2d4f8a7c1e05',
        fullname='Clem 🤗',
        email='***',
        timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc),
        status='accepted',
        fields=None,
    ),
    ...
]

list_bucket_tree

< >

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

매개변수

  • bucket_id (str) — 버킷의 ID(예: "username/my-bucket").
  • prefix (str, 선택 사항) — 경로가 이 접두사로 시작하는 파일로 결과를 필터링합니다.
  • recursive (bool, 선택 사항) — True인 경우 파일을 재귀적으로 나열합니다. False(기본값)인 경우 루트에만 있는 파일과 디렉터리만 나열합니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[Union[BucketFile, BucketFolder]]

파일 및 디렉터리 정보(경로 등)를 포함하는 BucketFile 및 BucketFolder 객체의 반복 가능한 객체

버킷의 파일 목록을 표시합니다.

예:

>>> from huggingface_hub import list_bucket_tree
>>> for file_info in list_bucket_tree(bucket_id="username/my-bucket"):
...     print(file_info.path)

>>> # Filter by prefix
>>> for file_info in list_bucket_tree(bucket_id="username/my-bucket", prefix="models/"):
...     print(file_info.path)

list_buckets

< >

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

매개변수

  • namespace (str, 선택 사항) — 이 namespace(사용자 또는 조직) 아래에 있는 버킷을 나열합니다. 기본적으로 사용자의 버킷을 나열합니다.
  • search (str, 선택 사항) — 버킷 이름을 필터링할 검색 문자열입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[BucketInfo]

BucketInfo 객체의 반복 가능한 객체입니다.

namespace 아래에 Hub의 버킷을 나열합니다.

예:

>>> from huggingface_hub import list_buckets
>>> for bucket in list_buckets(): # lists buckets in the user's namespace
...     print(bucket)

>>> for bucket in list_buckets(namespace="huggingface"): # lists buckets in the "huggingface" organization
...     print(bucket)

>>> for bucket in list_buckets(search="my-prefix"): # filter buckets by name
...     print(bucket)

list_collections

< >

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

매개변수

  • owner (list[str] 또는 str, 선택) — 소유자의 사용자 이름으로 필터링합니다.
  • item (list[str] 또는 str, 선택 사항) — 특정 항목을 포함하는 컬렉션을 필터링합니다. 예: "models/teknium/OpenHermes-2.5-Mistral-7B", "datasets/squad" 또는 "papers/2311.12983".
  • sort (Literal["lastModified", "trending", "upvotes"], 선택 사항) — 컬렉션을 마지막 수정 시간, 트렌딩, 업보트 순서로 정렬합니다.
  • limit (int, 선택 사항) — 반환할 컬렉션의 최대 개수.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[Collection]

Collection 객체의 반복 가능한 객체

일부 필터를 기준으로 Huggingface Hub에 있는 컬렉션을 나열합니다.

컬렉션을 나열할 때, 컬렉션별 항목 목록은 최대 4개 항목으로 잘립니다. 컬렉션의 모든 항목을 가져오려면 get_collection()을 사용해야 합니다.

list_daily_papers

< >

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

매개변수

  • date (str, 선택 사항) — 일일 논문을 가져올 ISO 형식(YYYY-MM-DD) 날짜입니다. 기본값은 가장 최근 날짜입니다.
  • token (Union[bool, str, None], 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰입니다. 인증을 비활성화하려면 False를 전달하세요.
  • week (str, 선택 사항) — 일일 논문을 가져올 ISO 형식(YYYY-Www)의 주. 예: 2025-W09.
  • month (str, 선택 사항) — 일일 논문을 가져올 ISO 형식(YYYY-MM)의 월. 예: 2025-02.
  • submitter (str, 선택 사항) — 일일 논문을 필터링할 제출자의 사용자 이름입니다.
  • sort (Literal["publishedAt", "trending"], 선택 사항) — 일일 논문의 정렬 순서입니다. publishedAt 또는 trending 중 하나로 지정할 수 있습니다. 기본값은 "publishedAt"입니다.
  • p (int, 선택 사항) — 페이지네이션을 위한 페이지 번호. 기본값은 0입니다.
  • limit (int, 선택 사항) — 가져올 논문 수의 제한입니다. 기본값은 50입니다.

반환값

Iterable[PaperInfo]

huggingface_hub.hf_api.PaperInfo 객체의 반복 가능한 객체입니다.

Hugging Face Hub에서 특정 날짜에 게시된 일일 페이퍼 목록을 나열합니다.

예:

>>> from huggingface_hub import HfApi

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

list_dataset_parquet_files

< >

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

매개변수

  • repo_id (str) — 데이터셋 저장소 ID(예: "username/dataset-name").
  • config (str, 선택 사항) — 특정 config/subset 이름으로 필터링합니다. 값이 제공되면 해당 config에 대한 parquet 파일만 반환됩니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

list[DatasetParquetEntry]

각 parquet 파일의 config, split, url, size를 포함하는 DatasetParquetEntry 객체의 목록

Hub의 데이터셋에서 사용할 수 있는 parquet 파일 목록을 표시합니다.

Hub에 호스팅된 모든 데이터셋은 Dataset Viewer에 의해 자동으로 Parquet로 변환됩니다. 이 메서드는 URL, config, split, size가 포함된 parquet 파일 목록을 반환합니다.

예:

>>> from huggingface_hub import list_dataset_parquet_files
>>> list_dataset_parquet_files("lhoestq/demo1")
>>> entries[0]
DatasetParquetEntry(config='default', split='train', url='https://huggingface.co/...', size=5038)

list_datasets

< >

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

매개변수

  • filter (str 또는 Iterable[str], 선택 사항) — Hub에서 데이터셋을 필터링할 문자열 또는 문자열 목록입니다.
  • author (str, 선택 사항) — 반환되는 데이터셋의 저자를 식별하는 문자열입니다.
  • benchmark (True, "official", str, 선택 사항) — 벤치마크로 데이터셋을 필터링합니다. True 또는 "official"을 사용하면 공식 벤치마크 데이터셋을 반환합니다. 향후 호환성을 위해 벤치마크 이름을 나타내는 문자열도 사용할 수 있습니다(현재는 “official”만 지원됨).
  • dataset_name (str, 선택 사항) — Hub에서 SQAC 또는 wikineural과 같은 이름으로 데이터셋을 식별하는 데 사용할 수 있는 문자열 또는 문자열 목록
  • gated (bool, 선택 사항) — Hub의 데이터셋이 gated인지 여부에 따라 필터링할 수 있는 불리언 값입니다. 기본적으로 모든 데이터셋이 반환됩니다. gated=True를 전달하면 gated 데이터셋만 반환됩니다. gated=False를 전달하면 gated가 아닌 데이터셋만 반환됩니다.
  • language_creators (str 또는 List, 선택 사항) — Hub에서 데이터가 어떻게 큐레이션되었는지를 식별하는 데 사용할 수 있는 문자열 또는 문자열 목록입니다. 예를 들어 crowdsourced 또는 machine_generated와 같은 값이 있습니다.
  • language (str 또는 List, 선택 사항) — Hub에서 데이터셋을 필터링할 두 글자 언어를 나타내는 문자열 또는 문자열 목록입니다.
  • multilinguality (str 또는 List, 선택 사항) — 여러 언어를 포함하는 데이터셋에 대한 필터를 나타내는 문자열 또는 문자열 목록입니다.
  • size_categories (str 또는 List, 선택 사항) — 100K<n<1M 또는 1M<n<10M과 같이 데이터셋의 크기로 Hub에서 데이터셋을 식별하는 데 사용할 수 있는 문자열 또는 문자열 목록입니다.
  • task_categories (str 또는 List, 선택 사항) — audio_classification 또는 named_entity_recognition과 같이 설계된 작업으로 Hub에서 데이터셋을 식별하는 데 사용할 수 있는 문자열 또는 문자열 목록입니다.
  • task_ids (str 또는 List, 선택 사항) — speech_emotion_recognition 또는 paraphrase와 같은 특정 작업으로 Hub에서 데이터셋을 식별하는 데 사용할 수 있는 문자열 또는 문자열 목록입니다.
  • search (str, 선택 사항) — 반환되는 데이터셋에 포함될 문자열입니다.
  • sort (DatasetSort_T, 선택 사항) — 결과 데이터셋을 정렬할 키입니다. 가능한 값은 “created_at”, “downloads”, “last_modified”, “likes”, “trending_score”입니다.
  • limit (int, 선택 사항) — 가져올 데이터셋 수의 제한입니다. 이 옵션을 None으로 두면 모든 데이터셋을 가져옵니다.
  • expand (list[ExpandDatasetProperty_T], 선택 사항) — 응답에 반환할 속성의 목록입니다. 이 매개변수를 사용하면 목록에 포함된 속성만 반환됩니다. full이 전달된 경우 이 매개변수를 사용할 수 없습니다. 가능한 값은 "author", "cardData", "citation", "createdAt", "disabled", "description", "downloads", "downloadsAllTime", "gated", "lastModified", "likes", "mainSize", "paperswithcode_id", "private", "siblings", "sha", "tags", "trendingScore", "usedStorage", "resourceGroup"입니다.
  • full (bool, 선택 사항) — last_modified, card_data 및 파일과 같은 모든 데이터셋 데이터를 가져올지 여부입니다. PapersWithCode ID와 같은 유용한 정보를 포함할 수 있습니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[DatasetInfo]

huggingface_hub.hf_api.DatasetInfo 객체의 반복 가능한 객체입니다.

일부 필터를 기준으로 Huggingface Hub에 호스팅된 데이터셋 목록을 표시합니다.

filter 인수를 사용한 사용 예:

>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all datasets
>>> api.list_datasets()


# List only the text classification datasets
>>> api.list_datasets(filter="task_categories:text-classification")


# List only the datasets in russian for language modeling
>>> api.list_datasets(
...     filter=("language:ru", "task_ids:language-modeling")
... )

# List FiftyOne datasets (identified by the tag "fiftyone" in dataset card)
>>> api.list_datasets(filter="fiftyone")

search 인수를 사용한 사용 예시:

>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all datasets with "text" in their name
>>> api.list_datasets(search="text")

# List all datasets with "text" in their name made by google
>>> api.list_datasets(search="text", author="google")

list_inference_catalog

< >

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

매개변수

  • accelerator (str, 선택 사항) — 해당 가속기("cpu", "gpu" 또는 "neuron")에 레시피가 있는 모델만 반환합니다.
  • engine (str, 선택 사항) — 해당 추론 엔진에 레시피가 있는 모델만 반환합니다 (예: "vllm", "llamacpp", "tei", "sglang").
  • license (str, 선택 사항) — 이 라이선스 하의 모델만 반환합니다 (예: "Apache 2.0").
  • task (str, 선택 사항) — 이 작업(예: "text-generation")에 해당하는 모델만 반환합니다.
  • search (str, 선택 사항) — 이 검색 쿼리와 일치하는 모델만 반환합니다.
  • limit (int, 선택 사항) — 반환할 모델의 최대 수입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조).

반환값

list[InferenceCatalogModel]

카탈로그에서 사용할 수 있는 모델과 각각의 테스트된 레시피입니다.

Hugging Face Inference Catalog에서 사용할 수 있는 모델 목록을 표시합니다.

Inference Catalog의 목표는 추론에 최적화되고 기본 구성이 테스트된 모델의 큐레이션된 목록을 제공하는 것입니다. 카탈로그에서 사용할 수 있는 모델 목록은 https://huggingface.co/proxy/endpoints.huggingface.co/catalog에서 확인하세요.

create_inference_endpoint_from_catalog()를 사용하여 카탈로그에서 모델 또는 레시피를 배포합니다.

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> catalog = api.list_inference_catalog(task="text-generation", accelerator="neuron")
>>> [(model.repo_id, [recipe.id for recipe in model.recipes]) for model in catalog]
[('meta-llama/Llama-3.1-8B-Instruct', ['sizzling-biryani-g4xsi1ac', 'artisanal-quinoa-yz9ynamx']), ...]

list_inference_catalog는 실험적 기능입니다. 향후 API가 변경될 수 있습니다. 제안이나 요청 사항이 있으시면 피드백을 남겨 주세요.

list_inference_endpoints

< >

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

매개변수

  • namespace (str, 선택 사항) — 엔드포인트 목록을 가져올 namespace입니다. 기본값은 현재 사용자입니다. 모든 namespace(즉, 개인 namespace와 사용자가 속한 모든 조직)의 모든 엔드포인트를 나열하려면 "*"로 설정합니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

listInferenceEndpoint

주어진 namespace에 대한 모든 추론 엔드포인트 목록입니다.

지정된 namespace에 대한 모든 추론 엔드포인트를 나열합니다.

예:

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

list_inference_endpoints_hardware

< >

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

매개변수

  • namespace (str, 선택 사항) — 사용 가능한 하드웨어 및 가속기 할당량을 나열할 namespace입니다. 기본값은 현재 사용자입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조).

반환값

list[InferenceEndpointHardware]

모든 벤더와 지역에서 사용할 수 있는 하드웨어, 현재 사용 불가능하거나 비추천(deprecated)된 하드웨어를 포함합니다.

Inference Endpoint를 배포할 수 있는 사용 가능한 하드웨어를 나열합니다.

각 항목에는 create_inference_endpoint()에서 기대하는 정확한 vendor, region, accelerator, instance_type, instance_size 값과 함께 네임스페이스의 가격 및 가속기 할당량이 포함됩니다.

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> hardware = api.list_inference_endpoints_hardware()
>>> [hw.id for hw in hardware if hw.accelerator == "gpu" and hw.status == "available"]
['aws-us-east-1-nvidia-l4-x1', 'aws-us-east-1-nvidia-l4-x4', ...]

list_jobs

< >

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

매개변수

  • status (JobStage, str 또는 list, 선택 사항) — 주어진 상태, 예: "RUNNING" 또는 [JobStage.RUNNING, JobStage.SCHEDULING]을 가진 Job만 반환합니다. 가능한 값은 JobStage를 참조하세요.
  • labels (dict[str, str], 선택) — 주어진 key=value 레이블을 모두 가진 Jobs만 반환합니다. 예: {"env": "prod", "team": "ml"}.
  • timeout (float, 선택 사항) — Hub에 대한 요청에 타임아웃을 설정할지 여부.
  • namespace (str, 선택 사항) — 작업을 나열할 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

반환값

Iterable[JobInfo]

JobInfo 객체의 반복 가능한 객체

Hugging Face 인프라에서 compute Jobs를 나열합니다.

list_jobs_hardware

< >

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

반환값

list[JobHardwareInfo]

사용 가능한 하드웨어 구성 목록입니다.

Hugging Face 인프라에서 Jobs에 사용할 수 있는 하드웨어 옵션을 나열합니다.

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> hardware_list = api.list_jobs_hardware()
>>> hardware_list[0]
JobHardwareInfo(name='cpu-basic', pretty_name='CPU Basic', cpu='2 vCPU', ram='16 GB', ephemeral_storage='20 GB', accelerator=None, unit_cost_micro_usd=167, unit_cost_usd=0.000167, unit_label='minute')
>>> hardware_list[0].name
'cpu-basic'

# Filter GPU options
>>> gpu_hardware = [hw for hw in hardware_list if hw.accelerator is not None]
>>> gpu_hardware[0].accelerator.model
'T4'

list_lfs_files

< >

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

매개변수

  • repo_id (str) — LFS 파일 목록을 가져올 저장소입니다.
  • repo_type (str, 선택 사항) — 저장소 유형입니다. dataset 또는 space에서 목록을 가져오는 경우 "dataset" 또는 "space"로, model에서 목록을 가져오는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[LFSFileInfo]

LFSFileInfo 객체의 반복자입니다.

Hub의 저장소에서 모든 LFS 파일을 나열합니다.

이 기능은 주로 저장소가 사용하는 저장 용량을 확인하고, permanently_delete_lfs_files()를 사용하여 대용량 파일을 정리하는 데 유용합니다. 이 작업은 영구적이며, 삭제된 파일을 참조하는 모든 커밋에 영향을 미치고 되돌릴 수 없음을 유의하세요.

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> lfs_files = api.list_lfs_files("username/my-cool-repo")

# Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`.
# e.g. select only LFS files in the "checkpoints" folder
>>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/"))

# Permanently delete LFS files
>>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete)

list_liked_repos

< >

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

매개변수

  • user (str, 선택 사항) — 좋아요를 가져오려는 사용자의 이름입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

UserLikes

사용자 이름과 3개의 저장소 ID 목록(모델, 데이터셋, Spaces 각각 1개)을 포함하는 객체

다음 예외가 발생합니다

ValueError

  • ValueError — user가 전달되지 않고 토큰이 발견되지 않은 경우(인수 또는 머신에서 모두).

huggingface.co에서 사용자가 좋아요를 누른 모든 공개 저장소를 나열합니다.

이 목록은 공개되어 있으므로 토큰은 선택 사항입니다. user가 전달되지 않으면 로그인한 사용자가 기본값으로 사용됩니다.

unlike()도 참고하세요.

예:

>>> from huggingface_hub import list_liked_repos

>>> likes = list_liked_repos("julien-c")

>>> likes.user
"julien-c"

>>> likes.models
["osanseviero/streamlit_1.15", "Xhaheen/ChatGPT_HF", ...]

list_models

< >

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

매개변수

  • filter (str 또는 Iterable[str], 선택 사항) — Hub에서 모델을 필터링할 문자열 또는 문자열 목록입니다. 모델은 라이브러리, 언어, 작업, 태그 등으로 필터링할 수 있습니다.
  • author (str, 선택 사항) — 반환된 모델의 작성자(사용자 또는 조직)를 식별하는 문자열입니다.
  • apps (str 또는 List, 선택 사항) — Hub에서 지정된 앱을 지원하는 모델을 필터링하기 위한 문자열 또는 문자열 목록입니다. 예시 값으로는 "ollama" 또는 ["ollama", "vllm"]가 있습니다.
  • gated (bool, 선택 사항) — Hub에서 게이트가 설정된 모델과 그렇지 않은 모델을 필터링할 수 있는 불리언 값입니다. 기본적으로 모든 모델이 반환됩니다. gated=True가 전달되면 게이트가 설정된 모델만 반환됩니다. gated=False가 전달되면 게이트가 설정되지 않은 모델만 반환됩니다.
  • inference (Literal["warm"], 선택 사항) — “warm”인 경우, Hub에서 현재 최소 한 개의 프로바이더에 의해 서빙되는 모델만 필터링합니다.
  • inference_provider (Literal["all"] 또는 str, 선택 사항) — 특정 프로바이더가 제공하는 Hub의 모델을 필터링하는 문자열입니다. "all"을 전달하면 최소 하나의 프로바이더가 제공하는 모든 모델을 가져옵니다.
  • trained_dataset (str 또는 List, 선택 사항) — Hub의 모델에 대해 학습된 데이터셋의 문자열 태그 또는 문자열 태그 목록입니다.
  • search (str, 선택 사항) — 반환되는 모델 ID에 포함될 문자열입니다.
  • pipeline_tag (str, 선택 사항) — Hub에서 모델을 필터링할 문자열 파이프라인 태그입니다. 예를 들어 summarization과 같습니다.
  • num_parameters (str, 선택 사항) — 파라미터 수로 모델을 필터링합니다. Hub UI 및 API와 동일한 범위 구문을 지원하며, 예를 들어 "min:6B,max:128B", "min:6B" 또는 "max:128B"를 사용할 수 있습니다.
  • emissions_thresholds (Tuple, 선택 사항) — 그램 단위로 결과 모델을 필터링할 최소 및 최대 탄소 발자국을 나타내는 두 개의 int 또는 float로 구성된 튜플입니다.
  • sort (ModelSort_T, 선택 사항) — 결과 모델을 정렬할 키입니다. 가능한 값은 “created_at”, “downloads”, “last_modified”, “likes”, “trending_score”입니다.
  • limit (int, 선택 사항) — 가져올 모델 수의 제한입니다. 이 옵션을 None으로 두면 모든 모델을 가져옵니다.
  • expand (list[ExpandModelProperty_T], 선택 사항) — 응답에 반환할 속성 목록입니다. 이 매개변수를 사용하면 목록에 포함된 속성만 반환됩니다. full, cardData 또는 fetch_config가 전달된 경우 이 매개변수를 사용할 수 없습니다. 가능한 값은 "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", "resourceGroup"입니다.
  • full (bool, 선택 사항) — last_modified, sha, 파일 및 tags를 포함한 모든 모델 데이터를 가져올지 여부입니다. 필터를 사용할 경우 기본적으로 True로 설정됩니다.
  • cardData (bool, 선택) — 모델의 메타데이터도 가져올지 여부. 탄소 배출량, 지표, 학습에 사용된 데이터셋과 같은 유용한 정보를 포함할 수 있습니다.
  • fetch_config (bool, 선택) — 모델 구성 파일도 가져올지 여부입니다. 크기가 크기 때문에 full에는 포함되지 않습니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[ModelInfo]

huggingface_hub.hf_api.ModelInfo 객체의 반복 가능한 객체입니다.

일부 필터를 기준으로 Huggingface Hub에 호스팅된 모델을 나열합니다.

예:

>>> from huggingface_hub import HfApi

>>> api = HfApi()

# List all models
>>> api.list_models()

# List text classification models
>>> api.list_models(filter="text-classification")

# List models from the KerasHub library
>>> api.list_models(filter="keras-hub")

# List models served by Cohere
>>> api.list_models(inference_provider="cohere")

# List models with "bert" in their name
>>> api.list_models(search="bert")

# List models with "bert" in their name and pushed by google
>>> api.list_models(search="bert", author="google")

# List models with 6B to 128B parameters
>>> api.list_models(num_parameters="min:6B,max:128B", sort="likes")

list_organization_followers

< >

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

매개변수

  • organization (str) — 팔로워를 가져올 조직의 이름.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[User]

조직의 팔로워가 포함된 User 객체의 목록입니다.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — 조직이 Hub에 존재하지 않는 경우 HTTP 404.

Hub에서 조직의 팔로워를 나열합니다.

list_organization_members

< >

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

매개변수

  • organization (str) — 멤버를 가져올 조직의 이름.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[User]

조직의 구성원이 포함된 User 객체의 목록입니다.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — 조직이 Hub에 존재하지 않는 경우 HTTP 404.

Hub의 조직 구성원 목록

list_papers

< >

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

매개변수

  • query (str, 선택 사항) — 논문 검색을 위한 검색 쿼리 문자열입니다. 지정된 경우, 쿼리와 일치하는 논문을 반환합니다.
  • limit (int, 선택 사항) — 반환할 논문 최대 개수.
  • token (Union[bool, str, None], 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[PaperInfo]

huggingface_hub.hf_api.PaperInfo 객체의 반복 가능한 객체입니다.

검색 쿼리를 기반으로 Hugging Face Hub의 일일 논문을 나열합니다.

예:

>>> from huggingface_hub import HfApi

>>> api = HfApi()

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

list_pending_access_requests

< >

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

매개변수

  • repo_id (str) — 액세스 요청을 가져올 저장소의 id입니다.
  • repo_type (str, 선택 사항) — 액세스 요청을 가져올 리포지토리의 유형입니다. model, dataset, space 중 하나여야 합니다. 기본값은 model입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[AccessRequest]

AccessRequest 객체의 반복 가능한 객체입니다. 각 항목에는 username, request_id, email, status, timestamp 속성이 포함됩니다. 게이트된 저장소에 사용자 정의 양식이 있는 경우, fields 속성에 사용자의 답변이 채워집니다.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — 리포지토리가 게이트되지 않은 경우 HTTP 400.
  • HfHubHTTPError — 리포지토리에 읽기 전용 액세스 권한만 있는 경우 HTTP 403이 발생합니다. 리포지토리가 속해 있는 조직에서 write 또는 admin 역할을 가지고 있지 않거나, read 토큰을 전달한 경우 이러한 상황이 발생할 수 있습니다.

지정된 gated repo의 대기 중인 액세스 요청을 가져옵니다.

보류 중인 요청은 사용자가 저장소 접근을 요청했지만 아직 처리되지 않은 상태를 의미합니다. 승인 모드가 자동인 경우 이 목록은 비어 있어야 합니다. 보류 중인 요청은 accept_access_request()와 reject_access_request()를 사용하여 수락하거나 거부할 수 있습니다.

게이트된 리포지토리에 대한 자세한 내용은 https://huggingface.co/docs/hub/models-gated를 참고하세요.

예:

>>> from huggingface_hub import list_pending_access_requests, accept_access_request

# List pending requests
>>> requests = list(list_pending_access_requests("meta-llama/Llama-2-7b"))
>>> len(requests)
411
>>> requests[0]
[
    AccessRequest(
        username='clem',
        request_id='655f3a1c9e6b2d4f8a7c1e05',
        fullname='Clem 🤗',
        email='***',
        timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc),
        status='pending',
        fields=None,
    ),
    ...
]

# Accept Clem's request
>>> accept_access_request("meta-llama/Llama-2-7b", "clem")

list_rejected_access_requests

< >

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

매개변수

  • repo_id (str) — 액세스 요청을 가져올 저장소의 id입니다.
  • repo_type (str, 선택 사항) — 액세스 요청을 가져올 리포지토리의 유형입니다. model, dataset, space 중 하나여야 합니다. 기본값은 model입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[AccessRequest]

AccessRequest 객체의 반복 가능한 객체입니다. 각 항목에는 username, request_id, email, status, timestamp 속성이 포함됩니다. 게이트된 저장소에 사용자 정의 양식이 있는 경우, fields 속성에 사용자의 답변이 채워집니다.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — 리포지토리가 게이트되지 않은 경우 HTTP 400.
  • HfHubHTTPError — 리포지토리에 읽기 전용 액세스 권한만 있는 경우 HTTP 403이 발생합니다. 리포지토리가 속해 있는 조직에서 write 또는 admin 역할을 가지고 있지 않거나, read 토큰을 전달한 경우 이러한 상황이 발생할 수 있습니다.

gated 리포지토리에 대한 거부된 액세스 요청을 가져옵니다.

거절된 요청은 사용자가 저장소 접근을 요청했으나 저장소 소유자(본인 또는 조직의 다른 사용자)에 의해 명시적으로 거절된 경우를 의미합니다. 이 경우 사용자는 저장소의 어떤 파일도 다운로드할 수 없습니다. 거절된 요청은 accept_access_request()와 cancel_access_request()를 사용하여 언제든지 수락하거나 취소할 수 있습니다. 취소된 요청은 대기 목록으로 돌아가고, 수락된 요청은 수락 목록으로 이동합니다.

게이트된 리포지토리에 대한 자세한 내용은 https://huggingface.co/docs/hub/models-gated를 참고하세요.

예:

>>> from huggingface_hub import list_rejected_access_requests

>>> requests = list(list_rejected_access_requests("meta-llama/Llama-2-7b"))
>>> len(requests)
411
>>> requests[0]
[
    AccessRequest(
        username='clem',
        request_id='655f3a1c9e6b2d4f8a7c1e05',
        fullname='Clem 🤗',
        email='***',
        timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc),
        status='rejected',
        fields=None,
    ),
    ...
]

list_repo_commits

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • repo_type (str, 선택 사항) — 데이터셋 또는 Space의 커밋을 나열하려면 "dataset" 또는 "space"로, 모델에서 나열하려면 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • revision (str, 선택 사항) — 커밋할 git 리비전입니다. 기본값은 "main" 브랜치의 헤드입니다.
  • formatted (bool) — 커밋의 HTML 형식 제목과 설명을 반환할지 여부입니다. 기본값은 False입니다.

반환값

list[GitCommitInfo]

Hub의 저장소에 대한 커밋 정보를 포함하는 객체의 목록

다음 예외가 발생합니다

RepositoryNotFoundError 또는 RevisionNotFoundError

  • RepositoryNotFoundError — 리포지토리가 찾을 수 없는 경우(에러 404): repo_id/repo_type이(가) 잘못되었거나, 비공개이지만 인증되지 않았거나, 리포지토리가 존재하지 않는 경우.
  • RevisionNotFoundError — 리포지토리에서 revision을 찾을 수 없는 경우(에러 404).

Hub의 저장소에서 주어진 리비전의 커밋 목록을 가져옵니다.

커밋은 날짜순으로 정렬됩니다(마지막 커밋이 맨 위에 위치합니다).

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()

# Commits are sorted by date (last commit first)
>>> initial_commit = api.list_repo_commits("gpt2")[-1]

# Initial commit is always a system commit containing the `.gitattributes` file.
>>> initial_commit
GitCommitInfo(
    commit_id='9b865efde13a30c13e0a33e536cf3e4a5a9d71d8',
    authors=['system'],
    created_at=datetime.datetime(2019, 2, 18, 10, 36, 15, tzinfo=datetime.timezone.utc),
    title='initial commit',
    message='',
    formatted_title=None,
    formatted_message=None
)

# Create an empty branch by deriving from initial commit
>>> api.create_branch("gpt2", branch="new_empty_branch", revision=initial_commit.commit_id)

list_repo_files

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • revision (str, 선택 사항) — 정보를 가져올 저장소의 리비전입니다.
  • repo_type (str, 선택 사항) — dataset 또는 space에 업로드하는 경우 "dataset" 또는 "space"로 설정하고, model에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

list[str]

…

…

list_repo_likers

< >

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

매개변수

  • repo_id (str) — 가져올 저장소입니다. 예: "user/my-cool-model".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 업로드하는 경우 "dataset" 또는 "space"로, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.

반환값

Iterable[User]

huggingface_hub.hf_api.User 객체의 반복 가능한 객체입니다.

Hugging Face Hub에서 특정 저장소를 좋아한 모든 사용자를 나열합니다.

list_liked_repos()도 참고하세요.

list_repo_refs

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • repo_type (str, 선택 사항) — dataset, Space 또는 Kernel의 refs를 나열하는 경우 "dataset", "space" 또는 "kernel"로 설정하고, model에서 나열하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • include_pull_requests (bool, 선택 사항) — pull request의 refs를 목록에 포함할지 여부입니다. 기본값은 False입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

GitRefs

Hub의 저장소에 대한 브랜치와 태그에 관한 모든 정보를 포함하는 객체

…

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> api.list_repo_refs("gpt2")
GitRefs(branches=[GitRefInfo(name='main', ref='refs/heads/main', target_commit='e7da7f221d5bf496a48136c0cd264e630fe9fcc8')], converts=[], tags=[])

>>> api.list_repo_refs("bigcode/the-stack", repo_type='dataset')
GitRefs(
    branches=[
        GitRefInfo(name='main', ref='refs/heads/main', target_commit='18edc1591d9ce72aa82f56c4431b3c969b210ae3'),
        GitRefInfo(name='v1.1.a1', ref='refs/heads/v1.1.a1', target_commit='f9826b862d1567f3822d3d25649b0d6d22ace714')
    ],
    converts=[],
    tags=[
        GitRefInfo(name='v1.0', ref='refs/tags/v1.0', target_commit='c37a8cd1e382064d8aced5e05543c5f7753834da')
    ]
)

list_repo_tree

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • path_in_repo (str, 선택 사항) — 레포지토리에서 트리(폴더)의 상대 경로입니다. 예를 들어: "checkpoints/1fec34a/results". 기본값은 레포지토리의 루트 트리(폴더)입니다.
  • recursive (bool, 선택 사항, 기본값 False) — 트리 파일과 폴더를 재귀적으로 나열할지 여부.
  • expand (bool, 선택 사항, 기본값 False) — 트리 파일 및 폴더에 대한 추가 정보(예: 마지막 커밋 및 파일 보안 스캔 결과)를 가져올지 여부입니다. 이 작업은 서버에 더 많은 부하를 주기 때문에 페이지당 50개 결과만 반환됩니다(1000개가 아님). 페이지네이션은 huggingface_hub에서 구현되어 있으므로, 결과를 가져오는 데 걸리는 시간만 제외하면 사용자에게는 투명하게 처리됩니다.
  • revision (str, 선택 사항) — 트리를 가져올 저장소의 리비전입니다. 기본값은 "main" 브랜치입니다.
  • repo_type (str, 선택 사항) — 트리 가져올 저장소의 유형("model", "dataset", "space" 또는 "kernel"). 기본값은 "model"입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[Union[RepoFile, RepoFolder]]

트리 파일 및 폴더에 대한 정보. RepoFile 및 RepoFolder 객체의 반복 가능한 객체입니다. 파일과 폴더의 순서는 보장되지 않습니다.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 RevisionNotFoundError 또는 ~utils.RemoteEntryNotFoundError

  • RepositoryNotFoundError — 리포지토리가 찾을 수 없는 경우(에러 404): repo_id/repo_type이(가) 잘못되었거나, 비공개이지만 인증되지 않았거나, 리포지토리가 존재하지 않는 경우.
  • RevisionNotFoundError — 리포지토리에서 revision을 찾을 수 없는 경우(에러 404).
  • ~utils.RemoteEntryNotFoundError — 리포지토리에 트리(폴더)가 존재하지 않는 경우(404 오류).

리포지토리 트리의 파일과 폴더를 나열하고, 해당 파일과 폴더에 대한 정보를 가져옵니다.

예:

리포지토리의 트리 정보를 가져옵니다.

>>> from huggingface_hub import list_repo_tree
>>> repo_tree = list_repo_tree("lysandre/arxiv-nlp")
>>> repo_tree
<generator object HfApi.list_repo_tree at 0x7fa4088e1ac0>
>>> list(repo_tree)
[
    RepoFile(path='.gitattributes', size=391, blob_id='ae8c63daedbd4206d7d40126955d4e6ab1c80f8f', lfs=None, last_commit=None, security=None),
    RepoFile(path='README.md', size=391, blob_id='43bd404b159de6fba7c2f4d3264347668d43af25', lfs=None, last_commit=None, security=None),
    RepoFile(path='config.json', size=554, blob_id='2f9618c3a19b9a61add74f70bfb121335aeef666', lfs=None, last_commit=None, security=None),
    RepoFile(
        path='flax_model.msgpack', size=497764107, blob_id='8095a62ccb4d806da7666fcda07467e2d150218e',
        lfs={'size': 497764107, 'sha256': 'd88b0d6a6ff9c3f8151f9d3228f57092aaea997f09af009eefd7373a77b5abb9', 'pointer_size': 134}, last_commit=None, security=None
    ),
    RepoFile(path='merges.txt', size=456318, blob_id='226b0752cac7789c48f0cb3ec53eda48b7be36cc', lfs=None, last_commit=None, security=None),
    RepoFile(
        path='pytorch_model.bin', size=548123560, blob_id='64eaa9c526867e404b68f2c5d66fd78e27026523',
        lfs={'size': 548123560, 'sha256': '9be78edb5b928eba33aa88f431551348f7466ba9f5ef3daf1d552398722a5436', 'pointer_size': 134}, last_commit=None, security=None
    ),
    RepoFile(path='vocab.json', size=898669, blob_id='b00361fece0387ca34b4b8b8539ed830d644dbeb', lfs=None, last_commit=None, security=None)]
]

리포지토리의 트리(마지막 커밋 및 파일의 보안 스캔 결과)에 대한 더 많은 정보를 가져오기

>>> from huggingface_hub import list_repo_tree
>>> repo_tree = list_repo_tree("prompthero/openjourney-v4", expand=True)
>>> list(repo_tree)
[
    RepoFolder(
        path='feature_extractor',
        tree_id='aa536c4ea18073388b5b0bc791057a7296a00398',
        last_commit={
            'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190',
            'title': 'Upload diffusers weights (#48)',
            'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc)
        }
    ),
    RepoFolder(
        path='safety_checker',
        tree_id='65aef9d787e5557373fdf714d6c34d4fcdd70440',
        last_commit={
            'oid': '47b62b20b20e06b9de610e840282b7e6c3d51190',
            'title': 'Upload diffusers weights (#48)',
            'date': datetime.datetime(2023, 3, 21, 9, 5, 27, tzinfo=datetime.timezone.utc)
        }
    ),
    RepoFile(
        path='model_index.json',
        size=582,
        blob_id='d3d7c1e8c3e78eeb1640b8e2041ee256e24c9ee1',
        lfs=None,
        last_commit={
            'oid': 'b195ed2d503f3eb29637050a886d77bd81d35f0e',
            'title': 'Fix deprecation warning by changing `CLIPFeatureExtractor` to `CLIPImageProcessor`. (#54)',
            'date': datetime.datetime(2023, 5, 15, 21, 41, 59, tzinfo=datetime.timezone.utc)
        },
        security={
            'safe': True,
            'av_scan': {'virusFound': False, 'virusNames': None},
            'pickle_import_scan': None
        }
    )
    ...
]

list_scheduled_jobs

< >

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

매개변수

  • labels (dict[str, str], 선택) — 주어진 key=value 레이블을 모두 가진 예약된 Job만 반환합니다. 예: {"env": "prod", "team": "ml"}.
  • timeout (float, 선택 사항) — Hub에 대한 요청에 타임아웃을 설정할지 여부.
  • namespace (str, 선택 사항) — 작업을 나열할 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

반환값

list[ScheduledJobInfo]

ScheduledJobInfo 객체의 목록입니다.

Hugging Face 인프라에서 예약된 compute Jobs를 나열합니다.

list_space_templates

< >

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

매개변수

반환값

list[SpaceTemplate]

사용 가능한 Space 템플릿 목록.

Hub에서 사용할 수 있는 공식 Space 템플릿을 나열합니다.

반환된 템플릿의 repo_id(또는 짧은 name)를 HfApi.create_repo()의 space_template로 전달하여 해당 템플릿에서 새 Space를 생성할 수 있습니다.

예:

>>> from huggingface_hub import list_space_templates
>>> templates = list_space_templates()
>>> templates[0]
SpaceTemplate(name='Streamlit', repo_id='streamlit/streamlit-template-space', sdk='docker', preferred_private=False)

list_spaces

< >

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

매개변수

  • filter (str 또는 Iterable, 선택 사항) — Hub에서 Spaces를 식별하는 데 사용할 수 있는 문자열 태그 또는 태그 목록입니다.
  • author (str, 선택 사항) — 반환된 Spaces의 작성자를 식별하는 문자열입니다.
  • search (str, 선택 사항) — 반환되는 Spaces에 포함될 문자열입니다.
  • datasets (str 또는 Iterable, 선택 사항) — 데이터셋을 사용하는 Spaces를 반환할지 여부. 특정 데이터셋의 이름을 문자열로 전달할 수 있습니다.
  • models (str 또는 Iterable, 선택 사항) — 모델을 사용하는 Spaces를 반환할지 여부입니다. 특정 모델의 이름을 문자열로 전달할 수 있습니다.
  • linked (bool, 선택 사항) — 모델 또는 데이터셋을 사용하는 Spaces를 반환할지 여부입니다.
  • sort (SpaceSort_T, 선택 사항) — 결과 공간(space)을 정렬할 키입니다. 가능한 값은 “created_at”, “last_modified”, “likes”, “trending_score”입니다.
  • limit (int, 선택 사항) — 가져올 Spaces의 수에 대한 제한입니다. 이 옵션을 None으로 두면 모든 Spaces를 가져옵니다.
  • expand (list[ExpandSpaceProperty_T], 선택 사항) — 응답에 반환할 속성 목록입니다. 이 매개변수를 사용하면 목록에 포함된 속성만 반환됩니다. full이 전달된 경우 이 매개변수를 사용할 수 없습니다. 가능한 값은 "author", "cardData", "datasets", "disabled", "lastModified", "createdAt", "likes", "models", "private", "region", "runtime", "sdk", "siblings", "sha", "subdomain", "tags", "trendingScore", "usedStorage", "resourceGroup"입니다.
  • full (bool, 선택) — last_modified, siblings 및 card_data 필드를 포함한 모든 Spaces 데이터를 가져올지 여부입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[SpaceInfo]

huggingface_hub.hf_api.SpaceInfo 객체의 반복 가능한 객체입니다.

일부 필터를 기준으로 Huggingface Hub에 호스팅된 spaces 목록을 나열합니다.

list_spaces_hardware

< >

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

반환값

list[JobHardwareInfo]

사용 가능한 하드웨어 구성 목록입니다.

Spaces에서 사용할 수 있는 하드웨어 옵션을 나열합니다.

예:

>>> from huggingface_hub import list_spaces_hardware
>>> hardware_list = list_spaces_hardware()
>>> hardware_list[0]
JobHardwareInfo(name='cpu-basic', pretty_name='CPU Basic', cpu='2 vCPU', ram='16 GB', ...)
>>> hardware_list[0].name
'cpu-basic'

list_user_followers

< >

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

매개변수

  • username (str) — 팔로워를 가져올 사용자의 사용자 이름입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[User]

사용자의 팔로워를 포함하는 User 객체의 목록입니다.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — Hub에 해당 사용자가 없는 경우 HTTP 404.

Hub에서 사용자의 팔로워 목록을 가져옵니다.

list_user_following

< >

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

매개변수

  • username (str) — 팔로우 중인 사용자를 가져올 대상 사용자의 사용자 이름입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[User]

해당 사용자가 팔로우한 사용자의 User 객체 목록입니다.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — Hub에 해당 사용자가 없는 경우 HTTP 404.

Hub에서 특정 사용자가 팔로우하는 사용자 목록을 가져옵니다.

list_user_repos

< >

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

매개변수

  • namespace (str, 선택 사항) — 조직 이름입니다. 제공되지 않으면 인증된 사용자의 저장소 목록을 표시합니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 기본적으로 로컬에 저장된 토큰을 사용합니다.

반환값

Iterable[RepoStorageInfo]

RepoStorageInfo 객체의 반복 가능한 객체입니다.

저장소(모델, 데이터셋, 스페이스, 버킷)에 대한 저장소 정보를 포함하여 사용자 또는 조직의 모든 저장소를 나열합니다.

인증된 사용자의 경우 /api/settings/repositories 엔드포인트를, 조직의 경우 /api/organizations/{namespace}/settings/repositories 엔드포인트를 사용합니다.

예:

>>> from huggingface_hub import list_user_repos

>>> repos = list(list_user_repos())
>>> repos[0]
RepoStorageInfo(id='username/my-model', type='model', ...)

>>> # List repos from an organization
>>> repos = list(list_user_repos(namespace="my-org"))

list_webhooks

< >

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

매개변수

반환값

list[WebhookInfo]

Webhook 정보 객체의 목록입니다.

구성된 모든 웹훅을 나열합니다.

예:

>>> from huggingface_hub import list_webhooks
>>> webhooks = list_webhooks()
>>> len(webhooks)
2
>>> webhooks[0]
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    url="https://webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    secret="my-secret",
    domains=["repo", "discussion"],
    disabled=False,
)

merge_pull_request

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • discussion_num (int) — Discussion 또는 Pull Request의 번호입니다. 엄밀히 양의 정수여야 합니다.
  • comment (str, 선택 사항) — 상태 변경과 함께 게시할 선택적 댓글입니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 업로드하는 경우 "dataset" 또는 "space"로, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

DiscussionStatusChange

상태 변경 이벤트

Pull Request을 병합합니다.

다음 오류를 발생시킵니다:

  • HuggingFace API가 오류를 반환하면 HTTPError
  • ValueError 일부 매개변수 값이 잘못된 경우
  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.

모델 정보

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • revision (str, 선택 사항) — 정보를 가져올 모델 저장소의 리비전입니다.
  • timeout (float, 선택 사항) — Hub에 대한 요청에 타임아웃을 설정할지 여부.
  • securityStatus (bool, 선택) — 모델 리포지토리에서도 보안 상태를 가져올지 여부입니다. 보안 상태는 security_repo_status 필드에 반환됩니다.
  • files_metadata (bool, 선택 사항) — 리포지토리의 파일 메타데이터(크기, LFS 메타데이터 등)를 가져올지 여부입니다. 기본값은 False입니다.
  • expand (list[ExpandModelProperty_T], 선택 사항) — 응답에 반환할 속성 목록입니다. 이 매개변수를 사용하면 목록에 포함된 속성만 반환됩니다. securityStatus 또는 files_metadata가 전달된 경우 이 매개변수를 사용할 수 없습니다. 가능한 값은 "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", "resourceGroup"입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

huggingface_hub.hf_api.ModelInfo

모델 저장소 정보.

huggingface.co의 특정 모델에 대한 정보를 가져옵니다

토큰을 전달하거나 로그인한 상태라면 Model을 private로 설정할 수 있습니다.

다음 오류를 발생시킵니다:

  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.
  • RevisionNotFoundError 다운로드할 수 없는 리비전이 발견되지 않는 경우.

move_bucket

< >

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

매개변수

  • from_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 버킷 이름입니다. 원래 버킷 식별자(예: "username/my-bucket").
  • to_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 버킷 이름입니다. 최종 버킷 식별자(예: "username/new-bucket-name" 또는 "organization/my-bucket").
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

다음 예외가 발생합니다

BucketNotFoundError

  • BucketNotFoundError — 소스 버킷을 찾을 수 없는 경우입니다. 버킷이 존재하지 않거나, private으로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.

namespace1/repo_name1에서 namespace2/repo_name2로 버킷을 이동합니다

일定的한 제한 사항이 있습니다. 저장소 이동에 대한 자세한 내용은 https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo를 참고하세요.

예:

>>> from huggingface_hub import move_bucket

>>> # Rename a bucket within the same namespace
>>> move_bucket(from_id="username/old-name", to_id="username/new-name")

>>> # Transfer a bucket to an organization
>>> move_bucket(from_id="username/my-bucket", to_id="my-org/my-bucket")

move_repo

< >

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

매개변수

  • from_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름입니다. 원본 저장소 식별자입니다.
  • to_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름. 최종 저장소 식별자.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 업로드하는 경우 "dataset" 또는 "space"로, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

namespace1/repo_name1에서 namespace2/repo_name2로 저장소를 이동하는 방법

일定的한 제한 사항이 있습니다. 저장소 이동에 대한 자세한 내용은 https://hf.co/docs/hub/repositories-settings#renaming-or-transferring-a-repo를 참고하세요.

다음 오류를 발생시킵니다:

  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.

paper_info

< >

( id: str ) → PaperInfo

매개변수

  • id (str, 선택 사항) — 해당 논문의 ArXiv id입니다.

반환값

PaperInfo

PaperInfo 객체입니다.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — Hub에 해당 논문이 없는 경우 HTTP 404.

Hub에서 논문 정보를 가져옵니다.

parse_safetensors_file_metadata

< >

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

매개변수

  • repo_id (str) — /로 구분된 사용자 또는 조직 이름과 저장소 이름.
  • filename (str) — 리포지토리 내 파일 이름.
  • repo_type (str, 선택 사항) — 파일이 dataset 또는 space에 있는 경우 "dataset" 또는 "space"로 설정하고, model에 있는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • revision (str, 선택 사항) — 파일을 가져올 git revision입니다. 브랜치 이름, 태그 또는 커밋 해시를 사용할 수 있습니다. 기본값은 "main" 브랜치의 head입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • timeout (float, 선택 사항, 기본값 10) — 서버가 데이터를 보내기까지 대기할 초 수입니다. 타임아웃을 비활성화하려면 None으로 설정하세요(추천하지 않습니다. 연결이 중단되면 호출이 무한정 멈출 수 있습니다).

반환값

SafetensorsFileMetadata

safetensors 파일과 관련된 정보

다음 예외가 발생합니다

NotASafetensorsRepoError 또는 SafetensorsParsingError

  • NotASafetensorsRepoError — 리포지토리가 safetensors 리포지토리가 아닌 경우, 즉 model.safetensors 또는 model.safetensors.index.json 파일이 없는 경우.
  • SafetensorsParsingError — safetensors 파일 헤더를 올바르게 파싱하지 못한 경우.

Hub의 safetensors 파일에서 메타데이터를 파싱합니다.

리포지토리의 모든 safetensors 파일에서 메타데이터를 한 번에 파싱하려면 get_safetensors_metadata()를 사용하세요.

safetensors 형식에 대한 자세한 내용은 https://huggingface.co/docs/safetensors/index#format을 확인하세요.

pause_inference_endpoint

< >

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

매개변수

  • name (str) — 일시 정지할 Inference Endpoint의 이름입니다.
  • namespace (str, 선택 사항) — Inference Endpoint가 위치한 namespace입니다. 기본값은 현재 사용자입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

InferenceEndpoint

일시 중지된 Inference Endpoint에 대한 정보입니다.

Inference Endpoint를 일시 중지합니다.

일시 중지된 Inference Endpoint에는 요금이 부과되지 않습니다. resume_inference_endpoint()을(를) 사용하여 언제든지 다시 시작할 수 있습니다. 이는 scale_to_zero_inference_endpoint()을(를) 사용하여 Inference Endpoint를 0으로 스케일링하는 것과 다릅니다. 후자의 경우 요청이 들어오면 자동으로 다시 시작됩니다.

편의상 pause_inference_endpoint()를 사용하여 Inference Endpoint를 일시 중지할 수도 있습니다.

pause_space

< >

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

매개변수

  • repo_id (str) — 일시 정지할 Space의 ID. 예: "Salesforce/BLIP2".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

SpaceRuntime

stage=PAUSED 및 요청된 하드웨어를 포함하여 Space에 대한 런타임 정보

다음 예외가 발생합니다

RepositoryNotFoundError 또는 HfHubHTTPError 또는 BadRequestError

  • RepositoryNotFoundError — Space가 찾을 수 없는 경우(에러 404). 가장 가능성 높은 원인은 잘못된 repo_id이거나, Space가 비공개인데 인증되지 않은 상태입니다.
  • HfHubHTTPError — 403 Forbidden: Space의 소유자만 Space를 일시 중지할 수 있습니다. 소유하지 않은 Space를 관리하려면 Discussion을 열어 소유자에게 요청하거나 Space를 복제하세요.
  • BadRequestError — Space가 정적 Space인 경우입니다. 정적 Space는 항상 실행되며 과금되지 않습니다. 정적 Space를 숨기려면 비공개로 설정할 수 있습니다.

Space를 일시 중지합니다.

일시 정지된 Space는 소유자가 수동으로 다시 시작할 때까지 실행이 중단됩니다. 이는 48시간 동안 비활성 상태인 무료 Space가 진입하는 수면 상태와 다릅니다. 선택한 하드웨어와 관계없이 일시 정지된 시간은 계정에 청구되지 않습니다. Space를 다시 시작하려면 restart_space()를 사용하고 Space 설정 페이지로 이동하세요.

자세한 내용은 문서를 참고하세요.

permanently_delete_lfs_files

< >

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

매개변수

  • repo_id (str) — LFS 파일 목록을 가져올 저장소입니다.
  • lfs_files (Iterable[LFSFileInfo]) — 리포지토리에서 영구적으로 삭제할 LFSFileInfo 항목의 반복 가능한 객체. 리포지토리의 모든 LFS 파일을 나열하려면 list_lfs_files()를 사용하세요.
  • rewrite_history (bool, 선택 사항, 기본값 True) — 삭제된 LFS 파일을 참조하는 파일 포인터를 제거하기 위해 저장소 히스토리를 다시 작성할지 여부(권장).
  • repo_type (str, 선택 사항) — 저장소 유형입니다. dataset 또는 space에서 목록을 가져오는 경우 "dataset" 또는 "space"로, model에서 목록을 가져오는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Hub의 저장소에서 LFS 파일을 영구적으로 삭제합니다.

삭제된 파일에 대한 참조가 있는 모든 커밋에 영향을 미치는 영구적인 작업이며 저장소가 손상될 수 있습니다. 되돌릴 수 없는 작업입니다. 자신이 하는 일을 정확히 알고 있을 때만 사용하세요.

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> lfs_files = api.list_lfs_files("username/my-cool-repo")

# Filter files to delete based on a combination of `filename`, `pushed_at`, `ref` or `size`.
# e.g. select only LFS files in the "checkpoints" folder
>>> lfs_files_to_delete = (lfs_file for lfs_file in lfs_files if lfs_file.filename.startswith("checkpoints/"))

# Permanently delete LFS files
>>> api.permanently_delete_lfs_files("username/my-cool-repo", lfs_files_to_delete)

preupload_lfs_files

< >

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

매개변수

  • repo_id (str) — 파일을 커밋할 저장소입니다. 예: "username/custom_transformers".
  • additions (Iterable of CommitOperationAdd) — 업로드할 파일 목록입니다. 경고: 이 목록의 객체들은 업로드에 관한 정보를 포함하도록 변경됩니다. 여러 커밋에 동일한 객체를 재사용하지 마세요.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • repo_type (str, 선택 사항) — 업로드할 저장소의 유형(예: "model" -기본값-, "dataset", "space" 또는 "kernel").
  • revision (str, 선택 사항) — 커밋할 git 리비전입니다. 기본값은 "main" 브랜치의 헤드입니다.
  • create_pr (boolean, 선택 사항) — 해당 커밋으로 Pull Request를 생성할 계획이 있는지 여부입니다. 기본값은 False입니다.
  • num_threads (int, 선택 사항) — 파일을 업로드할 때 사용할 동시 스레드 수입니다. 기본값은 5입니다. 2로 설정하면 최대 2개의 파일이 동시에 업로드됩니다.
  • free_memory (bool, 선택 사항, 기본값 True) — True인 경우, 업로드 후 메모리를 절약하기 위해 각 CommitOperationAdd의 path_or_fileobj 속성이 빈 bytes 객체로 대체됩니다. 후속 create_commit() 호출 외부에서 작업 객체를 재사용해야 하는 경우 False로 설정하세요.
  • gitignore_content (str, 선택 사항) — 무시해야 할 파일을 파악하기 위한 .gitignore 파일의 내용입니다. 우선순위는 먼저 gitignore_content가 전달되었는지 확인하고, 다음으로 커밋할 파일 목록에 .gitignore 파일이 있는지 확인하며, 마지막으로 Hub에 이미 호스팅된 .gitignore 파일(있는 경우)을 기본값으로 사용하는 것입니다.

향후 커밋을 준비하기 위해 업로드 전 LFS 파일을 S3에 미리 업로드합니다.

…

이것은 고급 사용자용 메서드입니다. 일반적인 커밋을 생성하려면 직접 호출할 필요가 없습니다. 대신 create_commit()를 직접 사용하세요.

Commit 작업은 처리 과정에서 변경됩니다. 특히, 첨부된 path_or_fileobj는 메모리를 절약하기 위해 업로드 후 제거됩니다(빈 bytes 객체로 대체됨). create_commit()에 전달하는 경우를 제외하고는 동일한 객체를 재사용하지 마세요. commit 작업 객체에서 첨부된 콘텐츠를 제거하지 않으려면 free_memory=False를 전달하세요.

예:

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

< >

( id: str ) → str

매개변수

  • id (str) — 해당 논문의 ArXiv id입니다.

반환값

str

Markdown 형식의 논문 페이지 콘텐츠.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — Hub에 해당 논문이 없는 경우 HTTP 404.

Hub의 논문 페이지에서 마크다운 콘텐츠를 가져옵니다.

reject_access_request

< >

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

매개변수

  • repo_id (str) — 액세스 요청을 거부할 저장소의 id입니다.
  • user (str, 선택 사항) — 액세스 요청을 거부할 사용자의 사용자 이름입니다. user 또는 request_id 중 정확히 하나만 제공해야 합니다.
  • request_id (str, 선택 사항) — 거절할 액세스 요청의 ID입니다(AccessRequest 참조). 저장소가 요청자의 사용자 이름을 공유하도록 설정되지 않은 경우 필수입니다. user 또는 request_id 중 정확히 하나만 제공해야 합니다.
  • repo_type (str, 선택 사항) — 액세스 요청을 거부할 저장소의 유형입니다. model, dataset, space 중 하나여야 합니다. 기본값은 model입니다.
  • rejection_reason (str, 선택 사항) — 사용자에게 표시되는 선택적 거부 사유(최대 200자).
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — 리포지토리가 게이트되지 않은 경우 HTTP 400.
  • HfHubHTTPError — 리포지토리에 읽기 전용 액세스 권한만 있는 경우 HTTP 403이 발생합니다. 리포지토리가 속해 있는 조직에서 write 또는 admin 역할을 가지고 있지 않거나, read 토큰을 전달한 경우 이러한 상황이 발생할 수 있습니다.
  • HfHubHTTPError — Hub에 해당 사용자가 존재하지 않으면 HTTP 404를 반환합니다.
  • HfHubHTTPError — 사용자 액세스 요청을 찾을 수 없는 경우 HTTP 404.
  • HfHubHTTPError — 사용자 액세스 요청이 이미 거부 목록에 있는 경우 HTTP 404.

gated 리포지토리에 대한 특정 사용자의 액세스 요청을 거부합니다.

거절된 요청은 거절 목록으로 이동합니다. 사용자는 저장소의 파일을 다운로드할 수 없습니다. 거절된 요청은 accept_access_request() 및 cancel_access_request()를 사용하여 언제든지 수락하거나 취소할 수 있습니다. 취소된 요청은 대기 목록으로 되돌아 가고, 수락된 요청은 수락 목록으로 이동합니다.

게이트된 리포지토리에 대한 자세한 내용은 https://huggingface.co/docs/hub/models-gated를 참고하세요.

rename_discussion

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • discussion_num (int) — Discussion 또는 Pull Request의 번호입니다. 엄밀히 양의 정수여야 합니다.
  • new_title (str) — 토론의 새 제목
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에 업로드하는 경우 "dataset" 또는 "space"로, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

DiscussionTitleChange

제목 변경 이벤트

Discussion 이름을 변경합니다.

예:

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

다음 오류를 발생시킵니다:

  • HuggingFace API가 오류를 반환하면 HTTPError
  • ValueError 일부 매개변수 값이 잘못된 경우
  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.

repo_exists

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에서 저장소 정보를 가져오는 경우 "dataset" 또는 "space"로 설정하고, 모델에서 저장소 정보를 가져오는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Hugging Face Hub에 저장소가 존재하는지 확인합니다.

예:

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

repo_info

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • revision (str, 선택 사항) — 정보를 가져올 저장소의 리비전입니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에서 저장소 정보를 가져오는 경우 "dataset" 또는 "space"로 설정하고, 모델에서 저장소 정보를 가져오는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • timeout (float, 선택 사항) — Hub에 대한 요청에 타임아웃을 설정할지 여부.
  • expand (ExpandModelProperty_T 또는 ExpandDatasetProperty_T 또는 ExpandSpaceProperty_T, 선택 사항) — 응답에 반환할 속성의 목록입니다. 이 매개변수를 사용하면 목록에 포함된 속성만 반환됩니다. files_metadata가 전달된 경우 이 매개변수를 사용할 수 없습니다. 사용 가능한 속성의 전체 목록은 model_info(), dataset_info() 또는 space_info()를 확인하세요.
  • files_metadata (bool, 선택 사항) — 리포지토리의 파일 메타데이터(크기, LFS 메타데이터 등)를 가져올지 여부입니다. 기본값은 False입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Union[SpaceInfo, DatasetInfo, ModelInfo]

huggingface_hub.hf_api.DatasetInfo, huggingface_hub.hf_api.ModelInfo 또는 huggingface_hub.hf_api.SpaceInfo 객체로 표현된 저장소 정보.

type가 지정된 저장소의 info 객체를 가져옵니다.

다음 오류를 발생시킵니다:

  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.
  • RevisionNotFoundError 다운로드할 수 없는 리비전이 발견되지 않는 경우.

request_space_hardware

< >

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

매개변수

  • repo_id (str) — 업데이트할 저장소의 ID입니다. 예: "bigcode/in-the-stack".
  • hardware (str 또는 SpaceHardware) — Space를 실행할 하드웨어. 예: "t4-medium".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • sleep_time (int, 선택 사항) — Space가 수면 상태로 전환되기 전까지 대기할 비활성 시간(초). Space가 수면 상태로 전환되지 않기를 원하면 -1로 설정하세요(업그레이드된 하드웨어의 기본 동작). 무료 하드웨어의 경우 수면 시간을 설정할 수 없으며(값이 48시간 비활성으로 고정됨), 자세한 내용은 https://huggingface.co/docs/hub/spaces-gpus#sleep-time을 참조하세요.

반환값

SpaceRuntime

Space의 스테이지와 하드웨어를 포함한 런타임 정보

Space에 새 하드웨어를 요청합니다.

Space 저장소를 생성할 때 하드웨어를 직접 요청하는 것도 가능합니다! 자세한 내용은 create_repo()를 참고하세요.

rerun_job

< >

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

매개변수

  • job_id (str) — 다시 실행할 Job의 ID.
  • namespace (str, 선택 사항) — Job의 Namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 사용자 액세스 토큰입니다. 기본적으로 로컬에 저장된 토큰을 사용합니다.

반환값

JobInfo

새로 시작된 Job.

Job의 기존 스펙, 재시도 및 리소스 설정을 포함하여 새 Job을 실행합니다.

resolve_revision

< >

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

매개변수

  • repo_id (str) — /로 구분된 사용자 또는 조직 이름과 저장소 이름.
  • repo_type (str, 선택 사항) — 리포지토리가 데이터셋, 스페이스 또는 커널 리포지토리인 경우 "dataset", "space" 또는 "kernel"로 설정하고, 모델인 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • revision (str, 선택 사항) — 해결할 revision입니다. branch 이름, tag, PR ref 또는 commit hash일 수 있습니다. 기본값은 default branch입니다. ResolvedRevision이 전달되면 그대로 반환됩니다. 단, 다른 repo에 대해 해결된 경우 처음 요청한 revision이 다시 해결됩니다.
  • cache_dir (str, Path, 선택 사항) — 캐시된 파일이 저장되는 폴더의 경로입니다. 기본값은 HF_HUB_CACHE의 값입니다.
  • local_files_only (bool, 선택 사항, 기본값 False) — True인 경우, Hub에 연결하지 않고 로컬 캐시에서만 리비전을 해석합니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다(자세한 내용은 https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

ResolvedRevision

요청된 revision과 해당 commit hash를 모두 포함하는 str 하위 클래스입니다.

다음 예외가 발생합니다

RevisionResolutionError 또는 RevisionNotFoundError 또는 RepositoryNotFoundError

  • RevisionResolutionError — 리비전을 해석할 수 없는 경우: Hub에 연결할 수 없고 로컬에 캐시된 항목이 없는 경우.
  • RevisionNotFoundError — Hub에 해당 revision이 없는 경우.
  • RepositoryNotFoundError — 리포지토리를 찾을 수 없는 경우. 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.

revision(브랜치, 태그, PR ref)을 커밋 해시로 해석합니다.

여러 개의 리포지토리 구성 요소(config, weights, tokenizer, …)를 별도로 다운로드하고 로드하는 라이브러리를 위한 기능입니다. revision을 한 번만 해석하고 반환된 ResolvedRevision을 전달하면, 그 사이 리포지토리가 업데이트되더라도 모든 후속 호출이 정확히 동일한 commit을 대상으로 하도록 보장됩니다. 또한 commit hash를 사용한 다운로드는 Hub에 연결하지 않고 로컬 캐시로 제공될 수 있으므로 HTTP 호출 횟수도 줄일 수 있습니다.

revision -> commit hash 매핑은 디스크에 캐시됩니다(캐시의 refs/ 폴더에). 이 캐싱은 최선을 다해(best-effort) 수행됩니다. 나중에 Hub에 연결할 수 없는 경우(오프라인 모드, 연결 오류, 타임아웃, Hub 장애 등)에는 캐시된 값이 폴백으로 사용됩니다.

전체 저장소 스냅샷만 다운로드해야 한다면 snapshot_download() 호출 하나면 충분하며 이미 올바른 동작을 수행합니다. resolve_revision은 파일을 개별적으로 다운로드할 때만 유용합니다.

예:

>>> from huggingface_hub import hf_hub_download, resolve_revision
>>> revision = resolve_revision("openai-community/gpt2")
>>> revision
ResolvedRevision(initial=None, resolved='607a30d783dfa663caf39e06633721c8d4cfcd7e')

# Pass it around: every download is pinned to the same commit
>>> config = hf_hub_download("openai-community/gpt2", "config.json", revision=revision)
>>> weights = hf_hub_download("openai-community/gpt2", "model.safetensors", revision=revision)

restart_space

< >

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

매개변수

  • repo_id (str) — 재시작할 Space의 ID. 예: "Salesforce/BLIP2".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • factory_reboot (bool, 선택 사항) — True인 경우, Space는 어떤 요구 사항도 캐시하지 않고 처음부터 다시 구축됩니다.

반환값

SpaceRuntime

Space에 대한 런타임 정보.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 HfHubHTTPError 또는 BadRequestError

  • RepositoryNotFoundError — Space가 찾을 수 없는 경우(에러 404). 가장 가능성 높은 원인은 잘못된 repo_id이거나, Space가 비공개인데 인증되지 않은 상태입니다.
  • HfHubHTTPError — 403 Forbidden: Space의 소유자만 Space를 재시작할 수 있습니다. 소유자가 아닌 Space를 재시작하려면 Discussion을 열어 소유자에게 요청하거나 Space를 복제하세요.
  • BadRequestError — Space가 정적 Space인 경우입니다. 정적 Space는 항상 실행되며 과금되지 않습니다. 정적 Space를 숨기려면 비공개로 설정할 수 있습니다.

Space를 다시 시작하세요.

Space를 일시중지(Pause)한 경우( pause_space() 참조) 프로그래밍 방식으로 Space를 다시 시작하는 유일한 방법입니다. Space를 다시 시작하려면 해당 Space의 소유자여야 합니다. 업그레이드된 하드웨어를 사용하는 경우, Space가 다시 시작되는 즉시 계정에 요금이 청구됩니다. Space의 현재 상태와 관계없이 언제든 재시작을 트리거할 수 있습니다.

자세한 내용은 문서를 참고하세요.

resume_inference_endpoint

< >

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

매개변수

  • name (str) — 재개할 Inference Endpoint의 이름입니다.
  • namespace (str, 선택 사항) — Inference Endpoint가 위치한 namespace입니다. 기본값은 현재 사용자입니다.
  • running_ok (bool, 선택 사항) — True인 경우, Inference Endpoint가 이미 실행 중이어도 오류를 발생시키지 않습니다. 기본값은 True입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

InferenceEndpoint

재개된 Inference Endpoint에 대한 정보.

Inference Endpoint를 재개합니다.

편의상 InferenceEndpoint.resume()를 사용하여 Inference Endpoint를 재개할 수도 있습니다.

resume_scheduled_job

< >

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

매개변수

  • scheduled_job_id (str) — 예약된 Job의 ID입니다.
  • namespace (str, 선택 사항) — 예약된 Job이 있는 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face 인프라에서 예약된 compute Job을 재개(일시중지 해제)합니다.

revision_exists

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • revision (str) — 확인할 저장소의 리비전입니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스에서 저장소 정보를 가져오는 경우 "dataset" 또는 "space"로 설정하고, 모델에서 저장소 정보를 가져오는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Hugging Face Hub의 저장소에서 특정 리비전이 존재하는지 확인합니다.

예:

>>> from huggingface_hub import revision_exists
>>> revision_exists("google/gemma-7b", "float16")
True
>>> revision_exists("google/gemma-7b", "not-a-revision")
False

run_as_future

< >

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

매개변수

  • fn (Callable) — 백그라운드에서 실행할 메서드입니다.
  • *args, **kwargs — 해당 메서드가 호출될 때 사용되는 인자입니다.

반환값

Future

작업의 결과를 가져오기 위한 Future 인스턴스

Future 인스턴스를 반환하면서 백그라운드에서 메서드를 실행합니다.

주된 목표는 메인 스레드를 차단하지 않고 메서드를 실행하는 것입니다(예: 학습 중에 데이터를 푸시하는 경우). 백그라운드 작업은 순서를 유지하기 위해 큐에 쌓이지만 병렬로 실행되지 않습니다. API에 대한 많은 호출을 병렬화하여 스크립트를 빠르게 실행해야 하는 경우, 자체 ThreadPoolExecutor를 설정하고 사용해야 합니다.

참고: upload_file(), upload_folder(), create_commit()와 같이 가장 많이 사용되는 메서드에는 백그라운드에서 직접 호출할 수 있도록 run_as_future: bool 인수가 있습니다. 이는 api.run_as_future(...)를 호출하는 것과 동일하지만, 코드가 더 간결합니다.

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> future = api.run_as_future(api.whoami) # instant
>>> future.done()
False
>>> future.result() # wait until complete and return result
(...)
>>> future.done()
True

run_job

< >

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

매개변수

  • image (str) — 사용할 Docker 이미지입니다. 예: "ubuntu", "python:3.12", "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel". Space의 이미지를 사용하는 예: "hf.co/spaces/lhoestq/duckdb".
  • command (list[str]) — 실행할 명령입니다. 예: ["echo", "hello"].
  • env (dict[str, Any], 선택) — Job의 환경 변수를 정의합니다.
  • secrets (dict[str, Any], 선택) — Job의 비밀 환경 변수를 정의합니다.
  • flavor (str, 선택 사항) — 하드웨어의 Flavor입니다. 가능한 값은 JobHardware를 참조하세요. 기본값은 "cpu-basic"입니다.
  • timeout (Union[int, float, str], 선택 사항) — Job의 최대 지속 시간: s(초, 기본값), m(분), h(시간) 또는 d(일)를 접미사로 사용하는 int. 예: 5분은 300 또는 "5m".
  • attempts (int, 선택 사항) — 초기 실행을 포함하여 시도할 최대 횟수입니다. 기본값은 1입니다. 예를 들어, 3은 실패한 Job을 최대 2회 재시도합니다.
  • name (str, 선택 사항) — Job에 부여할 이름입니다. name 레이블로 저장됩니다. labels에 name 키와 함께 전달할 수 없습니다. 이름은 고유할 필요가 없습니다. 기본값은 이미지와 명령에서 파생된 이름(짧은 해시 접미사 포함)입니다.
  • labels (dict[str, str], 선택) — 작업에 연결할 라벨(키-값 쌍).
  • volumes (list[Volume], 선택 사항) — 잡 컨테이너에 볼륨으로 마운트할 Hugging Face Buckets 또는 Repos입니다. 각 볼륨은 Volume이며 type ("bucket", "model", "dataset" 또는 "space"), source (예: "username/my-bucket"), mount_path (예: "/data")를 가집니다.
  • expose (list[int], 선택 사항) — jobs 프록시를 통해 노출할 컨테이너 포트입니다. 나열된 각 포트는 공개 jobs 도메인(예: https://<job_id>--8000.hf.jobs)에서 접근할 수 있습니다. 접근에는 항상 해당 job의 namespace에 대한 읽기 권한이 있는 HF 토큰이 필요합니다. 인증되지 않은 접근을 사용하려면 expose_public을 사용하세요.
  • expose_public (list[int], 선택) — 인증 없이 Jobs 프록시를 통해 노출할 포트입니다. expose에 나열할 필요가 없습니다.
  • ssh (bool, 선택) — True인 경우, 해당 작업의 컨테이너는 job.status.ssh_url로 지정된 URL을 통해 SSH로 접근할 수 있습니다 (예: ssh <job_id>@ssh.hf.jobs 또는 CLI에서 hf jobs ssh <job_id>). 연결하려면 작업의 namespace에 대한 쓰기 권한과 Hub에 등록된 SSH 공개 키가 필요합니다 (https://huggingface.co/settings/keys). 기본값은 False입니다.
  • network_group (str, 선택 사항) — 가속할 네트워크 그룹의 이름입니다. 동일한 namespace와 resource group을 공유하는 그룹에 속한 Job들은 함께 배치되며 모든 포트에서 서로 통신할 수 있습니다. 각 멤버 내부에서 HF_NETWORK_GROUP_HOSTNAME은 그룹의 모든 멤버로 해석됩니다. 소문자 영숫자와 대시만 사용할 수 있으며 최대 46자입니다.
  • network_aliases (list[str], 선택) — 이 작업이 네트워크 그룹에서 주장하는 별칭입니다. 멤버는 해당 별칭을 주장하는 작업에 ${HF_NETWORK_GROUP_PREFIX}<alias>를 통해 접근할 수 있습니다. 여러 작업이 동일한 별칭을 주장할 수 있습니다. 소문자 영숫자 와 대시만 사용할 수 있으며, 최대 34자, 작업 내에서 고유해야 합니다. network_group이 필요합니다.
  • resource_group_id (str, 선택 사항) — Job을 생성할 리소스 그룹의 ID입니다. 조직 내 리소스에 대한 액세스 제어 및 비용 귀속/지출 한도 기능을 위해 사용됩니다. 제공되지 않으면 Job은 어떤 리소스 그룹에도 속하지 않은 상태로 생성됩니다.
  • namespace (str, 선택 사항) — Job이 생성될 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face 인프라에서 compute Jobs를 실행합니다.

예:

첫 번째 Job 실행:

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

GPU 작업 실행:

>>> from huggingface_hub import run_job
>>> image = "pytorch/pytorch:2.6.0-cuda12.4-cudnn9-devel"
>>> command = ["python", "-c", "import torch; print(f'This code ran with the following GPU: {torch.cuda.get_device_name()}')"]
>>> run_job(image=image, command=command, flavor="a10g-small")

볼륨를 사용하여 Job 실행:

>>> from huggingface_hub import Volume, run_job
>>> dataset_volume = Volume(type="dataset", source="HuggingFaceFW/fineweb", mount_path="/data")
>>> output_bucket_volume = Volume(type="bucket", source="username/my-bucket", mount_path="/output")
>>> image = "duckdb/duckdb"
>>> command = ["duckdb", "-c", "COPY (SELECT * FROM '/data/**/*.parquet' LIMIT 5) TO '/output/first-rows.parquet'"]
>>> run_job(image=image, command=command, volumes=[dataset_volume, output_bucket_volume])

run_uv_job

< >

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

매개변수

  • script (str) — UV 스크립트의 경로 또는 URL, 또는 명령어.
  • script_args (list[str], 선택 사항) — 스크립트나 명령에 전달할 인자.
  • dependencies (list[str], 선택 사항) — UV 스크립트를 실행하는 데 사용할 종속성입니다.
  • python (str, 선택 사항) — 특정 Python 버전을 사용합니다. 기본값은 3.12입니다.
  • image (str, 선택 사항, 기본값 “ghcr.io/astral-sh/uv —python3.12-bookworm”): uv가 설치된 사용자 지정 Docker 이미지를 사용합니다.
  • env (dict[str, Any], 선택) — Job의 환경 변수를 정의합니다.
  • secrets (dict[str, Any], 선택) — Job의 비밀 환경 변수를 정의합니다.
  • flavor (str, 선택 사항) — 하드웨어의 Flavor입니다. 가능한 값은 JobHardware를 참조하세요. 기본값은 "cpu-basic"입니다.
  • timeout (Union[int, float, str], 선택 사항) — Job의 최대 지속 시간: s(초, 기본값), m(분), h(시간) 또는 d(일)를 접미사로 사용하는 int. 예: 5분은 300 또는 "5m".
  • attempts (int, 선택 사항) — 최대 시도 횟수입니다. 초기 실행을 포함합니다. 기본값은 1입니다.
  • name (str, 선택 사항) — Job에 부여할 이름입니다. name 레이블로 저장됩니다. labels에 name 키와 함께 전달할 수 없습니다. 이름은 고유할 필요가 없습니다. 기본값은 스크립트와 그 인자에서 파생된 이름(짧은 해시 접미사 포함)입니다.
  • labels (dict[str, str], 선택) — 작업에 연결할 라벨(키-값 쌍).
  • volumes (list[Volume], 선택 사항) — 잡 컨테이너에 볼륨으로 마운트할 Hugging Face Buckets 또는 Repos입니다. 각 볼륨은 Volume이며 type ("bucket", "model", "dataset" 또는 "space"), source (예: "username/my-bucket"), mount_path (예: "/data")를 가집니다.
  • expose (list[int], 선택 사항) — jobs 프록시를 통해 노출할 컨테이너 포트입니다. 나열된 각 포트는 공개 jobs 도메인(예: https://<job_id>--8000.hf.jobs)에서 접근할 수 있습니다. 접근에는 항상 해당 job의 namespace에 대한 읽기 권한이 있는 HF 토큰이 필요합니다. 인증되지 않은 접근을 사용하려면 expose_public을 사용하세요.
  • expose_public (list[int], 선택) — 인증 없이 Jobs 프록시를 통해 노출할 포트입니다. expose에 나열할 필요가 없습니다.
  • ssh (bool, 선택) — True인 경우, 해당 작업의 컨테이너는 job.status.ssh_url로 지정된 URL을 통해 SSH로 접근할 수 있습니다 (예: ssh <job_id>@ssh.hf.jobs 또는 CLI에서 hf jobs ssh <job_id>). 연결하려면 작업의 namespace에 대한 쓰기 권한과 Hub에 등록된 SSH 공개 키가 필요합니다 (https://huggingface.co/settings/keys). 기본값은 False입니다.
  • network_group (str, 선택 사항) — 가속할 네트워크 그룹의 이름입니다. 동일한 namespace와 resource group을 공유하는 그룹에 속한 Job들은 함께 배치되며 모든 포트에서 서로 통신할 수 있습니다. 각 멤버 내부에서 HF_NETWORK_GROUP_HOSTNAME은 그룹의 모든 멤버로 해석됩니다. 소문자 영숫자와 대시만 사용할 수 있으며 최대 46자입니다.
  • network_aliases (list[str], 선택) — 이 작업이 네트워크 그룹에서 주장하는 별칭입니다. 멤버는 해당 별칭을 주장하는 작업에 ${HF_NETWORK_GROUP_PREFIX}<alias>를 통해 접근할 수 있습니다. 여러 작업이 동일한 별칭을 주장할 수 있습니다. 소문자 영숫자 와 대시만 사용할 수 있으며, 최대 34자, 작업 내에서 고유해야 합니다. network_group이 필요합니다.
  • resource_group_id (str, 선택 사항) — Job을 생성할 리소스 그룹의 ID입니다. 조직 내 리소스에 대한 액세스 제어 및 비용 귀속/지출 한도 기능을 위해 사용됩니다. 제공되지 않으면 Job은 어떤 리소스 그룹에도 속하지 않은 상태로 생성됩니다.
  • namespace (str, 선택 사항) — Job이 생성될 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face 인프라에서 UV 스크립트 Job을 실행합니다.

hf jobs uv run와 달리, 이 메서드는 UV 스크립트가 PEP 723 헤더에 포함할 수 있는 선택적 [tool.hf-jobs] 테이블(Jobs 가이드 참고)을 무시합니다. 따라서 여기서 런치 구성은 명시적으로 전달해야 합니다.

예:

URL에서 스크립트 실행:

>>> from huggingface_hub import run_uv_job
>>> script = "https://raw.githubusercontent.com/huggingface/trl/refs/heads/main/trl/scripts/sft.py"
>>> script_args = ["--model_name_or_path", "Qwen/Qwen2-0.5B", "--dataset_name", "trl-lib/Capybara", "--push_to_hub"]
>>> run_uv_job(script, script_args=script_args, dependencies=["trl"], flavor="a10g-small")

로컬 스크립트 실행:

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

명령을 실행합니다:

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

volume를 마운트하여, 예를 들어 학습 중에 모델 체크포인트를 저장합니다:

>>> from huggingface_hub import Volume, run_uv_job
>>> script = "my_sft.py"
>>> script_args = ["--output_dir", "/training-outputs/training-v3-final", ...]
>>> checkpoints_bucket = Volume(type="bucket", source="username/my-bucket", mount_path="/training-outputs")
>>> run_uv_job(script, script_args=script_args, volumes=[checkpoints_bucket])

scale_to_zero_inference_endpoint

< >

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

매개변수

  • name (str) — 제로로 스케일링할 Inference Endpoint의 이름입니다.
  • namespace (str, 선택 사항) — Inference Endpoint가 위치한 namespace입니다. 기본값은 현재 사용자입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

InferenceEndpoint

스케일-투-제로된 Inference Endpoint에 대한 정보

Scale Inference Endpoint을 0으로 축소합니다.

0으로 스케일링된 Inference Endpoint에는 요금이 부과되지 않습니다. 다음 요청 시 콜드 스타트 지연을 수반하여 재개됩니다. 이는 pause_inference_endpoint()로 Inference Endpoint를 일시중지하는 경우와 다르며, 이 경우 resume_inference_endpoint()를 사용하여 수동으로 재개해야 합니다.

For convenience, you can also scale an Inference Endpoint to zero using InferenceEndpoint.scale_to_zero().

search_spaces

< >

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

매개변수

  • query (str) — 검색 쿼리 문자열입니다.
  • filter (str 또는 Iterable[str], 선택 사항) — 필터링할 문자열 태그 또는 태그 목록입니다.
  • sdk (str 또는 list[str], 선택 사항) — SDK로 필터링합니다 (예: "gradio", "docker", "static").
  • include_non_running (bool, 선택 사항) — 결과에 실행되지 않는 Spaces를 포함할지 여부입니다. 기본값은 False입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

Iterable[SpaceSearchResult]

SpaceSearchResult 객체의 반복 가능한 객체입니다.

Hub에서 시맨틱 검색을 사용하여 검색 공간을 검색합니다.

이 엔드포인트는 다중 단어 쿼리에 대해 의미 검색(embedding 기반)을, 단일 단어 쿼리에 대해 전체 텍스트 검색을 사용합니다.

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> results = list(api.search_spaces("generate image"))
>>> results[0].id
'mrfakename/Z-Image-Turbo'
>>> results[0].ai_category
'Image Generation'

set_space_sleep_time

< >

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

매개변수

  • repo_id (str) — 업데이트할 저장소의 ID입니다. 예: "bigcode/in-the-stack".
  • sleep_time (int, 선택 사항) — Space가 수면 상태로 전환되기 전까지 대기할 비활성 시간(초). Space가 일시중지되지 않기를 원하면 -1로 설정하세요(업그레이드된 하드웨어의 기본 동작). 무료 하드웨어의 경우 수면 시간을 설정할 수 없으며(값은 48시간 비활성으로 고정됨), 자세한 내용은 https://huggingface.co/docs/hub/spaces-gpus#sleep-time을 참조하세요.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

SpaceRuntime

Space의 스테이지와 하드웨어를 포함한 런타임 정보

업그레이드된 하드웨어에서 실행되는 Space에 대한 사용자 지정 sleep 시간을 설정합니다.

Space는 X초 동안 비활성 상태면 슬립 상태로 전환됩니다. Space가 “sleep” 모드에 있을 때는 요금이 청구되지 않습니다. 새로운 방문자가 Space에 접속하면 Space가 “wake up”됩니다. 업그레이드된 하드웨어만 설정 가능한 슬립 시간을 가질 수 있습니다. 슬립 단계에 대한 자세한 내용은 https://huggingface.co/docs/hub/spaces-gpus#sleep-time을 참조하세요.

request_space_hardware()로 하드웨어를 요청할 때 커스텀 sleep 시간을 설정하는 것도 가능합니다.

set_space_volumes

< >

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

매개변수

  • repo_id (str) — 업데이트할 Space의 ID입니다. 예: "username/my-space".
  • volumes (list[Volume]) — 마운트할 Volume 객체의 목록입니다. 각 볼륨에는 type ("bucket", "model", "dataset" 또는 "space"), source (리포지토리 또는 버킷 ID), mount_path (컨테이너 내부 경로)가 있으며, 선택적으로 revision, read_only, path 필드를 가질 수 있습니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

다음 예외가 발생합니다

BadRequestError

  • BadRequestError — Space가 정적 Space인 경우(정적 Space에서는 볼륨이 지원되지 않음).

Space에 볼륨을 설정합니다.

Space에 마운트된 볼륨 목록을 설정(또는 교체)합니다. 각 볼륨은 Space의 컨테이너가 Hub 리소스(모델, 데이터셋, 또는 스토리지 버킷)에 액세스할 수 있도록 합니다.

예:

>>> from huggingface_hub import HfApi, Volume
>>> api = HfApi()
>>> api.set_space_volumes(
...     "username/my-space",
...     volumes=[
...         Volume(type="model", source="username/my-model", mount_path="/models", read_only=True),
...         Volume(type="bucket", source="username/my-bucket", mount_path="/data"),
...     ],
... )

snapshot_download

< >

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

매개변수

  • repo_id (str) — /로 구분된 사용자 또는 조직 이름과 저장소 이름.
  • repo_type (str, 선택 사항) — dataset 또는 space에서 다운로드하는 경우 "dataset" 또는 "space"로 설정하고, model에서 다운로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • revision (str, 선택 사항) — 브랜치 이름, 태그 또는 커밋 해시일 수 있는 선택적 Git 리비전 ID입니다.
  • cache_dir (str, Path, 선택 사항) — 캐시된 파일이 저장되는 폴더의 경로입니다.
  • local_dir (str 또는 Path, 선택 사항) — 지정된 경우, 다운로드된 파일은 이 디렉터리 아래에 저장됩니다.
  • etag_timeout (float, 선택 사항, 기본값 10) — ETag를 가져올 때 서버가 데이터를 보내기까지 대기할 초 수입니다. 이 값은 httpx2.request에 전달됩니다.
  • force_download (bool, 선택 사항, 기본값 False) — 로컬 캐시에 이미 존재하더라도 파일을 다운로드할지 여부입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • local_files_only (bool, 선택 사항, 기본값 False) — True인 경우, 파일을 다운로드하지 않고 로컬 캐시 파일이 존재하면 해당 파일의 경로를 반환합니다.
  • allow_patterns (list[str] 또는 str, 선택 사항) — 제공된 경우, 하나 이상의 패턴과 일치하는 파일만 다운로드됩니다.
  • ignore_patterns (list[str] 또는 str, 선택 사항) — 제공된 경우, 해당 패턴 중 하나와 일치하는 파일은 다운로드되지 않습니다.
  • max_workers (int, 선택 사항) — 파일을 다운로드할 동시 실행 스레드 수(1 스레드 = 1개 파일 다운로드)입니다. 기본값은 8입니다.
  • tqdm_class (tqdm, 선택 사항) — 지정하면 진행 표시줄의 기본 동작을 덮어씁니다. 전달된 인수는 tqdm.auto.tqdm에서 상속되거나 최소한 그 동작을 모방해야 합니다. tqdm_class는 각 개별 다운로드에 전달되지 않는다는 점에 유의하세요. HF_HUB_DISABLE_PROGRESS_BARS 환경 변수를 설정하여 비활성화할 수 있는 커스텀 HF 진행 표시줄이 기본값입니다.
  • dry_run (bool, 선택 사항, 기본값 False) — True인 경우, 파일을 실제로 다운로드하지 않고 dry run을 수행합니다. 다운로드될 내용에 대한 정보를 포함하는 DryRunFileInfo 객체의 목록을 반환합니다.

반환값

str 또는 DryRunFileInfo의 목록

  • dry_run=False인 경우: 저장소 스냅샷의 폴더 경로.
  • dry_run=True인 경우: 다운로드 정보를 포함하는 DryRunFileInfo 객체의 목록을 반환합니다.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 RevisionNotFoundError 또는 EnvironmentError 또는 OSError 또는 ValueError

  • RepositoryNotFoundError — 다운로드할 저장소를 찾을 수 없는 경우. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.
  • RevisionNotFoundError — 다운로드할 리비전이 찾을 수 없는 경우.
  • EnvironmentError — token=True이고 토큰을 찾을 수 없는 경우.
  • OSError — ETag을 결정할 수 없는 경우.
  • ValueError — 일부 매개변수 값이 잘못된 경우.

Download repo files.

지정된 리비전에서 저장소의 파일 전체 스냅샷을 다운로드합니다. 사전에 어떤 파일이 필요한지 알 수 없는 경우, 저장소의 모든 파일이 필요할 때 유용합니다. 실제 파일명이 해당 폴더에 상대적으로 유지되도록 모든 파일이 폴더 안에 중첩됩니다. allow_patterns와 ignore_patterns를 사용하여 다운로드할 파일을 필터링할 수도 있습니다.

local_dir가 제공되면, 저장소의 파일 구조가 해당 위치에 복제됩니다. 이 옵션을 사용할 경우 cache_dir은 사용되지 않으며, 다운로드된 파일과 관련된 일부 메타데이터를 저장하기 위해 local_dir의 루트에 .cache/huggingface/ 폴더가 생성됩니다. 이 메커니즘은 메인 캐시 시스템만큼 견고하지는 않지만, 저장소의 최신 버전을 정기적으로 가져오는 작업에 최적화되어 있습니다.

대안으로 저장소를 클론하는 방법이 있지만, 이 경우 git과 git-lfs가 설치되어 있고 올바르게 구성되어야 합니다. 또한 git을 사용하여 저장소를 클론할 때 다운로드할 파일을 필터링하는 것은 불가능합니다.

space_info

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • revision (str, 선택 사항) — 정보를 가져올 space 저장소의 revision입니다.
  • timeout (float, 선택 사항) — Hub에 대한 요청에 타임아웃을 설정할지 여부.
  • files_metadata (bool, 선택 사항) — 리포지토리의 파일 메타데이터(크기, LFS 메타데이터 등)를 가져올지 여부입니다. 기본값은 False입니다.
  • expand (list[ExpandSpaceProperty_T], 선택 사항) — 응답에 반환할 속성 목록입니다. 이 매개변수를 사용하면 목록에 포함된 속성만 반환됩니다. full이 전달된 경우 이 매개변수를 사용할 수 없습니다. 가능한 값은 "author", "cardData", "createdAt", "datasets", "disabled", "lastModified", "likes", "models", "private", "region", "runtime", "sdk", "siblings", "sha", "subdomain", "tags", "trendingScore", "usedStorage", "resourceGroup"입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

SpaceInfo

Space 저장소 정보.

huggingface.co의 특정 Space에 대한 정보를 가져옵니다.

허용되는 토큰을 전달하면 Space를 비공개로 설정할 수 있습니다.

다음 오류를 발생시킵니다:

  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.
  • RevisionNotFoundError 다운로드할 수 없는 리비전이 발견되지 않는 경우.

super_squash_history

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • branch (str, 선택 사항) — squash할 branch입니다. 기본값은 "main" branch의 head입니다.
  • commit_message (str, 선택 사항) — squash된 커밋에 사용할 커밋 메시지입니다.
  • repo_type (str, 선택 사항) — 데이터셋 또는 Space의 커밋을 나열하려면 "dataset" 또는 "space"로, 모델에서 나열하려면 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 RevisionNotFoundError 또는 BadRequestError

  • RepositoryNotFoundError — 리포지토리가 찾을 수 없는 경우(에러 404): repo_id/repo_type이(가) 잘못되었거나, 비공개이지만 인증되지 않았거나, 리포지토리가 존재하지 않는 경우.
  • RevisionNotFoundError — squash할 브랜치를 찾을 수 없는 경우.
  • BadRequestError — 브랜치의 잘못된 참조인 경우. 태그에서는 히스토리를 squash할 수 없습니다.

Hub의 저장소에서 브랜치의 커밋 히스토리를 압축합니다.

수백 개의 커밋을 생성할 예정이고 히스토리가 지저분해지는 것을 원하지 않는다면, 저장소 히스토리를 압축하는 것이 유용합니다. 커밋 압축은 브랜치의 헤드에서만 수행할 수 있습니다.

squash가 완료되면 커밋 히스토리를 복구할 수 없습니다. 이는 되돌릴 수 없는 작업입니다.

브랜치의 히스토리가 squash된 후에는 두 브랜치의 히스토리가 분기(diverged)되었기 때문에 다른 브랜치로 다시 병합할 수 없습니다.

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()

# Create repo
>>> repo_id = api.create_repo("test-squash").repo_id

# Make a lot of commits.
>>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"content")
>>> api.upload_file(repo_id=repo_id, path_in_repo="lfs.bin", path_or_fileobj=b"content")
>>> api.upload_file(repo_id=repo_id, path_in_repo="file.txt", path_or_fileobj=b"another_content")

# Squash history
>>> api.super_squash_history(repo_id=repo_id)

suspend_scheduled_job

< >

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

매개변수

  • scheduled_job_id (str) — 예약된 Job의 ID입니다.
  • namespace (str, 선택 사항) — 예약된 Job이 있는 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

Hugging Face 인프라에서 예약된 compute Job을 일시 중지(Suspend)합니다.

sync_bucket

< >

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

매개변수

  • source (str, 선택 사항) — 소스 경로: 로컬 디렉터리 또는 hf://buckets/namespace/bucket_name(/prefix). apply를 사용하지 않는 경우 필수입니다.
  • dest (str, 선택 사항) — 대상 경로: 로컬 디렉터리 또는 hf://buckets/namespace/bucket_name(/prefix). apply를 사용하지 않는 경우 필수입니다.
  • delete (bool, 선택 사항, 기본값 False) — 소스에 없는 대상 파일을 삭제합니다.
  • ignore_times (bool, 선택 사항, 기본값 False) — 수정 시간을 무시하고 크기 기준으로만 파일을 건너뜁니다.
  • ignore_sizes (bool, 선택 사항, 기본값 False) — 크기를 무시하고 수정 시간만 기준으로 파일을 건너뜁니다.
  • existing (bool, 선택 사항, 기본값 False) — 수신기에서 새 파일 생성을 건너뜁니다(기존 파일만 업데이트).
  • ignore_existing (bool, 선택 사항, 기본값 False) — 수신기에 이미 존재하는 파일의 업데이트를 건너뜁니다(새 파일만 생성).
  • include (list[str], 선택 사항) — 패턴(fnmatch 스타일)과 일치하는 파일을 포함합니다.
  • exclude (list[str], 선택 사항) — 패턴(fnmatch 스타일)과 일치하는 파일을 제외합니다.
  • filter_from (str, 선택 사항) — 포함/제외 규칙이 포함된 필터 파일의 경로.
  • plan (str, optional) — 실행하지 않고 동기화 계획을 이 JSONL 파일에 저장합니다.
  • apply (str, optional) — 이전에 저장된 plan 파일을 적용합니다. 이 값이 설정되면 source와 dest는 필요하지 않습니다.
  • dry_run (bool, 선택 사항, 기본값 False) — 동기화 계획을 실행하지 않고 JSONL 형식으로 표준 출력(stdout)에 인쇄합니다.
  • verbose (bool, 선택 사항, 기본값 False) — 파일별 상세 작업을 표시합니다.
  • quiet (bool, 선택 사항, 기본값 False) — 모든 출력 및 진행 표시줄을 억제합니다.
  • token (Union[bool, str, None], optional) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용됩니다.

반환값

[SyncPlan]

계산된(또는 로드된) 동기화 계획.

로컬 디렉터리와 버킷 간에 파일을 동기화합니다.

이것은 hf buckets sync CLI 명령과 동일합니다. source 또는 dest 중 하나는 버킷 경로(hf://buckets/...)여야 하고, 다른 하나는 로컬 디렉터리 경로여야 합니다.

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()

# Upload local directory to bucket
>>> api.sync_bucket("./data", "hf://buckets/username/my-bucket")

# Download bucket to local directory
>>> api.sync_bucket("hf://buckets/username/my-bucket", "./data")

# Sync with delete and filtering
>>> api.sync_bucket(
...     "./data",
...     "hf://buckets/username/my-bucket",
...     delete=True,
...     include=["*.safetensors"],
... )

# Dry run: preview what would be synced
>>> plan = api.sync_bucket("./data", "hf://buckets/username/my-bucket", dry_run=True)
>>> plan.summary()
{'uploads': 3, 'downloads': 0, 'deletes': 0, 'skips': 1, 'total_size': 4096}

# Save plan for review, then apply
>>> api.sync_bucket("./data", "hf://buckets/username/my-bucket", plan="sync-plan.jsonl")
>>> api.sync_bucket(apply="sync-plan.jsonl")

sync_job_volume

< >

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

매개변수

  • source (str 또는 Path) — 동기화할 로컬 디렉터리의 경로입니다.
  • mount_path (str) — Job 컨테이너 내부의 마운트 경로입니다. 예: "/inputs". /로 시작해야 합니다.
  • remote_name (str, 선택 사항) — 동기화할 버킷의 서브폴더 이름입니다. 기본값은 소스 경로와 머신의 호스트 이름에서 파생된 {dirname}-{hash} 이름입니다.
  • read_only (bool, 선택 사항, 기본값 True) — Job에서 볼륨을 읽기 전용으로 마운트합니다. Job이 버킷 폴더에 다시 쓸 수 있도록 하려면 False를 전달하세요(예: 이후 sync_bucket()로 출력을 가져오기 위해).
  • namespace (str, 선택 사항) — jobs-artifacts 버킷을 소유한 namespace입니다. 기본값은 현재 사용자의 namespace입니다. 볼륨을 마운트할 Job과 동일한 namespace를 사용하세요.
  • token (Union[bool, str, None], 선택) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참조: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

반환값

볼륨

동기화되는 하위 폴더에 스코프가 설정된 버킷 볼륨으로, run_job(), run_uv_job(), create_scheduled_job() 또는 create_scheduled_uv_job()의 volumes 리스트에 전달합니다.

로컬 디렉토리를 버킷에 동기화하고 Job에서 마운트할 준비가 된 Volume을 반환합니다.

{namespace}/jobs-artifacts 버킷의 하위 폴더에 파일이 업로드됩니다(자동으로 비공개로 생성되며, 이미 존재하고 공개 상태이면 경고가 출력됩니다). 이때 sync_bucket()과 동일한 동기화 로직을 사용하여, 동일한 디렉토리를 다시 동기화하면 새 파일 또는 수정된 파일만 업로드됩니다. 기본적으로 하위 폴더 이름은 디렉토리 경로와 머신 호스트 이름에서 파생되므로, 동일한 디렉토리에서 반복 호출하면 동일한 원격 폴더가 재사용됩니다. 고정된 이름을 사용하려면 remote_name을 전달하세요.

데이터는 버킷에 복사되며 라이브로 마운트되지 않는다는 점에 유의하세요. 동기화 이후 로컬에서 이루어진 변경 사항은 Job에 반영되지 않으므로(업데이트하려면 sync_job_volume을 다시 실행하세요), 볼륨은 기본적으로 읽기 전용으로 마운트됩니다. Job이 읽기/쓰기 볼륨에 작성한 데이터를 가져오려면 sync_bucket()을 사용하여 버킷 폴더를 다시 동기화하세요. 소스 디렉터리가 비어 있는 경우(예: 출력 디렉터리), 볼륨이 마운트될 수 있도록 .keep 플레이스홀더 파일이 업로드됩니다.

예:

>>> from huggingface_hub import run_uv_job, sync_job_volume

# Upload ./training-data once, then run multiple jobs against it
>>> volume = sync_job_volume("./training-data", "/data")
>>> run_uv_job("train.py", script_args=["--learning-rate", "0.01"], volumes=[volume])
>>> run_uv_job("train.py", script_args=["--learning-rate", "0.05"], volumes=[volume])

# Read-write volume to retrieve outputs after the job completes
>>> volume = sync_job_volume("./outputs", "/outputs", read_only=False)
>>> job = run_uv_job("process.py", volumes=[volume])

trigger_scheduled_job

< >

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

매개변수

  • scheduled_job_id (str) — 예약된 Job의 ID입니다.
  • namespace (str, 선택 사항) — 예약된 Job이 있는 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

반환값

JobInfo

Info about the triggered run.

다음 예외가 발생합니다

HfHubHTTPError

  • HfHubHTTPError — 이미 다른 인스턴스가 실행 중이고 예약된 작업에서 concurrency가 비활성화된 경우 HTTP 409

예약된 Job을 즉시 실행하도록 트리거합니다.

이것은 예약된 작업의 스펙을 즉시 한 번 실행합니다. 스케줄을 변경하지 않으며 다음 예약 실행에 영향을 주지 않습니다. 인스턴스가 이미 실행 중이고 예약된 작업이 동시 실행을 허용하지 않는 경우, 요청이 거부됩니다(HTTP 409).

와(과) 달리

< >

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

매개변수

  • repo_id (str) — 좋아요를 취소할 저장소입니다. 예: "user/my-cool-model".
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • repo_type (str, 선택 사항) — 데이터셋 또는 스페이스의 좋아요를 취소하는 경우 "dataset" 또는 "space"로, 모델의 좋아요를 취소하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.

다음 예외가 발생합니다

RepositoryNotFoundError

  • RepositoryNotFoundError — 리포지토리가 찾을 수 없는 경우(에러 404): repo_id/repo_type가 잘못되었거나, 비공개이지만 인증되지 않았거나, 리포지토리가 존재하지 않는 경우.

Hub의 특정 저장소(예: 즐겨찾기 목록에서 제거)와 달리

스팸 사용을 방지하기 위해 스크립트에서 저장소를 like할 수 없습니다.

list_liked_repos()도 참고하세요.

예:

>>> from huggingface_hub import list_liked_repos, unlike
>>> "gpt2" in list_liked_repos().models # we assume you have already liked gpt2
True
>>> unlike("gpt2")
>>> "gpt2" in list_liked_repos().models
False

update_bucket_settings

< >

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

매개변수

  • bucket_id (str) — 버킷의 ID(예: "username/my-bucket").
  • private (bool) — 버킷을 비공개로 만들지 여부를 지정합니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

다음 예외가 발생합니다

BucketNotFoundError 또는 or

  • BucketNotFoundError — 버킷을 찾을 수 없는 경우. 버킷이 존재하지 않기 때문일 수 있습니다.
  • or — private로 설정되어 있어 접근 권한이 없기 때문입니다.

Hub에서 버킷의 설정을 업데이트합니다.

현재 지원되는 설정은 버킷의 가시성뿐입니다.

예:

>>> from huggingface_hub import update_bucket_settings

>>> # Make a bucket public
>>> update_bucket_settings(bucket_id="Wauplin/first-bucket", private=False)

>>> # Make it private again
>>> update_bucket_settings(bucket_id="Wauplin/first-bucket", private=True)

update_collection_item

< >

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

매개변수

  • collection_slug (str) — 업데이트할 collection의 slug입니다. 예: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • item_object_id (str) — 컬렉션 내 항목의 ID입니다. 이는 Hub에서 해당 항목의 ID(repo_id 또는 paper id)가 아닙니다. CollectionItem 객체에서 가져와야 합니다. 예: collection.items[0].item_object_id.
  • note (str, 선택 사항) — 컬렉션의 항목에 첨부할 노트입니다. 노트의 최대 길이는 500자입니다.
  • position (int, 선택 사항) — 컬렉션에서 항목의 새 위치.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

컬렉션의 항목을 업데이트합니다.

예:

>>> from huggingface_hub import get_collection, update_collection_item

# Get collection first
>>> collection = get_collection("TheBloke/recent-models-64f9a55bb3115b4f513ec026")

# Update item based on its ID (add note + update position)
>>> update_collection_item(
...     collection_slug="TheBloke/recent-models-64f9a55bb3115b4f513ec026",
...     item_object_id=collection.items[-1].item_object_id,
...     note="Newly updated model!",
...     position=0,
... )

update_collection_metadata

< >

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

매개변수

  • collection_slug (str) — 업데이트할 collection의 slug입니다. 예: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • title (str) — 업데이트할 컬렉션의 제목.
  • description (str, 선택 사항) — 업데이트할 컬렉션의 설명입니다. 설명의 최대 길이는 150자입니다.
  • position (int, 선택 사항) — 사용자의 컬렉션 목록에서 컬렉션의 새 위치.
  • private (bool, 선택 사항) — 컬렉션이 비공개여야 하는지 여부.
  • theme (str, 선택 사항) — Hub에서 컬렉션의 테마입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

Hub에서 컬렉션의 메타데이터를 업데이트합니다.

모든 인수는 선택 사항입니다. 제공된 메타데이터만 업데이트됩니다.

반환값: Collection

예:

>>> from huggingface_hub import update_collection_metadata
>>> collection = update_collection_metadata(
...     collection_slug="username/iccv-2023-64f9a55bb3115b4f513ec026",
...     title="ICCV Oct. 2023",
...     description="Portfolio of models, datasets, papers and demos I presented at ICCV Oct. 2023",
...     private=False,
...     theme="pink",
... )
>>> collection.slug
"username/iccv-oct-2023-64f9a55bb3115b4f513ec026"
# ^collection slug got updated but not the trailing ID

update_collection_resource_group

< >

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

매개변수

  • collection_slug (str) — 업데이트할 collection의 slug입니다. 예: "TheBloke/recent-models-64f9a55bb3115b4f513ec026".
  • resource_group_id (str 또는 None) — 컬렉션에 할당할 리소스 그룹을 24자 16진 문자열로 지정합니다. None인 경우 컬렉션은 모든 리소스 그룹에서 제거됩니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

컬렉션을 리소스 그룹에 할당하거나 모든 리소스 그룹에서 제거합니다.

조직 소유의 컬렉션에만 유효합니다.

예:

>>> from huggingface_hub import update_collection_resource_group
>>> update_collection_resource_group(
...     collection_slug="my-org/iccv-2023-64f9a55bb3115b4f513ec026",
...     resource_group_id="66980ecfc1e12a49c8f0e42d",
... )

update_inference_endpoint

< >

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

매개변수

  • name (str) — 업데이트할 Inference Endpoint의 이름입니다.
  • accelerator (str, 선택 사항) — 추론에 사용할 하드웨어 가속기(예: "cpu").
  • instance_size (str, 선택 사항) — 모델 호스팅에 사용할 인스턴스의 크기 또는 유형(예: "x4").
  • instance_type (str, 선택 사항) — Inference Endpoint가 배포될 클라우드 인스턴스 유형(예: "intel-icl").
  • min_replica (int, 선택 사항) — Inference Endpoint에서 계속 실행할 최소 리플리카(인스턴스) 수입니다.
  • max_replica (int, 선택 사항) — Inference Endpoint를 확장할 최대 리플리카(인스턴스) 수입니다.
  • scale_to_zero_timeout (int, 선택 사항) — 비활성 상태의 엔드포인트가 제로 스케일링되기까지의 시간(분).
  • scaling_metric (str 또는 InferenceEndpointScalingMetric , 선택 사항) — 스케일링에 사용할 메트릭 참조입니다. 지정된 경우 “pendingRequests” 또는 “hardwareUsage” 중 하나여야 합니다. 기본값은 None입니다.
  • scaling_threshold (float, 선택 사항) — 스케일 업을 트리거하는 데 사용되는 스케일링 메트릭 임계값입니다. 스케일링 메트릭이 제공되지 않으면 무시됩니다. 기본값은 None입니다.
  • repository (str, 선택 사항) — Inference Endpoint와 연결된 모델 저장소의 이름 (예: "gpt2").
  • framework (str, 선택 사항) — 모델에 사용되는 머신러닝 프레임워크(예: "custom").
  • revision (str, 선택 사항) — Inference Endpoint에 배포할 특정 모델 리비전(예: "6c0e6080953db56375760c0471a8c5f2929baf11").
  • task (str, 선택 사항) — 모델을 배포할 작업(예: "text-classification").
  • custom_image (dict, 선택 사항) — 실행할 컨테이너 이미지입니다. 이미지 변형별로 키를 가진 dict(예: {"vLLM": {"url": "vllm/vllm-openai:v0.23.0", "port": 8000}‌}, sGLang, tgi, tei, llamacpp, hfServe, …)로, 이 경우 그대로 전달되거나, 커스텀 컨테이너를 설명하는 평탄한 dict(예: {"url": ..., "port": ...})로, 이 경우 {"custom": ...}로 전송됩니다.
  • container_command (list[str], 선택 사항) — 컨테이너 엔트리포인트 명령을 재정의합니다(API 페이로드의 model.command에 매핑됨). 관리형 엔진 이미지(vLLM, SGLang 등)와 커스텀 이미지 모두에서 작동합니다.
  • container_args (list[str], 선택 사항) — 컨테이너 엔트리포인트에 추가되는 인자(API 페이로드의 model.args에 매핑됨). 관리형 엔진 이미지(예: vLLM, SGLang)와 커스텀 이미지 모두에서 작동합니다.
  • tensor_parallel_size (int, 선택 사항) — 단일 모델 복사본을 분할(shard)하기 위해 사용할 가속기 수(vLLM 및 SGLang 이미지). 엔진 이미지 설정에 기록됩니다. API는 model.image 전체를 요구하므로, custom_image가 제공되지 않으면 현재 엔드포인트에 구성된 이미지를 가져와서 해당 위치에 업데이트합니다.
  • data_parallel_size (int, 선택 사항) — 가속기당 하나씩 실행할 모델 사본의 수(vLLM 이미지). tensor_parallel_size와 동일한 처리 방식을 따릅니다.
  • env (dict[str, str], 선택 사항) — 컨테이너 환경에 주입할 비비밀 환경 변수
  • secrets (dict[str, str], 선택) — 컨테이너 환경에 주입할 시크릿 값입니다.
  • domain (str, 선택 사항) — Inference Endpoint 배포에 사용할 커스텀 도메인입니다. 설정된 경우, 해당 도메인에서 Inference Endpoint에 접근할 수 있습니다(예: "my-new-domain.cool-website.woof").
  • path (str, 선택 사항) — 배포된 모델의 사용자 지정 경로입니다. /로 시작해야 합니다(예: "/models/google-bert/bert-base-uncased").
  • cache_http_responses (bool, 선택 사항) — Inference Endpoint에서 반환된 HTTP 응답을 캐시에 저장할지 여부입니다.
  • tags (list[str], 선택 사항) — Inference Endpoint에 연결할 태그 목록입니다.
  • namespace (str, 선택 사항) — Inference Endpoint가 업데이트될 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

InferenceEndpoint

업데이트된 Inference Endpoint에 대한 정보

Inference Endpoint를 업데이트합니다.

이 메서드를 사용하면 compute 구성, 배포된 모델, 라우트 또는 이들의 조합을 업데이트할 수 있습니다. 모든 인수는 선택 사항이지만, 최소한 하나는 제공해야 합니다.

편의상 InferenceEndpoint.update()를 사용하여 Inference Endpoint를 업데이트할 수도 있습니다.

update_job_expose

< >

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

매개변수

  • job_id (str) — 실행 중인 Job의 ID.
  • expose (list[int], 선택 사항) — Jobs 프록시를 통해 노출할 포트입니다. 액세스하려면 Job의 namespace에 대한 읽기 권한이 있는 HF 토큰이 필요합니다.
  • expose_public (list[int], 선택) — 인증 없이 Jobs 프록시를 통해 노출할 포트입니다. expose에 나열할 필요가 없습니다.
  • namespace (str, 선택 사항) — Job의 Namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 사용자 액세스 토큰입니다. 기본적으로 로컬에 저장된 토큰을 사용합니다.

반환값

JobInfo

업데이트된 Job.

재실행하지 않고 실행 중인 Job의 노출된 포트를 교체합니다.

expose와 expose_public은 함께 완전한 포트 구성을 형성합니다. 두 목록에 모두 없는 포트는 닫힙니다. 모든 노출된 포트를 닫으려면 둘 다 전달하지 마세요.

update_job_labels

< >

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

매개변수

  • job_id (str) — Job의 ID입니다.
  • labels (dict[str, str]) — 작업에 설정할 새 레이블입니다. 기존 레이블을 모두 대체합니다. 키와 값은 모두 최대 100자이며, 영숫자, 대시, 밑줄만 포함할 수 있습니다.
  • namespace (str, 선택 사항) — Job이 실행되는 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

반환값

JobInfo

업데이트된 Job 정보.

기존 Job의 라벨을 업데이트합니다.

기존의 사용자 제공 라벨을 모두 새 라벨로 대체합니다.

update_repo_settings

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름.
  • gated (Literal["auto", "manual", False], 선택 사항) — 리포지토리의 gated 상태입니다. None ((기본값)로 설정하면 리포지토리의 gated 설정은 업데이트되지 않습니다.
    • “auto”: 저장소가 게이트드(gated) 상태이며, 사전에 정의된 기준에 따라 액세스 요청이 자동으로 승인 또는 거부됩니다.
    • “manual”: 저장소가 게이트되어 있으며, 액세스 요청은 수동 승인이 필요합니다.
    • False : 저장소가 게이트되지 않았으며 누구나 액세스할 수 있습니다.
  • private (bool, 선택 사항) — 리포지토리가 비공개여야 하는지 여부입니다. visibility와 함께 전달할 수 없습니다.
  • visibility (Literal["public", "private", "protected"], 선택 사항) — 리포지토리의 가시성입니다. "public" 또는 "private"로 설정할 수 있으며, Spaces의 경우 "protected"도 사용할 수 있습니다.
  • token (Union[str, bool, None], 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • repo_type (str, 선택 사항) — 설정 값을 가져와 업데이트할 저장소의 유형("model", "dataset" 또는 "space")입니다. 기본값은 "model"입니다.

다음 예외가 발생합니다

ValueError 또는 HfHubHTTPError 또는 RepositoryNotFoundError

  • ValueError — gated가 “auto”, “manual”, False 중 하나가 아닌 경우.
  • ValueError — repo_type가 constants.REPO_TYPES의 값 중 하나가 아닌 경우.
  • HfHubHTTPError — Hugging Face Hub API에 대한 요청이 실패한 경우.
  • RepositoryNotFoundError — 다운로드할 저장소를 찾을 수 없는 경우. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.

게이트된 액세스 및 가시성을 포함하여 저장소의 설정을 업데이트합니다.

리포지토리의 사용 방식을 더 세밀하게 제어할 수 있도록, Hub는 리포지토리 작성자가 자신의 리포지토리에 대한 액세스 요청을 활성화하고 리포지토리의 가시성을 변경할 수 있도록 지원합니다.

update_scheduled_job_labels

< >

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

매개변수

  • scheduled_job_id (str) — 예약된 Job의 ID입니다.
  • labels (dict[str, str]) — 예약된 작업에 설정할 새 레이블입니다. 기존 레이블을 모두 대체합니다. 키와 값은 모두 최대 100자이며, 영숫자, 대시, 밑줄만 포함할 수 있습니다.
  • namespace (str, 선택 사항) — 예약된 Job이 있는 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

반환값

ScheduledJobInfo

업데이트된 예약된 Job 정보.

기존 예약된 Job의 라벨을 업데이트합니다.

기존의 사용자 제공 라벨을 모두 새 라벨로 대체합니다.

update_scheduled_job_schedule

< >

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

매개변수

  • scheduled_job_id (str) — 예약된 Job의 ID입니다.
  • schedule (str) — “@annually”, “@yearly”, “@monthly”, “@weekly”, “@daily”, “@hourly” 중 하나 또는 CRON 스케줄 표현식(예: 매주 월요일 오전 9시를 나타내는 ‘0 9 * * 1’)
  • namespace (str, 선택 사항) — 예약된 Job이 있는 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

반환값

ScheduledJobInfo

업데이트된 예약된 Job 정보.

Job이 실행되는 시점을 변경합니다.

스케줄만 업데이트됩니다. Job spec, labels 및 suspended 상태는 유지됩니다. 스케줄을 변경하지 않고 예약된 Job을 지금 한 번만 실행하려면 trigger_scheduled_job()을 대신 사용하세요.

예:

>>> from huggingface_hub import update_scheduled_job_schedule
>>> scheduled_job = update_scheduled_job_schedule(scheduled_job_id="6abb8dc9c617607c354d45f4", schedule="@daily")
>>> scheduled_job.schedule
'@daily'

update_webhook

< >

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

매개변수

  • webhook_id (str) — 업데이트할 Webhook의 고유 식별자입니다.
  • url (str, 선택 사항) — payload가 전송될 URL입니다.
  • job_id (str, 선택 사항) — webhook payload로 트리거할 소스 Job의 ID입니다. secrets를 설정할 때 필수입니다.
  • watched (list[WebhookWatchedItem], optional) — 감시할 항목 목록입니다. 사용자, 조직, 모델, 데이터셋, 스페이스일 수 있습니다. 자세한 내용은 WebhookWatchedItem을(를) 참조하세요. 감시할 항목은 일반 딕셔너리 형태로도 제공할 수 있습니다.
  • domains (list[Literal["repo", "discussion"]], optional) — 감시할 도메인입니다. “repo”, “discussion” 또는 둘 다를 포함할 수 있습니다.
  • secret (str, optional) — 페이로드에 서명하는 데 사용되는 비밀 키로, 추가적인 보안 계층을 제공합니다.
  • secrets (dict[str, str], optional) — webhook에 의해 트리거된 Job의 Secret 환경 변수입니다. 나열된 키는 저장된 값을 대체하며, 빈 문자열은 해당 secret을 제거하고, 생략된 키는 저장된 값을 유지합니다. job_id가 필요합니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다(자세한 내용은 https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

WebhookInfo

업데이트된 웹훅에 대한 정보입니다.

기존 웹훅을 업데이트합니다.

예:

>>> from huggingface_hub import update_webhook
>>> updated_payload = update_webhook(
...     webhook_id="654bbbc16f2ec14d77f109cc",
...     url="https://new.webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
...     watched=[{"type": "user", "name": "julien-c"}, {"type": "org", "name": "HuggingFaceH4"}],
...     domains=["repo"],
...     secret="my-secret",
... )
>>> print(updated_payload)
WebhookInfo(
    id="654bbbc16f2ec14d77f109cc",
    job=None,
    url="https://new.webhook.site/a2176e82-5720-43ee-9e06-f91cb4c91548",
    watched=[WebhookWatchedItem(type="user", name="julien-c"), WebhookWatchedItem(type="org", name="HuggingFaceH4")],
    domains=["repo"],
    secret="my-secret",
    disabled=False,

upload_attachment

< >

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

매개변수

  • path (str 또는 Path) — 업로드할 파일의 경로입니다. 지원되는 형식은 PNG, JPEG, GIF, WebP, MP4, MOV, WebM, MP3, WAV입니다. 파일 크기는 10MB 미만이어야 합니다(영상은 50MB).
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 토큰에는 discussion.write 권한이 필요합니다. 익명으로 업로드하려면 False를 전달하세요.

반환값

str

업로드된 파일의 URL입니다.

다음 예외가 발생합니다

ValueError

  • ValueError — 파일 형식이 지원되지 않는 경우.

이미지, 비디오 또는 오디오 파일을 Hub에 업로드하고 해당 URL을 반환합니다.

![alt text](url)는 이미지, 맨 URL은 비디오, <audio controls src="url"></audio>는 오디오 파일을 설명이나 댓글에 삽입하는 방법입니다. 이는 Hub 웹 에디터에서 파일을 Discussion 또는 Pull Request 댓글 상자로 드래그했을 때 수행하는 작업입니다.

예:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> url = api.upload_attachment("screenshot.png")
>>> api.create_discussion("username/my-model", title="Rendering bug", description=f"![screenshot]({url})")

upload_file

< >

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

매개변수

  • path_or_fileobj (str, Path, bytes 또는 IO) — 로컬 머신에 있는 파일의 경로 또는 바이너리 데이터 스트림 / fileobj / 버퍼.
  • path_in_repo (str) — 레포지토리 내 상대 파일 경로, 예: "checkpoints/1fec34a/weights.bin"
  • repo_id (str) — 파일이 업로드될 저장소입니다. 예를 들어: "username/custom_transformers"
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • repo_type (str, 선택 사항) — dataset, space 또는 kernel 저장소에 업로드하는 경우 "dataset", "space" 또는 "kernel"로 설정하고, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • revision (str, 선택 사항) — 커밋할 git 리비전입니다. 기본값은 "main" 브랜치의 헤드입니다.
  • commit_message (str, 선택 사항) — 생성된 커밋의 요약 / 제목 / 첫 번째 줄
  • commit_description (str, 선택 사항) — 생성된 커밋의 설명
  • create_pr (boolean, 선택 사항) — 해당 커밋으로 Pull Request를 생성할지 여부입니다. 기본값은 False입니다. revision이 설정되지 않은 경우, PR은 "main" 브랜치를 대상으로 열립니다. revision이 설정되어 있고 브랜치인 경우, PR은 해당 브랜치를 대상으로 열립니다. revision이 설정되어 있고 브랜치 이름이 아닌 경우(예: 커밋 oid), 서버는 RevisionNotFoundError를 반환합니다.
  • parent_commit (str, 선택 사항) — 부모 커밋의 OID / SHA를 16진수 문자열로 나타낸 것입니다. 약식 표기(첫 7자리)도 지원합니다. 지정되어 있고 create_pr가 False인 경우, revision이 parent_commit을 가리키지 않으면 커밋이 실패합니다. 지정되어 있고 create_pr가 True인 경우, parent_commit에서 pull request가 생성됩니다. parent_commit을 지정하면 변경 사항을 커밋하기 전에 저장소가 변경되지 않았는지 확인할 수 있으며, 저장소가 동시에 업데이트되거나 커밋되는 경우 특히 유용합니다.
  • run_as_future (bool, 선택) — 이 메서드를 백그라운드에서 실행할지 여부입니다. 백그라운드 작업은 메인 스레드를 차단하지 않고 순차적으로 실행됩니다. run_as_future=True를 전달하면 Future 객체를 반환합니다. 기본값은 False입니다.

반환값

CommitInfo 또는 Future

새로 생성된 커밋에 대한 정보(커밋 해시, 커밋 URL, PR URL, 커밋 메시지 등)를 포함하는 CommitInfo 인스턴스입니다. run_as_future=True가 전달되면, 실행 시 결과를 포함하는 Future 객체를 반환합니다.

…에 로컬 파일(최대 50 GB)을 업로드합니다. 업로드는 HTTP post 요청을 통해 수행되며, git 또는 git-lfs가 설치되어 있지 않아도 됩니다.

다음 오류를 발생시킵니다:

  • HuggingFace API가 오류를 반환하면 HTTPError
  • ValueError 일부 매개변수 값이 잘못된 경우
  • RepositoryNotFoundError 다운로드할 저장소를 찾을 수 없는 경우 발생합니다. 저장소가 존재하지 않거나, private로 설정되어 있어 접근 권한이 없는 경우일 수 있습니다.
  • RevisionNotFoundError 다운로드할 수 없는 리비전이 발견되지 않는 경우.

upload_file는 Hub에 이미 저장소가 존재한다고 가정합니다. Client error 404가 발생하면 인증이 되어 있는지, 토큰에 필요한 권한이 있는지, repo_id와 repo_type가 올바르게 설정되어 있는지 확인하세요. 저장소가 존재하지 않는 경우 create_repo()를 사용하여 먼저 생성하세요.

예:

>>> from huggingface_hub import upload_file

>>> with open("./local/filepath", "rb") as fobj:
...     upload_file(
...         path_or_fileobj=fileobj,
...         path_in_repo="remote/file/path.h5",
...         repo_id="username/my-dataset",
...         repo_type="dataset",
...         token="my_token",
...     )

>>> upload_file(
...     path_or_fileobj=".\\local\\file\\path",
...     path_in_repo="remote/file/path.h5",
...     repo_id="username/my-model",
...     token="my_token",
... )

>>> upload_file(
...     path_or_fileobj=".\\local\\file\\path",
...     path_in_repo="remote/file/path.h5",
...     repo_id="username/my-model",
...     token="my_token",
...     create_pr=True,
... )

upload_folder

< >

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

매개변수

  • repo_id (str) — 파일이 업로드될 저장소입니다. 예를 들어: "username/custom_transformers"
  • folder_path (str 또는 Path) — 로컬 파일 시스템에서 업로드할 폴더의 경로
  • path_in_repo (str, 선택) — 레포지토리 내 디렉토리의 상대 경로입니다. 예를 들어: "checkpoints/1fec34a/results". 기본값은 레포지토리의 루트 폴더입니다.
  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • repo_type (str, 선택 사항) — dataset, space 또는 kernel 저장소에 업로드하는 경우 "dataset", "space" 또는 "kernel"로 설정하고, 모델에 업로드하는 경우 None 또는 "model"로 설정합니다. 기본값은 None입니다.
  • revision (str, 선택 사항) — 커밋할 git 리비전입니다. 기본값은 "main" 브랜치의 헤드입니다.
  • commit_message (str, 선택 사항) — 생성된 커밋의 요약 / 제목 / 첫 번째 줄입니다. 기본값: f"Upload {path_in_repo} with huggingface_hub"
  • commit_description (str 선택) — 생성된 커밋의 설명
  • create_pr (boolean, 선택 사항) — 해당 커밋으로 Pull Request를 생성할지 여부입니다. 기본값은 False입니다. PR은 항상 기본 브랜치를 대상으로 열립니다. create_pr=True와 revision를 모두 설정하면 ValueError가 발생합니다. create_pr=True로 호출할 때마다 새로운 pull request가 열립니다. 중단된 업로드를 기존 PR에 이어서 진행하려면 revision="refs/pr/N"을 사용하여 다시 실행하십시오.
  • parent_commit (str, 선택 사항) — 부모 커밋의 OID / SHA를 16진수 문자열로 나타낸 것입니다. 약식 표기(앞 7자리)도 지원합니다. 지정되어 있고 create_pr가 False인 경우, revision이 parent_commit을 가리키지 않으면 커밋이 실패합니다. parent_commit을 지정하면 변경 사항을 커밋하기 전에 저장소가 변경되지 않았는지 확인할 수 있으며, 저장소가 동시에 업데이트되거나 커밋되는 경우 특히 유용합니다. 업로드가 여러 커밋으로 나뉘는 경우(큰 폴더), parent_commit은 첫 번째 커밋에만 적용됩니다.
  • allow_patterns (list[str] 또는 str, 선택 사항) — 지정된 경우, 하나 이상의 패턴과 일치하는 파일만 업로드됩니다.
  • ignore_patterns (list[str] 또는 str, 선택 사항) — 제공된 경우, 해당 패턴 중 하나와 일치하는 파일은 업로드되지 않습니다.
  • delete_patterns (list[str] 또는 str, 선택 사항) — 지정된 경우, 새 파일을 커밋하는 동안 해당 패턴 중 하나와 일치하는 원격 파일이 저장소에서 삭제됩니다. 이미 어떤 파일이 업로드되었는지 모르는 경우 유용합니다. 참고: 불일치를 방지하기 위해 .gitattributes 파일은 패턴과 일치하더라도 삭제되지 않습니다.
  • run_as_future (bool, 선택) — 이 메서드를 백그라운드에서 실행할지 여부입니다. 백그라운드 작업은 메인 스레드를 차단하지 않고 순차적으로 실행됩니다. run_as_future=True를 전달하면 Future 객체를 반환합니다. 기본값은 False입니다.

반환값

CommitInfo 또는 Future

새로 생성된 커밋에 대한 정보(커밋 해시, 커밋 URL, PR URL, 커밋 메시지 등)를 포함하는 CommitInfo 인스턴스입니다. run_as_future=True가 전달되면, 실행 시 결과를 포함하는 Future 객체를 반환합니다.

…로컬 폴더를 지정된 저장소에 업로드합니다. 업로드는 HTTP 요청을 통해 수행되며, git 또는 git-lfs가 설치되어 있지 않아도 됩니다.

폴더 구조는 유지됩니다. 저장소에 이미 동일한 이름의 파일이 존재하는 경우 해당 파일은 덮어쓰기됩니다. 다른 파일은 변경되지 않습니다.

allow_patterns와 ignore_patterns 인수를 사용하여 업로드할 파일을 지정합니다. 이 매개변수는 단일 패턴 또는 패턴 목록을 받아들입니다. 패턴은 여기에 문서화된 표준 와일드카드(globbing 패턴)입니다. allow_patterns와 ignore_patterns가 모두 제공되면 두 제약 조건이 모두 적용됩니다. 기본적으로 폴더의 모든 파일이 업로드됩니다.

원격에서 삭제할 파일을 지정하려면 delete_patterns 인수를 사용하세요. 입력 유형은 allow_patterns와 동일합니다(위 참조). path_in_repo도 함께 제공되면, 패턴은 해당 폴더에 상대적인 경로와 일치하도록 매칭됩니다. 예를 들어, upload_folder(..., path_in_repo="experiment", delete_patterns="logs/*")는 ./experiment/logs/ 아래에 있는 모든 원격 파일을 삭제합니다. 패턴과 일치하더라도 .gitattributes 파일은 삭제되지 않는다는 점에 유의하세요.

하위 디렉터리 어디에 존재하는 .git/ 폴더도 무시됩니다. 그러나 .gitignore 파일은 고려되지 않는다는 점에 유의하세요.

hf_xet이 설치된 경우(기본값)에는 파일이 스트림된 파이프라인을 통해 업로드됩니다. 업로드는 폴더가 Hub와 대조되는 동안 시작되고, 파일은 업로드를 위해 청크로 나뉘는 동안 해시 처리됩니다(단일 읽기 패스). 또한 큰 폴더는 서버 한도를 초과하지 않도록 여러 배치로 자동으로 커밋되며(후속 커밋은 커밋 메시지에 (part N) 접미사가 붙음). 업로드가 중단된 경우, 동일한 호출을 다시 실행하면 업로드가 재개됩니다. 이미 커밋된 파일은 건너뛰고 이미 업로드된 데이터는 중복 제거됩니다. hf_xet이 설치되지 않은 경우, create_commit()으로 생성된 단일 커밋으로 폴백됩니다.

다음 오류를 발생시킵니다:

  • HuggingFace API가 오류를 반환하면 HTTPError
  • ValueError 일부 매개변수 값이 잘못된 경우

upload_folder은 Hub에 이미 저장소가 존재한다고 가정합니다. Client error 404가 발생하면 인증이 되어 있는지, 토큰에 필요한 권한이 있는지, repo_id와 repo_type가 올바르게 설정되어 있는지 확인하세요. 저장소가 존재하지 않는 경우 create_repo()를 사용하여 먼저 생성하세요.

예:

# Upload checkpoints folder except the log files
>>> upload_folder(
...     folder_path="local/checkpoints",
...     path_in_repo="remote/experiment/checkpoints",
...     repo_id="username/my-dataset",
...     repo_type="datasets",
...     token="my_token",
...     ignore_patterns="**/logs/*.txt",
... )

# Upload checkpoints folder including logs while deleting existing logs from the repo
# Useful if you don't know exactly which log files have already being pushed
>>> upload_folder(
...     folder_path="local/checkpoints",
...     path_in_repo="remote/experiment/checkpoints",
...     repo_id="username/my-dataset",
...     repo_type="datasets",
...     token="my_token",
...     delete_patterns="**/logs/*.txt",
... )

# Upload checkpoints folder while creating a PR
>>> upload_folder(
...     folder_path="local/checkpoints",
...     path_in_repo="remote/experiment/checkpoints",
...     repo_id="username/my-dataset",
...     repo_type="datasets",
...     token="my_token",
...     create_pr=True,
... )

verify_repo_checksums

< >

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

매개변수

  • repo_id (str) — /로 구분된 네임스페이스(사용자 또는 조직)와 저장소 이름
  • repo_type (str, 선택 사항) — 트리를 가져올 저장소의 유형입니다. ("model", "dataset" 또는 "space". 기본값은 "model"입니다.
  • revision (str, 선택 사항) — 트리를 가져올 저장소의 리비전입니다. 기본값은 "main" 브랜치입니다.
  • local_dir (str 또는 Path, 선택 사항) — 검증할 로컬 디렉터리입니다.
  • cache_dir (str 또는 Path, 선택 사항) — 확인할 캐시 디렉터리입니다.
  • token (Union[bool, str, None], optional) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.

반환값

FolderVerification

검증 세부 정보를 포함하는 구조화된 결과입니다.

다음 예외가 발생합니다

RepositoryNotFoundError 또는 RevisionNotFoundError

  • RepositoryNotFoundError — 리포지토리가 찾을 수 없는 경우(에러 404): repo_id/repo_type이(가) 잘못되었거나, 비공개이지만 인증되지 않았거나, 리포지토리가 존재하지 않는 경우.
  • RevisionNotFoundError — 리포지토리에서 revision을 찾을 수 없는 경우(에러 404).

repo의 로컬 파일을 Hub 체크섬과 대조하여 검증합니다.

wait_for_job

< >

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

매개변수

  • job_id (str 또는 list[str]) — Job의 ID 또는 대기할 Job ID 목록입니다. 목록이 전달되면 JobInfo 목록이 반환됩니다(동일한 순서로).
  • timeout (float, 선택 사항) — Job가 완료될 때까지 대기할 최대 시간(초). None인 경우 무한정 대기합니다.
  • poll_interval (float, 선택 사항) — 각 상태 확인 사이에 대기할 시간(초 단위)입니다. 기본값은 1초입니다.
  • stages (list[JobStage], 선택 사항) — 대기할 단계입니다. 기본값은 종료 단계("COMPLETED", "CANCELED", "ERROR", "DELETED")입니다. Job이 실행을 시작할 때까지 대기하려면 [JobStage.RUNNING]과 같은 값을 전달합니다. 종료 단계는 이 값과 관계없이 항상 대기를 중단합니다.
  • namespace (str, 선택 사항) — Job이 실행되는 namespace입니다. 기본값은 현재 사용자의 namespace입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 제공되지 않으면 로컬에 저장된 토큰이 사용되며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정하세요. 참고: https://huggingface.co/docs/huggingface_hub/quick-start#authentication.

반환값

JobInfo 또는 list[JobInfo]

최종 Job 정보들.

다음 예외가 발생합니다

TimeoutError

  • TimeoutError — 최소 하나의 Job이 timeout초 후에도 목표 단계 중 하나에 도달하지 못한 경우.

Hugging Face 인프라에서 하나 이상의 compute Jobs가 특정 단계에 도달할 때까지 기다립니다.

각 Job 상태는 poll_interval초마다 inspect_job()를 사용하여 폴링되며, 해당 Job의 stage가 stages 중 하나(기본적으로 종단 stage: "COMPLETED", "CANCELED", "ERROR" 또는 "DELETED")가 될 때까지 계속됩니다. 모든 경우에서 최종 JobInfo가 반환됩니다. 실패하거나 취소된 Job은 예외를 발생시키지 않습니다 — 결과를 처리하려면 job.status.stage를 확인하세요.

Terminal 단계는 stages에 나열되지 않은 경우에도 항상 대기 중단을 트리거합니다. 이는 Job이 절대 도달하지 못할 단계(예: 스케줄링 중에 실패하는 Job에서 "RUNNING"을 대기하는 경우)을 영원히 대기하는 것을 방지합니다.

예:

>>> from huggingface_hub import run_job, wait_for_job
>>> job = run_job(image="python:3.12", command=["python", "-c", "print('Hello from HF compute!')"])
>>> wait_for_job(job_id=job.id).status.stage
'COMPLETED'

wait_for_space

< >

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

매개변수

  • repo_id (str) — 대기할 Space의 ID입니다. 예: "username/my-space".
  • timeout (float, 선택 사항) — 초 단위로 대기할 최대 시간입니다. None인 경우 무한정 대기합니다.
  • poll_interval (float, 선택 사항) — 상태 확인 사이의 초 단위입니다. 기본값은 1초입니다.
  • token (bool 또는 str, 선택 사항) — 유효한 사용자 액세스 토큰입니다. 기본값은 로컬에 저장된 토큰이며, 이는 권장되는 인증 방법입니다. 인증을 비활성화하려면 False로 설정합니다. https://huggingface.co/docs/huggingface_hub/quick-start#authentication를 참조하세요.

반환값

SpaceRuntime

Space가 최종 단계에 도달한 후의 최종 런타임 정보입니다.

다음 예외가 발생합니다

TimeoutError

  • TimeoutError — Space가 timeout초 후에 종료 단계에 도달하지 못한 경우.

Space가 최종 단계(빌드 중/시작 중이 아닌 상태)에 도달할 때까지 기다립니다.

get_space_runtime()는 Space의 stage가 더 이상 중간 상태(BUILDING, RUNNING_BUILDING, APP_STARTING, RUNNING_APP_STARTING)가 아니 될 때까지 poll_interval초 간격으로 폴링합니다. 모든 경우에서 최종 SpaceRuntime을 반환합니다 — 결과를 처리하려면 runtime.stage를 확인하세요(예: RUNNING과 BUILD_ERROR 비교).

예:

>>> from huggingface_hub import restart_space, wait_for_space
>>> restart_space("username/my-space")
>>> runtime = wait_for_space("username/my-space")
>>> runtime.stage
'RUNNING'

whoami

< >

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

매개변수

  • token (bool 또는 str, 선택) — 유효한 사용자 액세스 토큰(문자열)입니다. 기본값은 로컬에 저장된 토큰이며, 이는 인증을 위한 권장 방법입니다( https://huggingface.co/docs/huggingface_hub/quick-start#authentication 참조). 인증을 비활성화하려면 False를 전달하세요.
  • cache (bool, 선택 사항) — whoami 호출의 결과를 후속 호출을 위해 캐시할지 여부입니다. 첫 번째 호출 중에 오류가 발생하면 캐시되지 않습니다. 기본값은 False입니다.

HF API를 호출하여 “whoami”를 확인합니다.

cache=True를 전달하면, Python 프로세스가 실행되는 동안 후속 호출을 위해 결과가 캐시됩니다. 보안상의 이유로 해당 엔드포인트는 엄격한 속도 제한이 적용되므로, whoami를 여러 번 호출할 계획이라면 유용합니다.

API 데이터 클래스

AccessRequest

class huggingface_hub.hf_api.AccessRequest

< >

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

매개변수

  • username (str, 선택 사항) — 액세스를 요청한 사용자의 사용자 이름입니다. 저장소가 요청자의 사용자 이름을 공유하지 않도록 구성된 경우 None입니다. 이 경우 request_id를 사용하여 요청을 수락, 거부 또는 취소합니다.
  • request_id (str) — 액세스 요청의 ID입니다. 사용자 이름이 공유되지 않은 경우에도 항상 설정됩니다.
  • fullname (str, 선택 사항) — 액세스를 요청한 사용자의 전체 이름입니다. 저장소가 요청자의 사용자명을 공유하지 않도록 구성된 경우 None입니다.
  • email (str, 선택 사항) — 액세스를 요청한 사용자의 이메일입니다. 사용자가 수동으로 액세스 권한을 부여받았거나, 저장소가 요청자의 이메일을 공유하지 않도록 설정된 경우 None입니다.
  • timestamp (datetime) — 요청의 타임스탬프입니다.
  • status (Literal["pending", "accepted", "rejected"]) — 요청의 상태입니다. ["pending", "accepted", "rejected"] 중 하나일 수 있습니다.
  • fields (dict[str, Any], 선택 사항) — 게이트 양식에서 사용자가 입력하는 추가 필드입니다.

사용자 액세스 요청에 대한 정보를 포함하는 데이터 구조입니다.

BucketFile

class huggingface_hub.BucketFile

< >

( **kwargs )

Hub의 버킷에 있는 파일에 대한 정보를 포함합니다. 이 객체는 list_bucket_tree()에 의해 반환됩니다.

RepoFile와 유사하지만 버킷에 있는 파일에 사용됩니다.

BucketFileMetadata

class huggingface_hub.BucketFileMetadata

< >

( size: intxet_file_data: XetFileData )

매개변수

  • size (int) — 바이트 단위의 파일 크기.
  • xet_file_data (XetFileData) — 파일의 Xet 정보(해시 및 새로고침 경로).

…

get_bucket_file_metadata()에서 반환됩니다.

BucketInfo

클래스 huggingface_hub.BucketInfo

< >

( **kwargs )

매개변수

  • id (str) — 버킷의 ID.
  • private (bool) — 버킷이 비공개인지 여부.
  • created_at (datetime) — Hub에서 버킷이 생성된 날짜입니다.
  • size (int) — 바이트 단위의 버킷 크기.
  • total_files (int) — 버킷 내 파일의 총 개수.

Hub의 버킷에 대한 정보를 포함합니다. 이 객체는 bucket_info() 및 list_buckets()에 의해 반환됩니다.

BucketUrl

클래스 huggingface_hub.BucketUrl

< >

( url: strendpoint: str = '' )

매개변수

  • url (str) — 버킷 URL의 문자열 값.
  • endpoint (str, 선택 사항) — Hub의 엔드포인트입니다. 기본값은 https://huggingface.co입니다.

Hub의 버킷 URL을 설명합니다.

BucketUrl은 create_bucket()에 의해 반환됩니다. 초기화 시 URL이 파싱되어 속성이 설정됩니다:

  • 엔드포인트 (str)
  • namespace(str)
  • bucket_id (str)
  • url (str)
  • uri (HfUri)

DatasetLeaderboardEntry

class huggingface_hub.DatasetLeaderboardEntry

< >

( **kwargs )

매개변수

  • rank (int) — 리더보드에서 모델의 순위(1부터 시작).
  • model_id (str) — 모델의 ID (예: "meta-llama/Llama-3-8b").
  • value (float) — 평가 점수 값.
  • filename (str) — 평가 데이터를 포함하는 결과 파일의 이름.
  • verified (bool) — 결과가 검증되었는지 여부.
  • source (dict[str, Any], 선택) — 평가 결과의 출처에 대한 정보입니다. "url", "name", "isExternal"과 같은 키를 포함합니다. 모든 항목에 출처가 있는 것은 아닙니다.
  • author (User 또는 Organization) — API 응답의 "type" 필드를 기반으로 파싱된 모델 작성자입니다.
  • pull_request (int, 선택 사항) — 리더보드 항목과 연관된 pull request 번호(있는 경우).
  • notes (str, 선택 사항) — 리더보드 항목에 연결된 노트가 있는 경우 해당 노트.

Hub의 데이터셋 리더보드에서 단일 항목에 대한 정보를 포함합니다.

리더보드는 주어진 벤치마크 데이터셋에 대한 평가 점수를 기준으로 모델을 순위를 매깁니다. 이 객체는 get_dataset_leaderboard()에 의해 반환됩니다. 특정 모델의 벤치마크별 평가 결과를 확인하려면 model_info()에서 expand=["evalResults"]를 사용하여 ModelInfo.eval_results 및 EvalResultEntry를 참조하세요.

EvalResultEntry

클래스 huggingface_hub.EvalResultEntry

< >

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

매개변수

  • dataset_id (str) — Hub의 벤치마크 데이터셋 ID. 예: “cais/hle”, “Idavidrein/gpqa”.
  • task_id (str) — 벤치마크 내 작업 식별자. 예: “gpqa_diamond”.
  • value (Any) — 메트릭 값. 예: 20.90.
  • dataset_revision (str, 선택 사항) — 벤치마크 데이터셋의 Git SHA입니다.
  • verify_token (str, 선택 사항) — 평가 과정이 검증 가능하고 재현 가능하다는 것을 증명하는 데 사용할 수 있는 서명입니다.
  • date (str, 선택 사항) — 평가 실행 시점(ISO-8601 datetime). 기본값은 git 커밋 시간입니다.
  • source_url (str, 선택 사항) — 평가 소스에 대한 링크(예: https://huggingface.co/spaces/SaylorTwift/smollm3-mmlu-pro). source_name, source_user, 또는 source_org이 제공된 경우 필수입니다.
  • source_name (str, 선택 사항) — 소스의 표시 이름입니다. 예: “Eval Logs”.
  • source_user (str, 선택 사항) — 출처를 명시하기 위한 HF 사용자 이름. 예: “celinah”.
  • source_org (str, 선택 사항) — 출처를 명시하기 위한 HF 조직 이름. 예: “cais”.
  • notes (str, optional) — Details about the evaluation setup. Example: “tools”, “no-tools”, “chain-of-thought”.

.eval_results/*.yaml 형식의 평가 결과 항목.

모델 저장소에 저장된 평가 점수를 나타내며, 모델 페이지와 벤치마크 데이터셋의 리더보드에 자동으로 표시됩니다.

README.md의 레거시 model-index 형식에는 EvalResult를 대신 사용하세요.

자세한 내용은 https://huggingface.co/docs/hub/eval-results를 참조하세요.

예:

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

< >

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

수행할 동기화 작업을 나타냅니다.

SyncPlan

클래스 huggingface_hub.SyncPlan

< >

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

완전한 동기화 계획을 나타냅니다.

CommitInfo

class huggingface_hub.CommitInfo

< >

( commit_url: str*args**kwargs )

매개변수

  • commit_url (str) — 커밋을 찾을 수 있는 URL입니다.
  • commit_message (str) — 생성된 커밋의 요약(첫 번째 줄)입니다.
  • commit_description (str) — 생성된 커밋에 대한 설명입니다. 비어 있을 수 있습니다.
  • oid (str) — 커밋 해시 ID. 예: "91c54ad1727ee830252e457677f467be0bfd8a57".
  • pr_url (str, 선택 사항) — 생성된 PR의 URL(있는 경우). create_pr=True가 전달되면 값이 설정됩니다.
  • pr_revision (str, 선택 사항) — 생성된 PR의 리비전(있을 경우). create_pr=True가 전달되면 값이 설정됩니다. 예: "refs/pr/1".
  • pr_num (int, 선택 사항) — 생성된 PR 토론의 번호입니다. create_pr=True가 전달된 경우에만 값이 설정됩니다. get_discussion_details()에서 discussion_num으로 전달할 수 있습니다. 예: 1.
  • repo_url (RepoUrl) — repo_id, repo_type 등의 정보를 포함하는 커밋의 저장소 URL입니다.

새로 생성된 커밋에 대한 정보를 포함하는 데이터 구조입니다.

Hub에서 커밋을 생성하는 모든 메서드에서 반환됩니다: create_commit(), upload_file(), upload_folder(), delete_file(), delete_folder(). 하위 호환성을 위해 str에서 상속되지만, str에 특화된 메서드를 사용하는 것은 비추천됩니다.

DatasetInfo

클래스 huggingface_hub.DatasetInfo

< >

( **kwargs )

매개변수

  • id (str) — 데이터셋의 ID.
  • author (str) — 데이터셋의 저자.
  • card_data (DatasetCardData, 선택) — huggingface_hub.repocard_data.DatasetCardData 객체로 표현된 Dataset Card 메타데이터.
  • citation (str, 선택 사항) — 데이터셋에 대한 인용 정보입니다.
  • created_at (datetime, 선택 사항) — Hub에서 저장소가 생성된 날짜입니다. 저장 날짜를 기록하기 시작한 시점에 해당하는 최소 값은 2022-03-02T23:29:04.000Z입니다.
  • description (str, 선택 사항) — 데이터셋의 설명입니다.
  • disabled (bool, 선택 사항) — 리포지토리가 비활성화되었는지 여부입니다.
  • downloads (int) — 최근 30일 동안의 데이터셋 다운로드 횟수.
  • downloads_all_time (int) — 데이터셋 생성 이후 누적 다운로드 횟수.
  • gated (Literal["auto", "manual", False], 선택) — 리포지토리가 게이트드인지 여부입니다. 그렇다면 수동 승인인지 자동 승인인지 여부를 나타냅니다.
  • last_modified (datetime, 선택 사항) — 레포지토리에 마지막으로 커밋된 날짜입니다.
  • likes (int) — 데이터셋의 좋아요 수.
  • main_size (int, 선택 사항) — 데이터셋의 main branch 크기(바이트 단위).
  • paperswithcode_id (str, 선택 사항) — 데이터셋의 Papers with code ID입니다.
  • private (bool) — 리포지토리가 비공개인지 여부.
  • resource_group (dict, 선택) — 데이터셋에 대한 리소스 그룹 정보입니다.
  • sha (str) — 해당 리비전의 Repo SHA.
  • siblings (list[RepoSibling]) — 데이터셋을 구성하는 huggingface_hub.hf_api.RepoSibling 객체의 목록.
  • tags (list[str]) — 데이터셋의 태그 목록입니다.
  • trending_score (int, 선택 사항) — 데이터셋의 트렌딩 점수입니다.
  • used_storage (int, 선택 사항) — Hub에 있는 데이터셋의 바이트 단위 크기.

Hub의 데이터셋에 대한 정보를 포함합니다. 이 객체는 dataset_info() 및 list_datasets()에 의해 반환됩니다.

이 클래스의 대부분의 속성은 선택 사항입니다. 이는 Hub에서 반환되는 데이터가 수행된 쿼리에 따라 달라지기 때문입니다. 일반적으로 쿼리가 더 구체적일수록 더 많은 정보가 반환됩니다. 반대로, list_datasets()를 사용하여 데이터셋을 나열하는 경우 속성의 일부만 반환됩니다.

DryRunFileInfo

class huggingface_hub.DryRunFileInfo

< >

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

매개변수

  • commit_hash (str) — 해당 파일과 관련된 commit_hash입니다.
  • file_size (int, 선택 사항) — 알려진 경우 파일의 크기입니다. LFS 파일인 경우 포인터가 아닌 실제 LFS 파일의 크기를 포함합니다.
  • filename (str) — 리포지토리 내 파일 이름.
  • is_cached (bool) — 파일이 이미 로컬에 캐시되어 있는지 여부.
  • will_download (bool) — hf_hub_download를 dry_run=False로 호출할 경우 파일이 다운로드되는지 여부입니다. 실제로 파일이 캐시에 없거나 force_download=True인 경우 will_download는 True입니다.

…

dry_run=True일 때 hf_hub_download()이 반환합니다.

DuplicatedRepoUrl

class huggingface_hub.DuplicatedRepoUrl

< >

( url: Anyendpoint: str | None = None )

매개변수

  • files_copy_pending (bool) — 새 저장소의 LFS/Xet 파일이 백그라운드에서 복사 중인 경우 True입니다. 복사가 완료될 때까지 이러한 파일을 다운로드하면 실패할 수 있습니다.

duplicate_repo()에서 반환된 RepoUrl.

GitRefInfo

class huggingface_hub.GitRefInfo

< >

( name: strref: strtarget_commit: str )

매개변수

  • name (str) — 참조 이름(예: 태그 이름 또는 브랜치 이름).
  • ref (str) — Hub의 전체 git ref(예: "refs/heads/main" 또는 "refs/tags/v1.0").
  • target_commit (str) — ref의 대상 커밋 OID (예: "e7da7f221d5bf496a48136c0cd264e630fe9fcc8")

Hub의 저장소에 대한 git 참조에 대한 정보를 포함합니다.

GitCommitInfo

class huggingface_hub.GitCommitInfo

< >

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

매개변수

  • commit_id (str) — 커밋의 OID (예: "e7da7f221d5bf496a48136c0cd264e630fe9fcc8")
  • authors (list[str]) — 커밋의 저자 목록.
  • created_at (datetime) — 커밋이 생성된 날짜와 시간.
  • title (str) — 커밋 제목입니다. 이는 저자가 입력하는 자유 형식의 텍스트 값입니다.
  • message (str) — 커밋에 대한 설명입니다. 이는 저자가 입력하는 자유 형식의 텍스트 값입니다.
  • formatted_title (str) — HTML 형식으로 포맷된 커밋 제목. formatted=True가 설정된 경우에만 반환됩니다.
  • formatted_message (str) — HTML 형식으로 포맷된 커밋 설명입니다. formatted=True가 설정된 경우에만 반환됩니다.

Hub의 저장소에 대한 git 커밋 정보를 포함합니다. 자세한 내용은 list_repo_commits()를 확인하세요.

GitRefs

class huggingface_hub.GitRefs

< >

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

매개변수

  • branches (list[GitRefInfo]) — 리포지토리의 브랜치에 대한 정보를 포함하는 GitRefInfo 목록입니다.
  • converts (list[GitRefInfo]) — 리포지토리의 “convert” ref에 대한 정보를 포함하는 GitRefInfo 목록입니다. Converts는 Dataset 리포지토리에서 전처리된 데이터를 push하는 데 (내부적으로) 사용되는 ref입니다.
  • tags (list[GitRefInfo]) — 리포지토리의 태그에 대한 정보를 포함하는 GitRefInfo 목록입니다.
  • pull_requests (list[GitRefInfo], 선택 사항) — 리포지토리의 pull request에 대한 정보를 포함하는 GitRefInfo 목록입니다. include_prs=True가 설정된 경우에만 반환됩니다.

Hub의 저장소에 대한 모든 git 참조에 대한 정보를 포함합니다.

Object는 list_repo_refs()에 의해 반환됩니다.

InferenceProviderMapping

클래스 huggingface_hub.hf_api.InferenceProviderMapping

< >

( **kwargs )

KernelInfo

class huggingface_hub.KernelInfo

< >

( **kwargs )

매개변수

  • id (str) — 커널 저장소의 ID입니다.
  • author (str, 선택 사항) — 커널 저장소의 작성자입니다.
  • downloads (int, 선택 사항) — 최근 30일 동안 커널 저장소의 다운로드 횟수.
  • gated (Literal["auto", "manual", False], 선택) — 리포지토리가 게이트드인지 여부입니다. 게이트드인 경우, 수동 승인인지 자동 승인인지 여부를 나타냅니다.
  • last_modified (datetime, 선택 사항) — 레포지토리에 마지막으로 커밋된 날짜입니다.
  • likes (int, 선택 사항) — 커널 저장소의 좋아요 수입니다.
  • private (bool, 선택) — 리포지토리가 비공개인지 여부.
  • sha (str, 선택 사항) — 해당 리비전의 리포 SHA입니다.

Hub의 커널 저장소에 대한 정보를 포함합니다. 이 객체는 kernel_info()에 의해 반환됩니다.

LFSFileInfo

class huggingface_hub.hf_api.LFSFileInfo

< >

( **kwargs )

매개변수

  • file_oid (str) — 파일의 SHA-256 객체 ID입니다. 파일을 영구적으로 삭제할 때 전달할 식별자입니다.
  • filename (str) — LFS 객체의 가능한 파일 이름입니다. 자세한 내용은 위의 참고 사항을 참조하세요.
  • oid (str) — LFS 객체의 OID입니다.
  • pushed_at (datetime) — LFS 객체가 저장소에 push된 날짜입니다.
  • ref (str, 선택 사항) — LFS 객체가 push된 ref(있는 경우).
  • size (int) — LFS 객체의 크기입니다.

Hub의 저장소에 LFS로 저장된 파일에 대한 정보를 포함합니다.

리포지토리에서 LFS 파일 목록을 조회하고 영구적으로 삭제하여 공간을 확보하는 맥락에서 사용됩니다. 자세한 내용은 list_lfs_files() 및 permanently_delete_lfs_files()를 참조하세요.

Git LFS 파일은 성능 최적화를 위해 파일 경로 대신 SHA-256 객체 ID로 추적됩니다. 이 방식이 필요한 이유는 여러 커밋에 걸쳐 단일 객체가 여러 경로에 의해 참조될 수 있어, 이러한 연결을 검색하고 해결하는 것이 비현실적이기 때문입니다. 각 SHA에 어떤 파일명이 연결되어 있는지 확인하는 방법은 문서를 참고하세요.

예:

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

< >

( **kwargs )

매개변수

  • id (str) — 모델의 ID.
  • author (str, 선택 사항) — 모델의 저자입니다.
  • base_models (list[str], 선택 사항) — 이 모델이 파생된 베이스 모델 목록.
  • card_data (ModelCardData, 선택) — huggingface_hub.repocard_data.ModelCardData 객체로 표현된 Model Card Metadata.
  • children_model_count (int, 선택 사항) — 이 모델에서 파생된 자식 모델의 수.
  • config (dict, 선택 사항) — 모델 구성입니다.
  • created_at (datetime, 선택 사항) — Hub에서 저장소가 생성된 날짜입니다. 저장 날짜를 기록하기 시작한 시점에 해당하는 최소 값은 2022-03-02T23:29:04.000Z입니다.
  • disabled (bool, 선택 사항) — 리포지토리가 비활성화되었는지 여부입니다.
  • downloads (int) — 최근 30일 동안의 모델 다운로드 횟수.
  • downloads_all_time (int) — 모델 생성 이후 누적 다운로드 횟수.
  • eval_results (list[EvalResultEntry], 선택 사항) — 모델의 평가 결과입니다.
  • gated (Literal["auto", "manual", False], 선택) — 리포지토리가 게이트드인지 여부입니다. 그렇다면 수동 승인인지 자동 승인인지 여부를 나타냅니다.
  • gguf (dict, 선택) — 모델의 GGUF 정보입니다.
  • inference (Literal["warm"], 선택 사항) — Inference Providers에서 모델의 상태입니다. 모델이 최소 한 개의 프로바이더에 의해 서빙되는 경우 Warm입니다.
  • inference_provider_mapping (list[InferenceProviderMapping], 선택 사항) — 사용자의 제공자 순서대로 정렬된 InferenceProviderMapping 목록입니다.
  • last_modified (datetime, 선택 사항) — 레포지토리에 마지막으로 커밋된 날짜입니다.
  • library_name (str, 선택 사항) — 모델과 연관된 라이브러리.
  • likes (int) — 모델의 좋아요 수.
  • mask_token (str, 선택 사항) — 모델에서 사용되는 마스크 토큰.
  • model_index (dict, 선택) — 평가용 모델 인덱스입니다.
  • pipeline_tag (str, 선택 사항) — 모델과 연관된 Pipeline 태그입니다.
  • private (bool) — 리포지토리가 비공개인지 여부.
  • resource_group (dict, 선택 사항) — 모델의 리소스 그룹 정보입니다.
  • safetensors (SafeTensorsInfo, 선택 사항) — 모델의 safetensors 정보입니다.
  • security_repo_status (dict, 선택 사항) — 모델의 보안 스캔 상태입니다.
  • sha (str, 선택 사항) — 해당 리비전의 리포 SHA입니다.
  • siblings (list[RepoSibling]) — 모델을 구성하는 huggingface_hub.hf_api.RepoSibling 객체의 목록입니다.
  • spaces (list[str], 선택 사항) — 해당 모델을 사용하는 스페이스 목록.
  • tags (list[str]) — 모델의 태그 목록입니다. card_data.tags와 비교했을 때, Hub에서 계산된 추가 태그(예: 지원 라이브러리, 모델의 arXiv)를 포함합니다.
  • transformers_info (TransformersInfo, 선택 사항) — 모델과 연관된 Transformers 관련 정보(자동 클래스, 프로세서 등).
  • trending_score (int, 선택 사항) — 모델의 트렌딩 점수입니다.
  • used_storage (int, 선택 사항) — Hub에서 모델의 바이트 단위 크기.
  • widget_data (Any, 선택 사항) — 모델과 관련된 위젯 데이터입니다.

Hub의 모델에 대한 정보를 포함합니다. 이 객체는 model_info()와 list_models()에 의해 반환됩니다.

이 클래스의 대부분의 속성은 선택 사항입니다. 이는 Hub에서 반환되는 데이터가 수행된 쿼리에 따라 달라지기 때문입니다. 일반적으로 쿼리가 더 구체적일수록 더 많은 정보가 반환됩니다. 반대로, list_models()를 사용하여 모델을 나열하는 경우 속성의 일부만 반환됩니다.

RepoSibling

class huggingface_hub.hf_api.RepoSibling

< >

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

매개변수

  • rfilename (str) — 리포지토리 루트 기준 파일 이름.
  • size (int, 선택 사항) — 바이트 단위의 파일 크기입니다. repo_info()의 files_metadata 인수가 True로 설정된 경우에만 이 속성이 정의됩니다. 그렇지 않으면 None입니다.
  • blob_id (str, 선택) — 파일의 git OID입니다. repo_info()의 files_metadata 인수가 True로 설정된 경우에만 이 속성이 정의됩니다. 그렇지 않으면 None입니다.
  • lfs (BlobLfsInfo, 선택) — 파일의 LFS 메타데이터입니다. repo_info()의 files_metadata 인수가 True로 설정되어 있고 파일이 Git LFS로 저장된 경우에만 이 속성이 정의됩니다. 그렇지 않으면 None입니다.

Hub의 저장소 내 저장소 파일에 대한 기본 정보를 포함합니다.

이 클래스의 모든 속성은 rfilename을 제외하고 선택 사항입니다. 이는 Hub에서 저장소를 나열할 때(list_models(), list_datasets() 또는 list_spaces()를 사용하여) 파일 이름만 반환되기 때문입니다. 파일 크기, blob id 또는 lfs 세부 정보와 같은 추가 정보가 필요하면 백엔드 서버에서 이러한 정보를 가져오는 데 더 많은 제약이 따르기 때문에, 저장소별로 하나씩 명시적으로 요청해야 합니다(model_info(), dataset_info() 또는 space_info() 사용).

RepoFile

class huggingface_hub.RepoFile

< >

( **kwargs )

매개변수

  • path (str) — 리포지토리 루트 기준 상대 파일 경로.
  • size (int) — 바이트 단위의 파일 크기입니다.
  • blob_id (str) — 파일의 git OID입니다.
  • lfs (BlobLfsInfo, 선택) — 파일의 LFS 메타데이터입니다.
  • xet_hash (str, 선택 사항) — 파일의 Xet 해시입니다.
  • last_commit (LastCommitInfo, 선택 사항) — 해당 파일의 마지막 커밋 메타데이터입니다. list_repo_tree()와 get_paths_info()를 expand=True로 호출한 경우에만 정의됩니다.
  • security (BlobSecurityInfo, 선택) — 파일의 보안 스캔 메타데이터입니다. list_repo_tree()와 get_paths_info()를 expand=True로 호출한 경우에만 정의됩니다.

Hub의 파일에 대한 정보를 포함합니다.

RepoUrl

클래스 huggingface_hub.RepoUrl

< >

( url: Anyendpoint: str | None = None )

매개변수

  • url (Any) — repo url의 문자열 값.
  • endpoint (str, 선택 사항) — Hub의 엔드포인트입니다. 기본값은 https://huggingface.co입니다.

다음 예외가 발생합니다

HfUriError

  • HfUriError — URL을 파싱할 수 없는 경우(예: canonical single-segment repo 또는 알 수 없는 repo_type).

Hub의 저장소 URL을 설명하는 str의 하위 클래스입니다.

RepoUrl은 HfApi.create_repo에 의해 반환됩니다. 하위 호환성을 위해 str를 상속합니다. 초기화 시 URL이 파싱되어 속성이 설정됩니다:

  • 엔드포인트 (str)
  • namespace(str)
  • repo_name (str)
  • repo_id (str)
  • repo_type (Literal["model", "dataset", "space"])
  • url (str)

예:

>>> 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://huggingface.co/proxy/hub-ci.huggingface.co/datasets/dummy_user/dummy_dataset', endpoint='https://huggingface.co/proxy/hub-ci.huggingface.co')
RepoUrl('https://huggingface.co/proxy/hub-ci.huggingface.co/datasets/dummy_user/dummy_dataset', endpoint='https://huggingface.co/proxy/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

< >

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

매개변수

  • metadata (dict, 선택) — 존재하는 경우 ‘model.safetensors.index.json’ 파일에 포함된 메타데이터입니다. 샤드된 모델의 경우에만 값이 설정됩니다.
  • sharded (bool) — 리포지토리에 샤드된 모델이 포함되어 있는지 여부.
  • weight_map (dict[str, str]) — 모든 가중치에 대한 맵입니다. 키는 텐서 이름이고 값은 해당 텐서를 포함하는 파일의 파일명입니다.
  • files_metadata (dict[str, SafetensorsFileMetadata]) — 모든 파일의 메타데이터 맵입니다. 키는 파일 이름이고, 값은 해당 파일의 메타데이터를 SafetensorsFileMetadata 객체로 나타낸 것입니다.
  • parameter_count (dict[str, int]) — 데이터 유형별 매개변수 수를 나타내는 맵입니다. 키는 데이터 유형이며, 값은 해당 데이터 유형의 매개변수 수입니다.

Safetensors 저장소의 메타데이터.

루트 디렉터리에 ‘model.safetensors’ 가중치 파일(공유되지 않는 모델) 또는 ‘model.safetensors.index.json’ 인덱스 파일(샤드된 모델)이 포함된 경우 해당 저장소는 Safetensors 저장소로 간주됩니다.

이 클래스는 get_safetensors_metadata()에 의해 반환됩니다.

safetensors 형식에 대한 자세한 내용은 https://huggingface.co/docs/safetensors/index#format을 확인하세요.

SafetensorsFileMetadata

클래스 huggingface_hub.utils.SafetensorsFileMetadata

< >

( metadata: dicttensors: dict )

매개변수

  • metadata (dict) — 파일에 포함된 메타데이터입니다.
  • tensors (dict[str, TensorInfo]) — 모든 텐서의 맵입니다. 키는 텐서 이름이고, 값은 TensorInfo 객체로 해당 텐서에 대한 정보를 나타냅니다.
  • parameter_count (dict[str, int]) — 데이터 유형별 매개변수 수를 나타내는 맵입니다. 키는 데이터 유형이며, 값은 해당 데이터 유형의 매개변수 수입니다.

Hub에 호스팅된 Safetensors 파일의 메타데이터.

이 클래스는 parse_safetensors_file_metadata()에 의해 반환됩니다.

safetensors 형식에 대한 자세한 내용은 https://huggingface.co/docs/safetensors/index#format을 확인하세요.

SpaceInfo

클래스 huggingface_hub.SpaceInfo

< >

( **kwargs )

매개변수

  • id (str) — Space의 ID입니다.
  • author (str, 선택 사항) — Space의 작성자입니다.
  • card_data (SpaceCardData, 선택) — Space Card 메타데이터를 huggingface_hub.repocard_data.SpaceCardData 객체로 나타냅니다.
  • created_at (datetime, 선택 사항) — Hub에서 저장소가 생성된 날짜입니다. 저장 날짜를 기록하기 시작한 시점에 해당하는 최소 값은 2022-03-02T23:29:04.000Z입니다.
  • datasets (list[str], 선택 사항) — Space에서 사용하는 데이터셋 목록입니다.
  • disabled (bool, 선택 사항) — Space가 비활성화되어 있는지 여부입니다.
  • gated (Literal["auto", "manual", False], 선택) — 리포지토리가 게이트드인지 여부입니다. 그렇다면 수동 승인인지 자동 승인인지 여부를 나타냅니다.
  • host (str, 선택 사항) — Space의 Host URL입니다.
  • last_modified (datetime, 선택 사항) — 레포지토리에 마지막으로 커밋된 날짜입니다.
  • likes (int) — Space의 좋아요 수.
  • models (list[str], 선택 사항) — Space에서 사용하는 모델 목록입니다.
  • private (bool) — 리포지토리가 비공개인지 여부.
  • region (Literal["us", "eu"], 선택 사항) — Space가 저장되는 클라우드 리전입니다.
  • resource_group (dict, 선택 사항) — Space의 리소스 그룹 정보입니다.
  • runtime (SpaceRuntime, 선택 사항) — huggingface_hub.hf_api.SpaceRuntime 객체로 표현된 Space 런타임 정보입니다.
  • sdk (str, 선택 사항) — Space에서 사용하는 SDK입니다.
  • sha (str, 선택 사항) — 해당 리비전의 리포 SHA입니다.
  • siblings (list[RepoSibling]) — Space를 구성하는 huggingface_hub.hf_api.RepoSibling 객체의 목록입니다.
  • subdomain (str, 선택 사항) — Space의 서브도메인입니다.
  • tags (list[str]) — Space의 태그 목록입니다.
  • trending_score (int, 선택 사항) — Space의 트렌딩 점수입니다.
  • used_storage (int, 선택 사항) — Hub의 Space 크기(바이트 단위).

Hub의 Space에 대한 정보를 포함합니다. 이 객체는 space_info() 및 list_spaces()에 의해 반환됩니다.

이 클래스의 대부분의 속성은 선택 사항입니다. 이는 Hub에서 반환되는 데이터가 수행된 쿼리에 따라 달라지기 때문입니다. 일반적으로 쿼리가 더 구체적일수록 더 많은 정보가 반환됩니다. 반대로, list_spaces()를 사용하여 spaces를 나열하는 경우 속성의 일부만 반환됩니다.

SpaceSearchResult

class huggingface_hub.SpaceSearchResult

< >

( data: dict )

매개변수

  • id (str) — Space의 ID (예: "username/repo-name").
  • author (str) — Space의 작성자입니다.
  • title (str) — Space의 표시 제목입니다.
  • emoji (str 또는 None) — Space의 이모지 아이콘입니다.
  • sdk (str 또는 None) — Space에서 사용하는 SDK(예: "gradio", "docker", "static").
  • likes (int) — 좋아요 수.
  • private (bool) — Space가 비공개인지 여부.
  • tags (list[str] 또는 None) — 태그 목록.
  • runtime (SpaceRuntime 또는 None) — Runtime 정보(단계, 하드웨어 등).
  • ai_short_description (str 또는 None) — AI가 생성한 짧은 설명입니다.
  • ai_category (str 또는 None) — AI가 생성한 카테고리(예: "Image Generation").
  • semantic_relevancy_score (float 또는 None) — 검색 쿼리에 대한 의미적 관련성 점수(0-1).
  • trending_score (int 또는 None) — 트렌딩 점수.

Spaces 시맨틱 검색 API의 단일 결과입니다.

HfApi.search_spaces()에서 반환됩니다.

TensorInfo

class huggingface_hub.utils.TensorInfo

< >

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

매개변수

  • dtype (str) — 텐서의 데이터 타입 (“F64”, “F32”, “F16”, “BF16”, “I64”, “I32”, “I16”, “I8”, “U8”, “U3”, “BOOL”).
  • shape (list[int]) — 텐서의 형태(shape)입니다.
  • data_offsets (tuple[int, int]) — 파일 내 데이터의 오프셋을 [BEGIN, END] 튜플로 나타낸 값입니다.
  • parameter_count (int) — 텐서의 매개변수 개수입니다.

텐서에 대한 정보.

safetensors 형식에 대한 자세한 내용은 https://huggingface.co/docs/safetensors/index#format을 확인하세요.

사용자

클래스 huggingface_hub.User

< >

( **kwargs )

매개변수

  • username (str) — Hub의 사용자 이름(고유).
  • fullname (str) — 사용자의 전체 이름.
  • avatar_url (str) — 사용자의 아바타 URL입니다.
  • details (str, 선택 사항) — 사용자 정보.
  • is_following (bool, 선택 사항) — 인증된 사용자가 이 사용자를 팔로우하는지 여부입니다.
  • is_pro (bool, 선택 사항) — 사용자가 프로 사용자인지 여부.
  • num_models (int, 선택 사항) — 사용자가 생성한 모델의 수.
  • num_datasets (int, 선택 사항) — 사용자가 생성한 데이터셋의 수.
  • num_spaces (int, 선택 사항) — 사용자가 생성한 스페이스의 수.
  • num_discussions (int, 선택 사항) — 사용자가 시작한 토론의 수.
  • num_papers (int, 선택 사항) — 사용자가 작성한 논문의 수.
  • num_upvotes (int, 선택 사항) — 사용자가 받은 추천 수입니다.
  • num_likes (int, 선택 사항) — 사용자가 좋아요를 누른 횟수.
  • num_following (int, 선택 사항) — 이 사용자가 팔로우 중인 사용자 수입니다.
  • num_followers (int, 선택 사항) — 이 사용자를 팔로우하는 사용자의 수.
  • orgs (Organization 목록) — 사용자가 속한 조직 목록입니다.

Hub의 사용자에 대한 정보를 포함합니다.

UserLikes

class huggingface_hub.UserLikes

< >

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

매개변수

  • user (str) — 좋아요를 가져온 사용자의 이름입니다.
  • total (int) — 좋아요 총 개수.
  • datasets (list[str]) — 사용자가 좋아요를 누른 데이터셋 목록 (repo_ids 형식).
  • kernels (list[str]) — 사용자가 좋아한 커널 목록 (repo_ids 형식).
  • models (list[str]) — 사용자가 좋아요를 누른 모델 목록 (repo_ids 형식).
  • spaces (list[str]) — 사용자가 좋아한 spaces 목록 (repo_ids로 표현).

Hub의 사용자 좋아요에 대한 정보를 포함합니다.

WebhookInfo

클래스 huggingface_hub.WebhookInfo

< >

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

매개변수

  • id (str) — Webhook의 ID입니다.
  • url (str, 선택) — Webhook의 URL입니다.
  • job (JobSpec, 선택 사항) — 트리거할 Job의 사양입니다.
  • watched (list[WebhookWatchedItem]) — webhook이 관찰하는 항목 목록입니다. WebhookWatchedItem을(를) 참조하세요.
  • domains (list[WEBHOOK_DOMAIN_T]) — webhook이 모니터링하는 도메인의 목록입니다. ["repo", "discussion"] 중 하나일 수 있습니다.
  • secret (str, 선택) — Webhook의 시크릿입니다.
  • disabled (bool) — Webhook이 비활성화되어 있는지 여부.

Webhook에 대한 정보를 포함하는 데이터 구조입니다.

url 또는 job 중 하나만 지정되어 있습니다.

WebhookWatchedItem

class huggingface_hub.WebhookWatchedItem

< >

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

매개변수

  • type (Literal["bucket", "dataset", "model", "org", "space", "user"]) — 감시할 항목의 유형입니다. ["bucket", "dataset", "model", "org", "space", "user"] 중 하나여야 합니다.
  • name (str) — 감시할 항목의 이름입니다. 사용자 이름, 조직 이름, 모델 이름, 데이터셋 이름, space 이름 또는 bucket 이름일 수 있습니다.

Webhook에서 감시하는 항목에 대한 정보를 포함하는 데이터 구조입니다.

CommitOperation

CommitOperation()에서 지원하는 값은 다음과 같습니다:

class huggingface_hub.CommitOperationAdd

< >

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

매개변수

  • path_in_repo (str) — 레포지토리 내 상대 파일 경로, 예: "checkpoints/1fec34a/weights.bin"
  • path_or_fileobj (str, Path, bytes, 또는 BinaryIO) — 다음 중 하나입니다:
    • 업로드할 로컬 파일의 경로(str 또는 pathlib.Path 형식)
    • 업로드할 파일의 내용을 담고 있는 바이트 버퍼(bytes)
    • io.BufferedIOBase의 하위 클래스인 “file object”로, 일반적으로 open(path, "rb")을 통해 얻습니다. seek()와 tell() 메서드를 지원해야 합니다.

다음 예외가 발생합니다

ValueError

  • ValueError — path_or_fileobj가 str, Path, bytes, io.BufferedIOBase 중 하나가 아닌 경우.
  • ValueError — path_or_fileobj이 str 또는 Path이지만 기존 파일의 경로가 아닌 경우.
  • ValueError — path_or_fileobj이 io.BufferedIOBase이지만 seek()와 tell()를 모두 지원하지 않는 경우.

Hub의 저장소에 파일을 업로드하는 데 필요한 정보를 담고 있는 데이터 구조입니다.

as_file

< >

( with_tqdm: bool = False )

매개변수

  • with_tqdm (bool, 선택 사항, 기본값 False) — True인 경우, 파일 객체를 반복할 때 진행률 바가 표시됩니다. 파일 유사 객체가 파일 경로인 경우에만 작동합니다. 순수 바이트와 버퍼는 지원되지 않습니다.

path_or_fileobj 뒤에 있는 기본 데이터를 읽을 수 있는 파일 유사 객체를 반환하는 컨텍스트 매니저입니다.

예:

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

< >

( )

path_or_fileobj의 base64 인코딩된 콘텐츠

반환값: bytes

클래스 huggingface_hub.CommitOperationDelete

< >

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

매개변수

  • path_in_repo (str) — 레포지토리 내 상대 파일 경로입니다. 예를 들어, 파일의 경우 "checkpoints/1fec34a/weights.bin", 폴더의 경우 "checkpoints/1fec34a/"입니다.
  • is_folder (bool 또는 Literal["auto"], 선택 사항) — 삭제 작업이 폴더에 적용되는지 여부를 지정합니다. "auto"인 경우, 경로가 "/"로 끝나는지(폴더) 아니면 그렇지 않은지(파일)를 확인하여 경로 유형(파일 또는 폴더)을 자동으로 추측합니다. 경로 유형을 명시적으로 설정하려면 is_folder=True 또는 is_folder=False를 설정할 수 있습니다.

Hub의 저장소에서 파일 또는 폴더를 삭제하는 데 필요한 정보를 담고 있는 데이터 구조

class huggingface_hub.CommitOperationCopy

< >

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

매개변수

  • src_path_in_repo (str) — 복사할 파일의 저장소 내 상대 경로, 예: "checkpoints/1fec34a/weights.bin".
  • path_in_repo (str) — 파일을 복사할 저장소 내 상대 경로, 예: "checkpoints/1fec34a/weights_copy.bin".
  • src_revision (str, 선택 사항) — 복사할 파일의 git revision입니다. 유효한 git revision이면 무엇이든 사용할 수 있습니다. 기본값은 대상 commit revision입니다.
  • src_repo_id (str, 선택 사항) — 복사할 소스 저장소(예: "username/source-model"). 기본값은 대상 저장소입니다(저장소 내 복사).
  • src_repo_type (str, 선택 사항) — 소스 저장소의 유형("model", "dataset" 또는 "space"). src_repo_id가 설정된 경우 필수입니다.

Hub의 저장소에서 파일을 복사하는 데 필요한 정보를 담고 있는 데이터 구조입니다.

LFS 파일과 일반 파일 모두 지원됩니다. LFS 파일은 서버 측에서 복사되고, 일반 파일은 커밋의 일부로 다운로드된 후 다시 업로드됩니다.

src_repo_id와 src_repo_type를 설정하여 저장소 간 복사를 지원합니다. 저장소 간 LFS 복사의 경우, 커밋이 생성되기 전에 LFS 객체가 대상 저장소로 중복 복사됩니다. 이 과정은 create_commit()에 의해 자동으로 처리됩니다. 저장소 간 복사는 동일한 스토리지 리전 내에서만 작동하며, 리전 간 복사는 지원되지 않습니다.

참고: CommitOperationCopy와 CommitOperationDelete를 조합하여 Hub에서 LFS 파일 이름을 변경할 수 있습니다.

CommitScheduler

class huggingface_hub.CommitScheduler

< >

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

매개변수

  • repo_id (str) — 커밋할 저장소의 id입니다.
  • folder_path (str 또는 Path) — 정기적으로 업로드할 로컬 폴더의 경로입니다.
  • every (int 또는 float, 선택 사항) — 각 커밋 사이의 분 단위 간격입니다. 기본값은 5분입니다.
  • path_in_repo (str, 선택) — 레포지토리 내 디렉토리의 상대 경로입니다. 예: "checkpoints/". 기본값은 레포지토리의 루트 폴더입니다.
  • repo_type (str, 선택 사항) — 커밋할 저장소의 유형입니다. 기본값은 model입니다.
  • revision (str, 선택 사항) — 커밋할 리포지토리의 리비전입니다. 기본값은 main입니다.
  • private (bool, 선택 사항) — 리포지토리를 비공개로 만들지 여부를 지정합니다. None(기본값)인 경우, 조직의 기본 설정이 비공개가 아닌 한 리포지토리는 공개됩니다. 리포지토리가 이미 존재하면 이 값은 무시됩니다.
  • token (str, 선택 사항) — 리포지토리에 커밋할 때 사용할 토큰입니다. 기본값은 머신에 저장된 토큰입니다.
  • allow_patterns (list[str] 또는 str, 선택 사항) — 지정된 경우, 하나 이상의 패턴과 일치하는 파일만 업로드됩니다.
  • ignore_patterns (list[str] 또는 str, 선택 사항) — 제공된 경우, 해당 패턴 중 하나와 일치하는 파일은 업로드되지 않습니다.
  • squash_history (bool, 선택 사항) — 각 커밋 후 리포지토리의 히스토리를 squash할지 여부입니다. 기본값은 False입니다. 커밋을 squash하면 리포지토리가 너무 커질 때 성능 저하를 방지하는 데 유용합니다.
  • hf_api (HfApi, 선택 사항) — Hub에 커밋할 때 사용할 HfApi 클라이언트입니다. 사용자 지정 설정(유저 에이전트, 토큰 등)을 지정하여 설정할 수 있습니다.

정해진 간격(예: 5분마다)으로 로컬 폴더를 Hub에 업로드하는 스케줄러

스케줄러를 사용하는 권장 방법은 컨텍스트 매니저로 사용하는 것입니다. 이를 통해 스크립트가 종료될 때 스케줄러가 적절히 중지되고 마지막 커밋이 트리거됩니다. 스케줄러는 stop 메서드를 사용하여 수동으로 중지할 수도 있습니다. 사용법에 대한 자세한 내용은 업로드 가이드를 확인하세요.

예:

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

컨텍스트 매니저를 사용한 예시:

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

< >

( )

Hub에 폴더를 push하고 커밋 정보를 반환합니다.

이 메서드는 직접 호출하도록 설계되지 않았습니다. 스케줄러가 백그라운드에서 실행하며, 동시 커밋을 방지하기 위한 큐 메커니즘을 준수합니다. 이 메서드를 직접 호출하면 동시성 문제가 발생할 수 있습니다.

push_to_hub의 기본 동작은 폴더를 append-only로 가정하는 것입니다. 폴더 내의 모든 파일을 나열하고 변경된 파일만 업로드합니다. 변경 사항이 없으면 커밋 없이 메서드가 반환됩니다. 이 동작을 변경하려면 CommitScheduler를 상속받아 해당 메서드를 오버라이드할 수 있습니다. 예를 들어 커밋하기 전에 데이터를 단일 파일로 압축하는 데 유용할 수 있습니다. 자세한 내용과 예제는 통합 가이드를 참고하세요.

중지

< >

( )

스케줄러를 중지합니다.

중지된 스케줄러는 다시 시작할 수 없습니다. 주로 테스트 목적으로 사용됩니다.

트리거

< >

( )

push_to_hub를 트리거하고 future를 반환합니다.

이 메서드는 every 분마다 자동으로 호출됩니다. 다음 예약된 커밋을 기다리지 않고 즉시 커밋을 트리거하려면 수동으로 호출할 수도 있습니다.

Update on GitHub

←환경 변수 CLI→