Ƭ AccessToken: string
Actually hf_${string}, but for convenience, using the string type
packages/hub/src/types/public.ts:15
Ƭ AccessTokenRole: "admin" | "write" | "contributor" | "read"
packages/hub/src/types/public.ts:70
Ƭ AuthType: "access_token" | "app_token" | "app_token_as_user"
packages/hub/src/types/public.ts:72
Ƭ CommitOperation: CommitDeletedEntry | CommitFile
packages/hub/src/lib/commit.ts:54
Ƭ CommitParams: { abortSignal?: AbortSignal ; branch?: string ; description?: string ; fetch?: typeof __type ; hubUrl?: string ; isPullRequest?: boolean ; maxFolderDepth?: number ; operations: CommitOperation[] ; parentCommit?: string ; repo: RepoDesignation ; title: string ; useWebWorkers?: boolean | { minSize?: number ; poolSize?: number } } & Partial\<CredentialsParams>
packages/hub/src/lib/commit.ts:57
Ƭ CommitProgressEvent: { event: "phase" ; phase: "preuploading" | "uploadingLargeFiles" | "committing" } | { event: "fileProgress" ; path: string ; progress: number ; state: "hashing" | "uploading" }
packages/hub/src/lib/commit.ts:112
Ƭ ContentSource: Blob | URL
packages/hub/src/lib/commit.ts:35
Ƭ Dtype: "F64" | "F32" | "F16" | "F8_E4M3" | "F8_E5M2" | "BF16" | "I64" | "I32" | "I16" | "I8" | "U16" | "U8" | "BOOL"
packages/hub/src/lib/parse-safetensors-metadata.ts:45
Ƭ PipelineType: keyof typeof PIPELINE_DATA
packages/tasks/dist/commonjs/pipelines.d.ts:437
Ƭ RepoDesignation: RepoId | RepoFullName
packages/hub/src/types/public.ts:12
Ƭ RepoFullName: string | `spaces/${string}` | `datasets/${string}`
packages/hub/src/types/public.ts:10
Ƭ RepoType: "space" | "dataset" | "model"
packages/hub/src/types/public.ts:3
Ƭ SafetensorsFileHeader: Record\<TensorName, TensorInfo> & { __metadata__: { total_parameters?: string | number } & Record\<string, string> }
packages/hub/src/lib/parse-safetensors-metadata.ts:66
Ƭ SafetensorsParseFromRepo: { header: SafetensorsFileHeader ; parameterCount?: Partial\<Record\<Dtype, number>> ; parameterTotal?: number ; sharded: false } | { headers: SafetensorsShardedHeaders ; index: SafetensorsIndexJson ; parameterCount?: Partial\<Record\<Dtype, number>> ; parameterTotal?: number ; sharded: true }
packages/hub/src/lib/parse-safetensors-metadata.ts:80
Ƭ SafetensorsShardedHeaders: Record\<FileName, SafetensorsFileHeader>
packages/hub/src/lib/parse-safetensors-metadata.ts:78
Ƭ SpaceHardwareFlavor: "cpu-basic" | "cpu-upgrade" | "t4-small" | "t4-medium" | "l4x1" | "l4x4" | "a10g-small" | "a10g-large" | "a10g-largex2" | "a10g-largex4" | "a100-large" | "v5e-1x1" | "v5e-2x2" | "v5e-2x4"
packages/hub/src/types/public.ts:40
Ƭ SpaceSdk: "streamlit" | "gradio" | "docker" | "static"
packages/hub/src/types/public.ts:56
Ƭ SpaceStage: "NO_APP_FILE" | "CONFIG_ERROR" | "BUILDING" | "BUILD_ERROR" | "RUNNING" | "RUNNING_BUILDING" | "RUNTIME_ERROR" | "DELETING" | "PAUSED" | "SLEEPING"
packages/hub/src/types/public.ts:58
Ƭ TensorName: string
packages/hub/src/lib/parse-safetensors-metadata.ts:44
Ƭ WhoAmI: WhoAmIApp | WhoAmIOrg | WhoAmIUser
packages/hub/src/lib/who-am-i.ts:50
• Const DATASET_EXPANDABLE_KEYS: readonly ["author", "cardData", "citation", "createdAt", "disabled", "description", "downloads", "downloadsAllTime", "gated", "gitalyUid", "lastModified", "likes", "paperswithcode_id", "private", "sha", "tags"]
packages/hub/src/lib/list-datasets.ts:17
• Const DATASET_EXPAND_KEYS: readonly ["private", "downloads", "gated", "likes", "lastModified"]
packages/hub/src/lib/list-datasets.ts:9
• Const DEFAULT_REVISION: "main"
packages/hub/src/lib/snapshot-download.ts:12
• Const HUB_URL: "https://huggingface.co"
• Const MODEL_EXPANDABLE_KEYS: readonly ["author", "cardData", "config", "createdAt", "disabled", "downloads", "downloadsAllTime", "gated", "gitalyUid", "inferenceProviderMapping", "lastModified", "library_name", "likes", "model-index", "pipeline_tag", "private", "safetensors", "sha", "spaces", "tags", "transformersInfo"]
packages/hub/src/lib/list-models.ts:19
• Const MODEL_EXPAND_KEYS: readonly ["pipeline_tag", "private", "gated", "downloads", "likes", "lastModified"]
packages/hub/src/lib/list-models.ts:10
• Const REGEX_COMMIT_HASH: RegExp
packages/hub/src/lib/download-file-to-cache-dir.ts:15
• Const REPO_ID_SEPARATOR: string = "--"
packages/hub/src/lib/cache-management.ts:25
• Const RE_SAFETENSORS_FILE: RegExp
packages/hub/src/lib/parse-safetensors-metadata.ts:14
• Const RE_SAFETENSORS_INDEX_FILE: RegExp
packages/hub/src/lib/parse-safetensors-metadata.ts:15
• Const RE_SAFETENSORS_SHARD_FILE: RegExp
packages/hub/src/lib/parse-safetensors-metadata.ts:16
• Const SAFETENSORS_FILE: "model.safetensors"
packages/hub/src/lib/parse-safetensors-metadata.ts:10
• Const SAFETENSORS_INDEX_FILE: "model.safetensors.index.json"
packages/hub/src/lib/parse-safetensors-metadata.ts:11
• Const SPACE_EXPANDABLE_KEYS: readonly ["author", "cardData", "datasets", "disabled", "gitalyUid", "lastModified", "createdAt", "likes", "private", "runtime", "sdk", "sha", "subdomain", "tags", "models"]
packages/hub/src/lib/list-spaces.ts:15
• Const SPACE_EXPAND_KEYS: readonly ["sdk", "likes", "private", "lastModified"]
packages/hub/src/lib/list-spaces.ts:9
▸ __internal_sha256(buffer, opts?): AsyncGenerator\<number, string>
| Name | Type |
|---|---|
buffer | Blob |
opts? | Object |
opts.abortSignal? | AbortSignal |
opts.useWebWorker? | boolean | { minSize?: number ; poolSize?: number } |
AsyncGenerator\<number, string>
hex-encoded sha
Yields
progress (0-1)
packages/hub/src/utils/sha256.ts:72
▸ checkRepoAccess(params): Promise\<void>
Check if we have read access to a repository.
Throw a HubApiError error if we don’t have access. HubApiError.statusCode will be 401, 403 or 404.
| Name | Type |
|---|---|
params | { fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; repo: RepoDesignation } & Partial\<CredentialsParams> |
Promise\<void>
packages/hub/src/lib/check-repo-access.ts:13
▸ commit(params): Promise\<CommitOutput>
| Name | Type |
|---|---|
params | CommitParams |
Promise\<CommitOutput>
packages/hub/src/lib/commit.ts:565
▸ commitIter(params): AsyncGenerator\<CommitProgressEvent, CommitOutput>
Internal function for now, used by commit.
Can be exposed later to offer fine-tuned progress info
| Name | Type |
|---|---|
params | CommitParams |
AsyncGenerator\<CommitProgressEvent, CommitOutput>
packages/hub/src/lib/commit.ts:129
▸ countCommits(params): Promise\<number>
| Name | Type |
|---|---|
params | { fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; repo: RepoDesignation ; revision?: string } & Partial\<CredentialsParams> |
Promise\<number>
packages/hub/src/lib/count-commits.ts:7
▸ createBranch(params): Promise\<void>
| Name | Type | Description |
|---|---|---|
params | Object | - |
params.accessToken? | string | - |
params.branch | string | The name of the branch to create |
params.empty? | boolean | Use this to create an empty branch, with no commits. |
params.fetch? | (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> | MDN Reference |
params.hubUrl? | string | - |
params.overwrite? | boolean | Use this to overwrite the branch if it already exists. If you only specify overwrite and no revision/empty, and the branch already exists, it will be a no-op. |
params.repo | RepoDesignation | - |
params.revision? | string | Revision to create the branch from. Defaults to the default branch. Use empty: true to create an empty branch. |
Promise\<void>
packages/hub/src/lib/create-branch.ts:6
▸ createRepo(params): Promise\<{ repoUrl: string }>
| Name | Type |
|---|---|
params | { fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; files?: { content: ArrayBuffer | Blob ; path: string }[] ; hubUrl?: string ; license?: string ; private?: boolean ; repo: RepoDesignation ; sdk?: SpaceSdk | undefined } & CredentialsParams |
Promise\<{ repoUrl: string }>
packages/hub/src/lib/create-repo.ts:9
▸ datasetInfo\<T>(params): Promise\<DatasetEntry & Pick\<ApiDatasetInfo, T>>
| Name | Type |
|---|---|
T | extends "author" | "cardData" | "disabled" | "gitalyUid" | "createdAt" | "tags" | "paperswithcode_id" | "sha" | "citation" | "description" | "downloadsAllTime" = never |
| Name | Type |
|---|---|
params | { additionalFields?: T[] ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; name: string ; revision?: string } & Partial\<CredentialsParams> |
Promise\<DatasetEntry & Pick\<ApiDatasetInfo, T>>
packages/hub/src/lib/dataset-info.ts:9
▸ deleteBranch(params): Promise\<void>
| Name | Type | Description |
|---|---|---|
params | Object | - |
params.accessToken? | string | - |
params.branch | string | The name of the branch to delete |
params.fetch? | (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> | MDN Reference |
params.hubUrl? | string | - |
params.repo | RepoDesignation | - |
Promise\<void>
packages/hub/src/lib/delete-branch.ts:6
▸ deleteFile(params): Promise\<CommitOutput>
| Name | Type |
|---|---|
params | { branch?: string ; commitDescription?: string ; commitTitle?: string ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; isPullRequest?: boolean ; parentCommit?: string ; path: string ; repo: RepoDesignation } & CredentialsParams |
Promise\<CommitOutput>
packages/hub/src/lib/delete-file.ts:5
▸ deleteFiles(params): Promise\<CommitOutput>
| Name | Type |
|---|---|
params | { branch?: string ; commitDescription?: string ; commitTitle?: string ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; isPullRequest?: boolean ; parentCommit?: string ; paths: string[] ; repo: RepoDesignation } & CredentialsParams |
Promise\<CommitOutput>
packages/hub/src/lib/delete-files.ts:5
▸ deleteRepo(params): Promise\<void>
| Name | Type |
|---|---|
params | { fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; repo: RepoDesignation } & CredentialsParams |
Promise\<void>
packages/hub/src/lib/delete-repo.ts:7
▸ downloadFile(params): Promise\<Blob | null>
| Name | Type |
|---|---|
params | { downloadInfo?: FileDownloadInfoOutput ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; path: string ; raw?: boolean ; repo: RepoDesignation ; revision?: string ; xet?: boolean } & Partial\<CredentialsParams> |
Promise\<Blob | null>
null when the file doesn’t exist
packages/hub/src/lib/download-file.ts:11
▸ downloadFileToCacheDir(params): Promise\<string>
Download a given file if it’s not already present in the local cache.
| Name | Type |
|---|---|
params | { cacheDir?: string ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; path: string ; raw?: boolean ; repo: RepoDesignation ; revision?: string } & Partial\<CredentialsParams> |
Promise\<string>
the symlink to the blob object
packages/hub/src/lib/download-file-to-cache-dir.ts:45
▸ fileDownloadInfo(params): Promise\<FileDownloadInfoOutput | null>
| Name | Type |
|---|---|
params | { fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; noContentDisposition?: boolean ; path: string ; raw?: boolean ; repo: RepoDesignation ; revision?: string } & Partial\<CredentialsParams> |
Promise\<FileDownloadInfoOutput | null>
null when the file doesn’t exist
packages/hub/src/lib/file-download-info.ts:27
▸ fileExists(params): Promise\<boolean>
| Name | Type |
|---|---|
params | { fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; path: string ; repo: RepoDesignation ; revision?: string } & Partial\<CredentialsParams> |
Promise\<boolean>
packages/hub/src/lib/file-exists.ts:7
▸ getBlobStat(blobPath, blobStats): Promise\<Stats>
| Name | Type |
|---|---|
blobPath | string |
blobStats | Map\<string, Stats> |
Promise\<Stats>
packages/hub/src/lib/cache-management.ts:244
▸ getHFHubCachePath(): string
string
packages/hub/src/lib/cache-management.ts:19
▸ getRepoFolderName(«destructured»): string
| Name | Type |
|---|---|
«destructured» | RepoId |
string
packages/hub/src/lib/cache-management.ts:27
▸ listCommits(params): AsyncGenerator\<CommitData>
| Name | Type |
|---|---|
params | { batchSize?: number ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; repo: RepoDesignation ; revision?: string } & Partial\<CredentialsParams> |
AsyncGenerator\<CommitData>
packages/hub/src/lib/list-commits.ts:17
▸ listDatasets\<T>(params?): AsyncGenerator\<DatasetEntry & Pick\<ApiDatasetInfo, T>>
| Name | Type |
|---|---|
T | extends "author" | "cardData" | "disabled" | "gitalyUid" | "createdAt" | "tags" | "paperswithcode_id" | "sha" | "citation" | "description" | "downloadsAllTime" = never |
| Name | Type |
|---|---|
params? | { search?: { query?: string | undefined; owner?: string | undefined; tags?: string[] | undefined; } | undefined; hubUrl?: string | undefined; additionalFields?: T[] | undefined; limit?: number | undefined; fetch?: { …; } | undefined; } & Partial\<…> |
AsyncGenerator\<DatasetEntry & Pick\<ApiDatasetInfo, T>>
packages/hub/src/lib/list-datasets.ts:47
▸ listFiles(params): AsyncGenerator\<ListFileEntry>
List files in a folder. To list ALL files in the directory, call it
with params.recursive set to true.
| Name | Type |
|---|---|
params | { expand?: boolean ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; path?: string ; recursive?: boolean ; repo: RepoDesignation ; revision?: string } & Partial\<CredentialsParams> |
AsyncGenerator\<ListFileEntry>
packages/hub/src/lib/list-files.ts:42
▸ listModels\<T>(params?): AsyncGenerator\<ModelEntry & Pick\<ApiModelInfo, T>>
| Name | Type |
|---|---|
T | extends "spaces" | "author" | "cardData" | "disabled" | "gitalyUid" | "createdAt" | "tags" | "sha" | "downloadsAllTime" | "config" | "inferenceProviderMapping" | "library_name" | "model-index" | "safetensors" | "transformersInfo" = never |
| Name | Type |
|---|---|
params? | { search?: { query?: string | undefined; owner?: string | undefined; task?: “other” | “text-classification” | “token-classification” | “table-question-answering” | “question-answering” | … 50 more … | undefined; tags?: string[] | undefined; inferenceProviders?: string[] | undefined; } | undefined; hubUrl?: strin… |
AsyncGenerator\<ModelEntry & Pick\<ApiModelInfo, T>>
packages/hub/src/lib/list-models.ts:55
▸ listSpaces\<T>(params?): AsyncGenerator\<SpaceEntry & Pick\<ApiSpaceInfo, T>>
| Name | Type |
|---|---|
T | extends "models" | "datasets" | "author" | "cardData" | "disabled" | "gitalyUid" | "createdAt" | "tags" | "sha" | "subdomain" | "runtime" = never |
| Name | Type |
|---|---|
params? | { search?: { query?: string | undefined; owner?: string | undefined; tags?: string[] | undefined; } | undefined; hubUrl?: string | undefined; fetch?: { (input: URL | RequestInfo, init?: RequestInit | undefined): Promise\<…>; (input: string | … 1 more … | Request, init?: RequestInit | undefined): Promise\<…>; }… |
AsyncGenerator\<SpaceEntry & Pick\<ApiSpaceInfo, T>>
packages/hub/src/lib/list-spaces.ts:44
▸ modelInfo\<T>(params): Promise\<ModelEntry & Pick\<ApiModelInfo, T>>
| Name | Type |
|---|---|
T | extends "spaces" | "author" | "cardData" | "disabled" | "gitalyUid" | "createdAt" | "tags" | "sha" | "downloadsAllTime" | "config" | "inferenceProviderMapping" | "library_name" | "model-index" | "safetensors" | "transformersInfo" = never |
| Name | Type |
|---|---|
params | { additionalFields?: T[] ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; name: string ; revision?: string } & Partial\<CredentialsParams> |
Promise\<ModelEntry & Pick\<ApiModelInfo, T>>
packages/hub/src/lib/model-info.ts:10
▸ oauthHandleRedirect(opts?): Promise\<OAuthResult>
To call after the OAuth provider redirects back to the app.
There is also a helper function oauthHandleRedirectIfPresent, which will call oauthHandleRedirect if the URL contains an oauth code
in the query parameters and return false otherwise.
| Name | Type | Description |
|---|---|---|
opts? | Object | - |
opts.codeVerifier? | string | codeVerifier generated by oauthLoginUrl Default ts localStorage.getItem("huggingface.co:oauth:code_verifier") |
opts.hubUrl? | string | The URL of the hub. Defaults to HUB_URL. |
opts.nonce? | string | nonce generated by oauthLoginUrl Default ts localStorage.getItem("huggingface.co:oauth:nonce") |
opts.redirectedUrl? | string | The URL to analyze. Default ts window.location.href |
Promise\<OAuthResult>
packages/hub/src/lib/oauth-handle-redirect.ts:114
▸ oauthHandleRedirectIfPresent(opts?): Promise\<OAuthResult | false>
To call after the OAuth provider redirects back to the app.
It returns false if the URL does not contain an oauth code in the query parameters, otherwise it calls oauthHandleRedirect.
Depending on your app, you may want to call oauthHandleRedirect directly instead.
| Name | Type | Description |
|---|---|---|
opts? | Object | - |
opts.codeVerifier? | string | codeVerifier generated by oauthLoginUrl Default ts localStorage.getItem("huggingface.co:oauth:code_verifier") |
opts.hubUrl? | string | The URL of the hub. Defaults to HUB_URL. |
opts.nonce? | string | nonce generated by oauthLoginUrl Default ts localStorage.getItem("huggingface.co:oauth:nonce") |
opts.redirectedUrl? | string | The URL to analyze. Default ts window.location.href |
Promise\<OAuthResult | false>
packages/hub/src/lib/oauth-handle-redirect.ts:284
▸ oauthLoginUrl(opts?): Promise\<string>
Use “Sign in with Hub” to authenticate a user, and get oauth user info / access token.
Returns an url to redirect to. After the user is redirected back to your app, call oauthHandleRedirect to get the oauth user info / access token.
When called from inside a static Space with OAuth enabled, it will load the config from the space, otherwise you need to at least specify the client ID of your OAuth App.
| Name | Type | Description |
|---|---|---|
opts? | Object | - |
opts.clientId? | string | OAuth client ID. For static Spaces, you can omit this and it will be loaded from the Space config, as long as hf_oauth: true is present in the README.md’s metadata. For other Spaces, it is available to the backend in the OAUTH_CLIENT_ID environment variable, as long as hf_oauth: true is present in the README.md’s metadata. You can also create a Developer Application at https://huggingface.co/settings/connected-applications and use its client ID. |
opts.hubUrl? | string | - |
opts.localStorage? | Object | If provided, will be filled with the code verifier and nonce used for the OAuth flow, instead of using localStorage. When calling oauthHandleRedirectIfPresent or oauthHandleRedirect you will need to provide the same values. |
opts.localStorage.codeVerifier? | string | - |
opts.localStorage.nonce? | string | - |
opts.redirectUrl? | string | Redirect URI, defaults to the current URL. For Spaces, any URL within the Space is allowed. For Developer Applications, you can add any URL you want to the list of allowed redirect URIs at https://huggingface.co/settings/connected-applications. |
opts.scopes? | string | OAuth scope, a list of space-separated scopes. For static Spaces, you can omit this and it will be loaded from the Space config, as long as hf_oauth: true is present in the README.md’s metadata. For other Spaces, it is available to the backend in the OAUTH_SCOPES environment variable, as long as hf_oauth: true is present in the README.md’s metadata. Defaults to “openid profile”. You can also create a Developer Application at https://huggingface.co/settings/connected-applications and use its scopes. See https://huggingface.co/docs/hub/oauth for a list of available scopes. |
opts.state? | string | State to pass to the OAuth provider, which will be returned in the call to oauthLogin after the redirect. |
Promise\<string>
Example
import { oauthLoginUrl, oauthHandleRedirectIfPresent } from "@huggingface/hub";
const oauthResult = await oauthHandleRedirectIfPresent();
if (!oauthResult) {
// If the user is not logged in, redirect to the login page
window.location.href = await oauthLoginUrl();
}
// You can use oauthResult.accessToken, oauthResult.accessTokenExpiresAt and oauthResult.userInfo
console.log(oauthResult);(Theoretically, this function could be used to authenticate a user for any OAuth provider supporting PKCE and OpenID Connect by changing hubUrl,
but it is currently only tested with the Hugging Face Hub.)
packages/hub/src/lib/oauth-login-url.ts:31
▸ parseRepoType(type): RepoType
| Name | Type |
|---|---|
type | string |
packages/hub/src/lib/cache-management.ts:254
▸ parseSafetensorsMetadata(params): Promise\<SetRequired\<SafetensorsParseFromRepo, "parameterCount">>
Analyze model.safetensors.index.json or model.safetensors from a model hosted on Hugging Face using smart range requests to extract its metadata.
| Name | Type |
|---|---|
params | { computeParametersCount: true ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; path?: string ; repo: RepoDesignation ; revision?: string } & Partial\<CredentialsParams> |
Promise\<SetRequired\<SafetensorsParseFromRepo, "parameterCount">>
packages/hub/src/lib/parse-safetensors-metadata.ts:195
▸ parseSafetensorsMetadata(params): Promise\<SafetensorsParseFromRepo>
| Name | Type |
|---|---|
params | { computeParametersCount?: boolean ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; path?: string ; repo: RepoDesignation ; revision?: string } & Partial\<CredentialsParams> |
Promise\<SafetensorsParseFromRepo>
packages/hub/src/lib/parse-safetensors-metadata.ts:217
▸ parseSafetensorsShardFilename(filename): SafetensorsShardFileInfo | null
| Name | Type |
|---|---|
filename | string |
SafetensorsShardFileInfo | null
packages/hub/src/lib/parse-safetensors-metadata.ts:24
▸ pathsInfo(params): Promise\<PathInfo & { lastCommit: CommitInfo ; securityFileStatus: SecurityFileStatus }[]>
| Name | Type |
|---|---|
params | { expand: true ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; paths: string[] ; repo: RepoDesignation ; revision?: string } & Partial\<CredentialsParams> |
Promise\<PathInfo & { lastCommit: CommitInfo ; securityFileStatus: SecurityFileStatus }[]>
packages/hub/src/lib/paths-info.ts:37
▸ pathsInfo(params): Promise\<PathInfo[]>
| Name | Type |
|---|---|
params | { expand?: boolean ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; paths: string[] ; repo: RepoDesignation ; revision?: string } & Partial\<CredentialsParams> |
Promise\<PathInfo[]>
packages/hub/src/lib/paths-info.ts:50
▸ repoExists(params): Promise\<boolean>
| Name | Type | Description |
|---|---|---|
params | Object | - |
params.accessToken? | string | - |
params.fetch? | (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, 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 | - |
params.revision? | string | An optional Git revision id which can be a branch name, a tag, or a commit hash. |
Promise\<boolean>
packages/hub/src/lib/repo-exists.ts:6
▸ scanCacheDir(cacheDir?): Promise\<HFCacheInfo>
| Name | Type | Default value |
|---|---|---|
cacheDir | undefined | string | undefined |
Promise\<HFCacheInfo>
packages/hub/src/lib/cache-management.ts:72
▸ scanCachedRepo(repoPath): Promise\<CachedRepoInfo>
| Name | Type |
|---|---|
repoPath | string |
Promise\<CachedRepoInfo>
packages/hub/src/lib/cache-management.ts:114
▸ scanRefsDir(refsPath, refsByHash): Promise\<void>
| Name | Type |
|---|---|
refsPath | string |
refsByHash | Map\<string, string[]> |
Promise\<void>
packages/hub/src/lib/cache-management.ts:204
▸ scanSnapshotDir(revisionPath, cachedFiles, blobStats): Promise\<void>
| Name | Type |
|---|---|
revisionPath | string |
cachedFiles | CachedFileInfo[] |
blobStats | Map\<string, Stats> |
Promise\<void>
packages/hub/src/lib/cache-management.ts:219
▸ snapshotDownload(params): Promise\<string>
Downloads an entire repository at a given revision in the cache directory getHFHubCachePath. You can list all cached repositories using scanCachedRepo
| Name | Type |
|---|---|
params | { cacheDir?: string ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; repo: RepoDesignation ; revision?: string } & Partial\<CredentialsParams> |
Promise\<string>
Remarks
It uses internally downloadFileToCacheDir.
packages/hub/src/lib/snapshot-download.ts:19
▸ spaceInfo\<T>(params): Promise\<SpaceEntry & Pick\<ApiSpaceInfo, T>>
| Name | Type |
|---|---|
T | extends "models" | "datasets" | "author" | "cardData" | "disabled" | "gitalyUid" | "createdAt" | "tags" | "sha" | "subdomain" | "runtime" = never |
| Name | Type |
|---|---|
params | { additionalFields?: T[] ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string ; name: string ; revision?: string } & Partial\<CredentialsParams> |
Promise\<SpaceEntry & Pick\<ApiSpaceInfo, T>>
packages/hub/src/lib/space-info.ts:10
▸ uploadFile(params): Promise\<CommitOutput>
| Name | Type |
|---|---|
params | { abortSignal?: AbortSignal ; branch?: string ; commitDescription?: string ; commitTitle?: string ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; file: URL | File | { content: ContentSource ; path: string } ; hubUrl?: string ; isPullRequest?: boolean ; parentCommit?: string ; repo: RepoDesignation ; useWebWorkers?: boolean | { minSize?: number ; poolSize?: number } } & Partial\<CredentialsParams> |
Promise\<CommitOutput>
packages/hub/src/lib/upload-file.ts:5
▸ uploadFiles(params): Promise\<CommitOutput>
| Name | Type |
|---|---|
params | { abortSignal?: AbortSignal ; branch?: string ; commitDescription?: string ; commitTitle?: string ; fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; files: (URL | File | { content: ContentSource ; path: string })[] ; hubUrl?: string ; isPullRequest?: boolean ; maxFolderDepth?: number ; parentCommit?: string ; repo: RepoDesignation ; useWebWorkers?: boolean | { minSize?: number ; poolSize?: number } } & Partial\<CredentialsParams> |
Promise\<CommitOutput>
packages/hub/src/lib/upload-files.ts:5
▸ uploadFilesWithProgress(params): AsyncGenerator\<CommitProgressEvent, CommitOutput>
Uploads with progress
Needs XMLHttpRequest to be available for progress events for uploads Set useWebWorkers to true in order to have progress events for hashing
| Name | Type |
|---|---|
params | { abortSignal?: AbortSignal ; branch?: string ; commitDescription?: string ; commitTitle?: string ; files: (URL | File | { content: ContentSource ; path: string })[] ; hubUrl?: string ; isPullRequest?: boolean ; maxFolderDepth?: number ; parentCommit?: string ; repo: RepoDesignation ; useWebWorkers?: boolean | { minSize?: number ; poolSize?: number } } & Partial\<CredentialsParams> |
AsyncGenerator\<CommitProgressEvent, CommitOutput>
packages/hub/src/lib/upload-files-with-progress.ts:20
▸ whoAmI(params): Promise\<WhoAmI & { auth: AuthInfo }>
| Name | Type |
|---|---|
params | { fetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise\<Response>(input: string | URL | Request, init?: RequestInit) => Promise\<Response> ; hubUrl?: string } & CredentialsParams |
Promise\<WhoAmI & { auth: AuthInfo }>
packages/hub/src/lib/who-am-i.ts:61
< > Update on GitHub