@huggingface/hub
Classes
Interfaces
- AuthInfo
- CommitDeletedEntry
- CommitFile
- CommitOutput
- CommitParams
- Credentials
- DatasetEntry
- FileDownloadInfoOutput
- ListFileEntry
- ModelEntry
- RepoId
- SafetensorsIndexJson
- SpaceEntry
- SpaceResourceConfig
- SpaceResourceRequirement
- SpaceRuntime
- TensorInfo
- WhoAmIApp
- WhoAmIOrg
- WhoAmIUser
Type Aliases
AccessToken
Ƭ AccessToken: string
Actually hf_${string}, but for convenience, using the string type
Defined in
AccessTokenRole
Ƭ AccessTokenRole: "admin" | "write" | "contributor" | "read"
Defined in
AuthType
Ƭ AuthType: "access_token" | "app_token" | "app_token_as_user"
Defined in
CommitOperation
Ƭ CommitOperation: CommitDeletedEntry | CommitFile
Defined in
ContentSource
Ƭ ContentSource: Blob | URL
Defined in
Dtype
Ƭ Dtype: "F64" | "F32" | "F16" | "BF16" | "I64" | "I32" | "I16" | "I8" | "U8" | "BOOL"
Defined in
hub/src/lib/parse-safetensors-metadata.ts:18
RepoDesignation
Ƭ RepoDesignation: RepoId | RepoFullName
Defined in
RepoFullName
Ƭ RepoFullName: string | `spaces/${string}` | `datasets/${string}`
Defined in
RepoType
Ƭ RepoType: "space" | "dataset" | "model"
Defined in
SafetensorsFileHeader
Ƭ SafetensorsFileHeader: Record<TensorName, TensorInfo> & { __metadata__: Record<string, string> }
Defined in
hub/src/lib/parse-safetensors-metadata.ts:26
SafetensorsParseFromRepo
Ƭ SafetensorsParseFromRepo: { header: SafetensorsFileHeader ; parameterCount?: Partial<Record<Dtype, number>> ; sharded: false } | { headers: SafetensorsShardedHeaders ; index: SafetensorsIndexJson ; parameterCount?: Partial<Record<Dtype, number>> ; sharded: true }
Defined in
hub/src/lib/parse-safetensors-metadata.ts:40
SafetensorsShardedHeaders
Ƭ SafetensorsShardedHeaders: Record<FileName, SafetensorsFileHeader>
Defined in
hub/src/lib/parse-safetensors-metadata.ts:38
SpaceHardwareFlavor
Ƭ SpaceHardwareFlavor: "cpu-basic" | "cpu-upgrade" | "t4-small" | "t4-medium" | "a10g-small" | "a10g-large" | "a100-large"
Defined in
SpaceSdk
Ƭ SpaceSdk: "streamlit" | "gradio" | "docker" | "static"
Defined in
SpaceStage
Ƭ SpaceStage: "NO_APP_FILE" | "CONFIG_ERROR" | "BUILDING" | "BUILD_ERROR" | "RUNNING" | "RUNNING_BUILDING" | "RUNTIME_ERROR" | "DELETING" | "PAUSED" | "SLEEPING"
Defined in
Task
Ƭ Task: "text-classification" | "token-classification" | "table-question-answering" | "question-answering" | "zero-shot-classification" | "translation" | "summarization" | "conversational" | "feature-extraction" | "text-generation" | "text2text-generation" | "fill-mask" | "sentence-similarity" | "text-to-speech" | "automatic-speech-recognition" | "audio-to-audio" | "audio-classification" | "voice-activity-detection" | "depth-estimation" | "image-classification" | "object-detection" | "image-segmentation" | "text-to-image" | "image-to-text" | "image-to-image" | "unconditional-image-generation" | "video-classification" | "reinforcement-learning" | "robotics" | "tabular-classification" | "tabular-regression" | "tabular-to-text" | "table-to-text" | "multiple-choice" | "text-retrieval" | "time-series-forecasting" | "visual-question-answering" | "document-question-answering" | "zero-shot-image-classification" | "graph-ml" | "other"
Defined in
TensorName
Ƭ TensorName: string
Defined in
hub/src/lib/parse-safetensors-metadata.ts:17
WhoAmI
Ƭ WhoAmI: WhoAmIApp | WhoAmIOrg | WhoAmIUser
Defined in
Functions
commit
▸ commit(params): Promise<CommitOutput>
Parameters
| Name | Type |
|---|---|
params |
CommitParams |
Returns
Promise<CommitOutput>
Defined in
createRepo
▸ createRepo(params): Promise<{ repoUrl: string }>
Parameters
| Name | Type | Description |
|---|---|---|
params |
Object |
- |
params.credentials |
Credentials |
- |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
Custom fetch function to use instead of the default one, for example to use a proxy or edit headers. |
params.files? |
{ content: ArrayBuffer | Blob ; path: string }[] |
Only a few lightweight files are supported at repo creation |
params.hubUrl? |
string |
- |
params.license? |
string |
- |
params.private? |
boolean |
- |
params.repo |
RepoDesignation |
- |
params.sdk? |
SpaceSdk |
Required for when repo.type === “space” |
Returns
Promise<{ repoUrl: string }>
Defined in
deleteFile
▸ deleteFile(params): Promise<CommitOutput>
Parameters
| Name | Type |
|---|---|
params |
Object |
params.branch? |
string |
params.commitDescription? |
string |
params.commitTitle? |
string |
params.credentials |
Credentials |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
params.hubUrl? |
string |
params.isPullRequest? |
boolean |
params.parentCommit? |
string |
params.path |
string |
params.repo |
RepoDesignation |
Returns
Promise<CommitOutput>
Defined in
deleteFiles
▸ deleteFiles(params): Promise<CommitOutput>
Parameters
| Name | Type |
|---|---|
params |
Object |
params.branch? |
string |
params.commitDescription? |
string |
params.commitTitle? |
string |
params.credentials |
Credentials |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
params.hubUrl? |
string |
params.isPullRequest? |
boolean |
params.parentCommit? |
string |
params.paths |
string[] |
params.repo |
RepoDesignation |
Returns
Promise<CommitOutput>
Defined in
deleteRepo
▸ deleteRepo(params): Promise<void>
Parameters
| Name | Type |
|---|---|
params |
Object |
params.credentials |
Credentials |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
params.hubUrl? |
string |
params.repo |
RepoDesignation |
Returns
Promise<void>
Defined in
downloadFile
▸ downloadFile(params): Promise<Response | null>
Parameters
| Name | Type | Description |
|---|---|---|
params |
Object |
- |
params.credentials? |
Credentials |
- |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
Custom fetch function to use instead of the default one, for example to use a proxy or edit headers. |
params.hubUrl? |
string |
- |
params.path |
string |
- |
params.range? |
[number, number] |
Fetch only a specific part of the file |
params.raw? |
boolean |
If true, will download the raw git file. For example, when calling on a file stored with Git LFS, the pointer file will be downloaded instead. |
params.repo |
RepoDesignation |
- |
params.revision? |
string |
- |
Returns
Promise<Response | null>
null when the file doesn’t exist
Defined in
hub/src/lib/download-file.ts:10
fileDownloadInfo
▸ fileDownloadInfo(params): Promise<FileDownloadInfoOutput | null>
Parameters
| Name | Type | Description |
|---|---|---|
params |
Object |
- |
params.credentials? |
Credentials |
- |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
Custom fetch function to use instead of the default one, for example to use a proxy or edit headers. |
params.hubUrl? |
string |
- |
params.noContentDisposition? |
boolean |
To avoid the content-disposition header in the downloadLink for LFS files So that on browsers you can use the URL in an iframe for example |
params.path |
string |
- |
params.raw? |
boolean |
To get the raw pointer file behind a LFS file |
params.repo |
RepoDesignation |
- |
params.revision? |
string |
- |
Returns
Promise<FileDownloadInfoOutput | null>
null when the file doesn’t exist
Defined in
hub/src/lib/file-download-info.ts:18
fileExists
▸ fileExists(params): Promise<boolean>
Parameters
| Name | Type |
|---|---|
params |
Object |
params.credentials? |
Credentials |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
params.hubUrl? |
string |
params.path |
string |
params.repo |
RepoDesignation |
params.revision? |
string |
Returns
Promise<boolean>
Defined in
listDatasets
▸ listDatasets(params?): AsyncGenerator<DatasetEntry>
Parameters
| Name | Type |
|---|---|
params? |
Object |
params.credentials? |
Credentials |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
params.hubUrl? |
string |
params.search? |
Object |
params.search.owner? |
string |
Returns
AsyncGenerator<DatasetEntry>
Defined in
hub/src/lib/list-datasets.ts:20
listFiles
▸ listFiles(params): AsyncGenerator<ListFileEntry>
List files in a folder. To list ALL files in the directory, call it
with params.recursive set to true.
Parameters
| Name | Type | Description |
|---|---|---|
params |
Object |
- |
params.credentials? |
Credentials |
- |
params.expand? |
boolean |
Fetch lastCommit and securityStatus for each file. |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
Custom fetch function to use instead of the default one, for example to use a proxy or edit headers. |
params.hubUrl? |
string |
- |
params.path? |
string |
Eg ‘data’ for listing all files in the ‘data’ folder. Leave it empty to list all files in the repo. |
params.recursive? |
boolean |
Do we want to list files in subdirectories? |
params.repo |
RepoDesignation |
- |
params.revision? |
string |
- |
Returns
AsyncGenerator<ListFileEntry>
Defined in
listModels
▸ listModels(params?): AsyncGenerator<ModelEntry>
Parameters
| Name | Type |
|---|---|
params? |
Object |
params.credentials? |
Credentials |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
params.hubUrl? |
string |
params.search? |
Object |
params.search.owner? |
string |
params.search.task? |
Task |
Returns
AsyncGenerator<ModelEntry>
Defined in
listSpaces
▸ listSpaces(params?): AsyncGenerator<SpaceEntry>
Parameters
| Name | Type |
|---|---|
params? |
Object |
params.credentials? |
Credentials |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
params.hubUrl? |
string |
params.search? |
Object |
params.search.owner? |
string |
Returns
AsyncGenerator<SpaceEntry>
Defined in
parseSafetensorsMetadata
▸ parseSafetensorsMetadata(params): Promise<SetRequired<SafetensorsParseFromRepo, "parameterCount">>
Analyze model.safetensors.index.json or model.safetensors from a model hosted on Model Database using smart range requests to extract its metadata.
Parameters
| Name | Type | Description |
|---|---|---|
params |
Object |
- |
params.computeParametersCount |
true |
Will include SafetensorsParseFromRepo[“parameterCount”], an object containing the number of parameters for each DType Default false |
params.credentials? |
Credentials |
- |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
Custom fetch function to use instead of the default one, for example to use a proxy or edit headers. |
params.hubUrl? |
string |
- |
params.repo |
RepoDesignation |
Only models are supported |
params.revision? |
string |
- |
Returns
Promise<SetRequired<SafetensorsParseFromRepo, "parameterCount">>
Defined in
hub/src/lib/parse-safetensors-metadata.ts:134
▸ parseSafetensorsMetadata(params): Promise<SafetensorsParseFromRepo>
Parameters
| Name | Type | Description |
|---|---|---|
params |
Object |
- |
params.computeParametersCount? |
boolean |
Will include SafetensorsParseFromRepo[“parameterCount”], an object containing the number of parameters for each DType Default false |
params.credentials? |
Credentials |
- |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
Custom fetch function to use instead of the default one, for example to use a proxy or edit headers. |
params.hubUrl? |
string |
- |
params.repo |
RepoDesignation |
Only models are supported |
params.revision? |
string |
- |
Returns
Promise<SafetensorsParseFromRepo>
Defined in
hub/src/lib/parse-safetensors-metadata.ts:151
uploadFile
▸ uploadFile(params): Promise<CommitOutput>
Parameters
| Name | Type |
|---|---|
params |
Object |
params.branch? |
string |
params.commitDescription? |
string |
params.commitTitle? |
string |
params.credentials |
Credentials |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
params.file |
URL | File | { content: ContentSource ; path: string } |
params.hubUrl? |
string |
params.isPullRequest? |
boolean |
params.parentCommit? |
string |
params.repo |
RepoDesignation |
Returns
Promise<CommitOutput>
Defined in
uploadFiles
▸ uploadFiles(params): Promise<CommitOutput>
Parameters
| Name | Type |
|---|---|
params |
Object |
params.branch? |
string |
params.commitDescription? |
string |
params.commitTitle? |
string |
params.credentials |
Credentials |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
params.files |
(URL | File | { content: ContentSource ; path: string })[] |
params.hubUrl? |
string |
params.isPullRequest? |
boolean |
params.parentCommit? |
string |
params.repo |
RepoDesignation |
Returns
Promise<CommitOutput>
Defined in
whoAmI
▸ whoAmI(params): Promise<WhoAmI & { auth: AuthInfo }>
Parameters
| Name | Type |
|---|---|
params |
Object |
params.credentials |
Credentials |
params.fetch? |
(input: URL | RequestInfo, init?: RequestInit) => Promise<Response> |
params.hubUrl? |
string |
Returns
Promise<WhoAmI & { auth: AuthInfo }>