@huggingface/hub

Các lớp

• HubApiError
• InvalidApiResponseFormatError
• JsonStreamParseError
• SafetensorParseError
• __internal_XetBlob

Giao diện

• AuthInfo
• CachedFileInfo
• CachedRepoInfo
• CachedRevisionInfo
• CommitCopyFile
• CommitData
• CommitDeletedEntry
• CommitEditFile
• CommitEditFileParams
• CommitFile
• CommitInfo
• CommitOutput
• CopyDestination
• CopyFilesEntry
• CopyProgressEvent
• Sao chép mã nguồn
• Thông tin xác thực
• DatasetEntry
• FileDownloadInfoOutput
• HFCacheInfo
• JobVolume
• LfsPathInfo
• ListFileEntry
• MlxQuantizationConfig
• ModelConfig
• ModelDerivedFields
• ModelEntry
• OAuthResult
• ParallelDownloadOptions
• PathInfo
• QuantizationConfig
• RangeEditCacheEntry
• RepoId
• SafetensorsIndexJson
• SafetensorsShardFileInfo
• SecurityFileStatus
• SpaceEntry
• SpaceResourceConfig
• SpaceResourceRequirement
• SpaceRuntime
• TensorInfo
• UserInfo
• WhoAmIApp
• WhoAmIOrg
• WhoAmIUser
• XetFileInfo
• XetReadToken

Biệt danh kiểu

AccessToken

Ƭ AccessToken: string

Thực ra là hf_${string}, nhưng để tiện lợi, dùng kiểu chuỗi

Được định nghĩa trong

packages/hub/src/types/public.ts:28

AccessTokenRole

Ƭ AccessTokenRole: "admin" | "write" | "contributor" | "read"

Được định nghĩa trong

packages/hub/src/types/public.ts:98

AuthType

Ƭ AuthType: "access_token" | "app_token" | "app_token_as_user"

Được định nghĩa trong

packages/hub/src/types/public.ts:100

CommitOperation

Ƭ CommitOperation: CommitDeletedEntry | CommitFile | CommitEditFile | CommitCopyFile

Được định nghĩa trong

packages/hub/src/lib/commit.ts:124

CommitParams

Ƭ CommitParams: { abortSignal?: AbortSignal ; branch?: string ; description?: string ; fetch?: typeof __type ; hubUrl?: string ; isPullRequest?: boolean ; maxFolderDepth?: number ; operations: CommitOperation[] ; parentCommit?: string ; rangeEditCache?: RangeEditCache ; repo: RepoDesignation ; title: string ; useWebWorkers?: boolean | { minSize?: number ; poolSize?: number } ; useXet?: boolean } & Partial<CredentialsParams>

Được định nghĩa trong

packages/hub/src/lib/commit.ts:131

CommitProgressEvent

Ƭ CommitProgressEvent: { event: "phase" ; phase: "preuploading" | "uploadingLargeFiles" | "committing" } | { event: "fileProgress" ; path: string ; progress: number ; state: "hashing" | "uploading" | "error" }

Được định nghĩa trong

packages/hub/src/lib/commit.ts:201

ContentSource

Ƭ Nguồn nội dung: Blob | URL

Được định nghĩa trong

packages/hub/src/lib/commit.ts:45

Dtype

Ƭ Loại dữ liệu: "F64" | "F32" | "C64" | "F16" | "F8_E4M3" | "F8_E4M3FNUZ" | "F8_E5M2" | "F8_E5M2FNUZ" | "F8_E8M0" | "E8M0" | "F6_E3M2" | "F6_E2M3" | "F4" | "FP4" | "BF16" | "I64" | "U64" | "I32" | "U32" | "I16" | "I8" | "U16" | "U8" | "UE8" | "BOOL"

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:291

JsonStreamEvent

Ƭ JsonStreamEvent: { type: "startObject" } | { type: "endObject" } | { type: "startArray" } | { type: "endArray" } | { key: string ; type: "key" } | { type: "value" ; value: string | number | boolean | null }

Trình phân tích JSON theo kiểu SAX, tăng dần, tối giản và không phụ thuộc thư viện.

JSON.parse yêu cầu toàn bộ tài liệu phải nằm trong bộ nhớ hai lần (chuỗi nguồn + cây đối tượng kết quả), khiến nó không thể dùng được cho các tài liệu lớn nhưng phần nội dung quan trọng lại rất nhỏ — ví dụ như model.safetensors.index.json của một MoE lớn, trong đó weight_map 60 MB chỉ tồn tại để cho chúng ta biết ~100 tên tệp shard riêng biệt.

Trình phân tích này thay vào đó phát ra một luồng sự kiện phẳng khi các byte đến, cho phép người dùng chỉ giữ lại những gì cần thiết và để mọi thứ khác được thu gom rác. Mức sử dụng bộ nhớ bị giới hạn bởi kích thước của token riêng lẻ lớn nhất (chuỗi / số), chứ không phải bởi kích thước của tài liệu.

Cài đặt là một máy trạng thái có thể tiếp tục: bất kỳ token nào cũng có thể bị tách qua các ranh giới chunk (bao gồm các chuỗi UTF-8 nhiều byte và các escape \uXXXX).

Độ nghiêm ngặt: ngữ pháp được chấp nhận là RFC 8259 (giống với JSON.parse), trừ một vài kiểm tra sẽ tốn kém nhiều mà lợi ích không đáng kể ở đây — đáng chú ý là hình dạng số được xác thực bằng Number() thay vì bằng máy trạng thái, do đó một số đầu vào mà JSON.parse từ chối sẽ được chấp nhận. Mọi thứ mà JSON.parse chấp nhận đều được chấp nhận, với các giá trị giống hệt nhau.

Example

for await (const event of streamJson(blob.stream())) {
  if (event.type === "key") { ... }
}

Được định nghĩa trong

packages/hub/src/utils/streamJson.ts:27

ModelAdditionalField

Ƭ ModelAdditionalField: Exclude<typeof MODEL_EXPANDABLE_KEYS[number], typeof MODEL_EXPAND_KEYS[number]> | keyof ModelDerivedFields

Được định nghĩa trong

packages/hub/src/lib/list-models.ts:51

PipelineType

Ƭ PipelineType: keyof typeof PIPELINE_DATA

Được định nghĩa trong

packages/tasks/dist/commonjs/pipelines.d.ts:380

RangeEditCache

Ƭ RangeEditCache: Map<string, RangeEditCacheEntry>

Trạng thái trong bộ nhớ của một tệp đã được ghi trước đó thông qua đường dẫn chỉnh sửa theo khoảng, được lập chỉ mục theo xet hash của nó. Cho phép một thao tác append (hoặc chỉnh sửa term cuối cùng của tệp) sau đó bỏ qua hoàn toàn các cuộc gọi API reconstruction và file-chunk-hashes: trạng thái merkle một phần và các hash xác minh đã được biết trước.

Truyền cùng một instance RangeEditCache cho các lần gọi commit liên tiếp để thêm vào cùng một tệp, nhằm tránh việc gọi các API metadata CAS ở mỗi lần thêm.

Được định nghĩa trong

packages/hub/src/utils/rangeEdit.ts:16

RepoDesignation

Ƭ RepoDesignation: RepoId | RepoFullName

Được định nghĩa trong

packages/hub/src/types/public.ts:17

RepoFullName

Ƭ Tên đầy đủ của kho: string | `spaces/${string}` | `datasets/${string}` | `buckets/${string}` | `kernels/${string}`

Được định nghĩa trong

packages/hub/src/types/public.ts:10

RepoType

Ƭ RepoType: "space" | "dataset" | "model" | "bucket" | "kernel"

Được định nghĩa trong

packages/hub/src/types/public.ts:3

ResolveModelAdditionalFields

Ƭ ResolveModelAdditionalFields<T>: Pick<ApiModelInfo, T & keyof ApiModelInfo> & Pick<ModelDerivedFields, T & keyof ModelDerivedFields>

Tham số kiểu

Được định nghĩa trong

packages/hub/src/lib/list-models.ts:55

SafetensorsFileHeader

Ƭ SafetensorsFileHeader: Record<TensorName, TensorInfo> & { __metadata__?: { total_parameters?: string | number } & Record<string, string> }

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:324

SafetensorsParseFromRepo

Ƭ SafetensorsParseFromRepo: { filepaths: string[] ; header: SafetensorsFileHeader ; parameterCount?: Partial<Record<Dtype, number>> ; parameterTotal?: number ; sharded: false } | { filepaths: string[] ; headers: SafetensorsShardedHeaders ; index: SafetensorsIndexJson ; parameterCount?: Partial<Record<Dtype, number>> ; parameterTotal?: number ; sharded: true }

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:348

SafetensorsShardedHeaders

Ƭ SafetensorsShardedHeaders: Record<FileName, SafetensorsFileHeader>

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:346

SpaceHardwareFlavor

Ƭ SpaceHardwareFlavor: "cpu-basic" | "cpu-upgrade" | "cpu-performance" | "cpu-xl" | "sprx8" | "zero-a10g" | "inf2x6" | "t4-small" | "t4-medium" | "l4x1" | "l4x4" | "l40sx1" | "l40sx4" | "l40sx8" | "a10g-small" | "a10g-large" | "a10g-largex2" | "a10g-largex4" | "a100-large" | "a100x4" | "a100x8" | "h200" | "h200x2" | "h200x4" | "h200x8" | "rtx-pro-6000" | "rtx-pro-6000x2" | "rtx-pro-6000x4" | "rtx-pro-6000x8"

Được định nghĩa trong

packages/hub/src/types/public.ts:53

SpaceSdk

Ƭ SpaceSdk: "streamlit" | "gradio" | "docker" | "static"

Được định nghĩa trong

packages/hub/src/types/public.ts:84

SpaceStage

Ƭ SpaceStage: "NO_APP_FILE" | "CONFIG_ERROR" | "BUILDING" | "BUILD_ERROR" | "RUNNING" | "RUNNING_BUILDING" | "RUNTIME_ERROR" | "DELETING" | "PAUSED" | "SLEEPING"

Được định nghĩa trong

packages/hub/src/types/public.ts:86

TensorName

Ƭ Tên tensor: string

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:290

WhoAmI

Ƭ WhoAmI: WhoAmIApp | WhoAmIOrg | WhoAmIUser

Được định nghĩa trong

packages/hub/src/lib/who-am-i.ts:52

Biến

DATASET _ EXPANDABLE _ KEYS

• Const DATASET_EXPANDABLE_KEYS: chỉ đọc ["author", "cardData", "citation", "createdAt", "disabled", "description", "downloads", "downloadsAllTime", "gated", "gitalyUid", "lastModified", "likes", "paperswithcode_id", "private", "sha", "tags"]

Được định nghĩa trong

packages/hub/src/lib/list-datasets.ts:18

DATASET _ EXPAND _ KEYS

• Const DATASET_EXPAND_KEYS: chỉ đọc ["private", "downloads", "gated", "likes", "lastModified"]

Được định nghĩa trong

packages/hub/src/lib/list-datasets.ts:10

PHIÊN BẢN MẶC ĐỊNH

• Const DEFAULT_REVISION: "main"

Được định nghĩa trong

packages/hub/src/lib/snapshot-download.ts:13

DIFFUSERS _ SAFETENSORS _ TẬP TIN

• Const DIFFUSERS_SAFETENSORS_FILE: "diffusion_pytorch_model.safetensors"

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:21

DIFFUSERS _ SAFETENSORS _ INDEX _ FILE

• Const DIFFUSERS_SAFETENSORS_INDEX_FILE: "diffusion_pytorch_model.safetensors.index.json"

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:22

DIFFUSERS _ TRỌNG SỐ _ THƯ MỤC CON

• Const DIFFUSERS_WEIGHTS_SUBFOLDERS: chỉ đọc ["transformer", "unet"]

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:23

HUB _ URL

• Const HUB_URL: "https://huggingface.co"

URL gốc của Hugging Face Hub.

Được định nghĩa trong

packages/hub/src/consts.ts:4

MÔ HÌNH _ TRƯỜNG _ ĐẾN _ KHÓA _ API

• Const MODEL_DERIVED_FIELD_TO_API_KEY: Record<keyof ModelDerivedFields, keyof ApiModelInfo>

Được định nghĩa trong

packages/hub/src/lib/list-models.ts:47

MODEL _ EXPANDABLE _ KEYS

• Const MODEL_EXPANDABLE_KEYS: chỉ đọc ["author", "cardData", "config", "createdAt", "disabled", "downloads", "downloadsAllTime", "gated", "gitalyUid", "inferenceProviderMapping", "lastModified", "library_name", "likes", "model-index", "pipeline_tag", "private", "safetensors", "sha", "spaces", "tags", "transformersInfo"]

Được định nghĩa trong

packages/hub/src/lib/list-models.ts:19

MODEL _ EXPAND _ KEYS

• Const MODEL_EXPAND_KEYS: chỉ đọc ["pipeline_tag", "private", "gated", "downloads", "likes", "lastModified"]

Được định nghĩa trong

packages/hub/src/lib/list-models.ts:10

REGEX _ COMMIT _ HASH

• Const REGEX_COMMIT_HASH: RegExp

Được định nghĩa trong

packages/hub/src/lib/download-file-to-cache-dir.ts:16

REPO _ ID _ SEPARATOR

• Const REPO_ID_SEPARATOR: string = "--"

Được định nghĩa trong

packages/hub/src/lib/cache-management.ts:25

RE _ SAFETENSORS _ FILE

• Const RE_SAFETENSORS_FILE: RegExp

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:26

RE _ SAFETENSORS _ INDEX _ FILE

• Const RE_SAFETENSORS_INDEX_FILE: RegExp

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:27

RE _ SAFETENSORS _ SHARD _ FILE

• Const RE_SAFETENSORS_SHARD_FILE: RegExp

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:28

SAFETENSORS _ TẬP TIN

• Const SAFETENSORS_FILE: "model.safetensors"

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:17

TẬP TIN CHỈ MỤC SAFETENSORS

• Const SAFETENSORS_INDEX_FILE: "model.safetensors.index.json"

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:18

SPACE _ EXPANDABLE _ KEYS

• Const SPACE_EXPANDABLE_KEYS: chỉ đọc ["author", "cardData", "datasets", "disabled", "gitalyUid", "lastModified", "createdAt", "likes", "private", "runtime", "sdk", "sha", "subdomain", "tags", "models"]

Được định nghĩa trong

packages/hub/src/lib/list-spaces.ts:16

SPACE _ EXPAND _ KEYS

• Const SPACE_EXPAND_KEYS: chỉ đọc ["sdk", "likes", "private", "lastModified"]

Được định nghĩa trong

packages/hub/src/lib/list-spaces.ts:10

Hàm

_ _ nội bộ _ sha256

▸ __internal_sha256(buffer, opts?): AsyncGenerator<number, string>

Tham số

Trả về

AsyncGenerator<number, string>

sha mã hóa hex

Yields

tiến độ (0-1)

Được định nghĩa trong

packages/hub/src/utils/sha256.ts:72

assertSafeShardFilename

▸ assertSafeShardFilename(filename): void

Tên tệp trong weight_map được lấy từ tệp trong kho, do đó chúng do kẻ tấn công kiểm soát: chúng phải là đường dẫn tương đối nằm trong thư mục của chính chỉ mục.

Việc kiểm tra includes("..") theo nghĩa đen là chưa đủ, vì URL mà tên tệp cuối cùng nằm trong đó sẽ được phân tích bởi trình phân tích URL WHATWG sau khi kiểm tra, và trình phân tích này sẽ giải mã phần trăm cho các đoạn chấm: %2e%2e (hoặc .%2e, %2E%2E, …) là một đoạn .. đối với nó, do đó nó thoát khỏi kho — và với thông tin xác thực được đính kèm, yêu cầu sẽ được cấp quyền trên URL resolve của một kho khác.

Vì vậy, hãy giải mã trước khi xác thực (lặp lại để bắt %252e%252e), và từ chối bất kỳ thứ gì không phải là đường dẫn tương đối đơn giản.

Tham số

Trả về

void

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:511

cancelJob

▸ cancelJob(params): Promise<ApiJob>

Hủy một tác vụ.

Tham số

Trả về

Promise<ApiJob>

Được định nghĩa trong

packages/hub/src/lib/jobs/cancel-job.ts:11

checkRepoAccess

▸ checkRepoAccess(params): Promise<void>

Kiểm tra xem chúng ta có quyền đọc đối với một kho lưu trữ hay không.

Ném lỗi HubApiError nếu chúng ta không có quyền truy cập. HubApiError.statusCode sẽ là 401, 403 hoặc 404.

Tham số

Trả về

Promise<void>

Được định nghĩa trong

packages/hub/src/lib/check-repo-access.ts:14

commit

▸ commit(params): Promise<CommitOutput | undefined>

Tham số

Trả về

Promise<CommitOutput | undefined>

undefined cho các lượt tải lên bucket, CommitOutput trong các trường hợp khác

Được định nghĩa trong

packages/hub/src/lib/commit.ts:1032

commitIter

▸ commitIter(params): AsyncGenerator<CommitProgressEvent, CommitOutput | undefined>

Hàm nội bộ cho đến hiện tại, được sử dụng bởi commit.

Có thể được công bố sau đó để cung cấp thông tin chi tiết về tiến trình tinh chỉnh

CommitOutput không có sẵn cho các commit bucket

Tham số

Trả về

AsyncGenerator<CommitProgressEvent, CommitOutput | undefined>

Được định nghĩa trong

packages/hub/src/lib/commit.ts:220

commitIterBucket

▸ commitIterBucket(params): AsyncGenerator<CommitProgressEvent>

Tham số

Trả về

AsyncGenerator<CommitProgressEvent>

Được định nghĩa trong

packages/hub/src/lib/commit.ts:776

computeNumOfParamsByDtypeSingleFile

▸ computeNumOfParamsByDtypeSingleFile(header, quantConfig?, expertDtype?): Partial<Record<Dtype, number>>

Tổng hợp các tham số theo từng dtype cho phần header của một tệp, áp dụng các hệ số đóng gói lượng tử hóa và bỏ qua các tensor ghi sổ sách.

Tham số

Trả về

Partial<Record<Dtype, number>>

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:1379

copyFile

▸ copyFile(params): Promise<undefined>

Sao chép một tệp duy nhất từ kho/bucket nguồn sang bucket đích.

Bản sao được thực hiện phía máy chủ (không có chuyển dữ liệu) khi tệp nguồn được hỗ trợ bởi xet. Đối với các tệp kho nhỏ không phải xet (ví dụ: config.json), tệp sẽ được tải xuống và tải lên lại vào bucket đích trong cùng một commit.

Các tệp con trỏ LFS chưa được di chuyển sang xet sẽ bị từ chối ngay từ đầu (nếu không, chúng sẽ yêu cầu tải xuống toàn bộ blob LFS).

Tham số

Trả về

Promise<undefined>

Example

await copyFile({
  source: {
    repo: { type: "model", name: "username/my-model" },
    path: "model.safetensors",
  },
  destination: {
    repo: { type: "bucket", name: "username/my-bucket" },
    path: "models/my-model/model.safetensors",
  },
  accessToken: "hf_...",
});

Được định nghĩa trong

packages/hub/src/lib/copy-files.ts:111

copyFileIter

▸ copyFileIter(params): AsyncGenerator<CopyProgressEvent, undefined>

Biến thể async-iterator của copyFile, trả về các CopyProgressEvent trong khi tải xuống các tệp nguồn không phải xet (các tệp dựa trên xet được sao chép phía máy chủ và không phát ra sự kiện). Xem copyFile để biết chi tiết về ngữ nghĩa.

Tham số

Trả về

AsyncGenerator<CopyProgressEvent, undefined>

Example

for await (const event of copyFileIter({ source, destination, accessToken })) {
  console.log(`downloaded ${event.path} (${event.downloaded}/${event.total})`);
}

Được định nghĩa trong

packages/hub/src/lib/copy-files.ts:144

copyFiles

▸ copyFiles(params): Promise<undefined>

Sao chép nhiều tệp (có thể từ các kho/bucket nguồn khác nhau) vào bucket đích trong một lần commit duy nhất.

Đối với các tệp nguồn được hỗ trợ bởi xet, bản sao được thực hiện phía máy chủ mà không có chuyển dữ liệu. Đối với các tệp nguồn không phải xet (thường là các tệp repo nhỏ được lưu trữ trong git), tệp sẽ được tải xuống và tải lên lại như một phần của cùng một commit.

Các tệp con trỏ LFS chưa được di chuyển sang xet sẽ bị từ chối ngay từ đầu.

Tham số

Trả về

Promise<undefined>

Example

await copyFiles({
  destination: { type: "bucket", name: "username/my-bucket" },
  files: [
    {
      source: {
        repo: { type: "bucket", name: "username/other-bucket" },
        path: "data.bin",
      },
      destinationPath: "data.bin",
    },
    {
      source: {
        repo: { type: "model", name: "username/my-model" },
        path: "model.safetensors",
      },
      destinationPath: "models/my-model/model.safetensors",
    },
  ],
  accessToken: "hf_...",
});

Được định nghĩa trong

packages/hub/src/lib/copy-files.ts:199

copyFilesIter

▸ copyFilesIter(params): AsyncGenerator<CopyProgressEvent, undefined>

Biến thể async-iterator của copyFiles, trả về các CopyProgressEvent trong khi tải xuống các tệp nguồn không phải xet (các tệp dựa trên xet được sao chép phía máy chủ và không phát ra sự kiện). Xem copyFiles để biết chi tiết về ngữ nghĩa.

Tham số

Trả về

AsyncGenerator<CopyProgressEvent, undefined>

Được định nghĩa trong

packages/hub/src/lib/copy-files.ts:219

copyFolder

▸ copyFolder(params): Promise<undefined>

Sao chép một thư mục (đệ quy) từ kho/bucket nguồn sang bucket đích trong một commit duy nhất.

Đường dẫn từng tệp được phân giải tương đối với CopySource.path; thư mục nguồn bản thân nó không được giữ lại trong đích trừ khi CopyDestination.path giữ lại nó.

Tham số

Trả về

Promise<undefined>

Example

// Copy an entire dataset under "datasets/my-dataset/" in the bucket
await copyFolder({
  source: { repo: { type: "dataset", name: "username/my-dataset" } },
  destination: {
    repo: { type: "bucket", name: "username/my-bucket" },
    path: "datasets/my-dataset/",
  },
  accessToken: "hf_...",
});

// Copy a subfolder
await copyFolder({
  source: {
    repo: { type: "bucket", name: "username/src-bucket" },
    path: "models/",
  },
  destination: {
    repo: { type: "bucket", name: "username/dst-bucket" },
    path: "backup/",
  },
  accessToken: "hf_...",
});

Được định nghĩa trong

packages/hub/src/lib/copy-files.ts:277

copyFolderIter

▸ copyFolderIter(params): AsyncGenerator<CopyProgressEvent, undefined>

Biến thể async-iterator của copyFolder, trả về các CopyProgressEvent trong khi tải xuống các tệp nguồn không phải xet (các tệp dựa trên xet được sao chép phía máy chủ và không phát ra sự kiện). Xem copyFolder để biết chi tiết về ngữ nghĩa.

Tham số

Trả về

AsyncGenerator<CopyProgressEvent, undefined>

Được định nghĩa trong

packages/hub/src/lib/copy-files.ts:297

countCommits

▸ countCommits(params): Promise<number>

Tham số

Trả về

Promise<number>

Được định nghĩa trong

packages/hub/src/lib/count-commits.ts:8

createBranch

▸ createBranch(params): Promise<void>

Tham số

Trả về

Promise<void>

Được định nghĩa trong

packages/hub/src/lib/create-branch.ts:7

createCollection

▸ createCollection(params): Promise<{ slug: string }>

Tham số

Trả về

Promise<{ slug: string }>

Được định nghĩa trong

packages/hub/src/lib/create-collection.ts:8

createRepo

▸ createRepo(params): Promise<{ id: string ; repoUrl: string }>

Tham số

Trả về

Promise<{ id: string ; repoUrl: string }>

Được định nghĩa trong

packages/hub/src/lib/create-repo.ts:10

createScheduledJob

▸ createScheduledJob(params): Promise<ApiScheduledJob>

Tạo một công việc được lên lịch.

Tham số

Trả về

Promise<ApiScheduledJob>

Được định nghĩa trong

packages/hub/src/lib/jobs/create-scheduled-job.ts:12

datasetInfo

▸ datasetInfo<T>(params): Promise<DatasetEntry & Pick<ApiDatasetInfo, T>>

Tham số kiểu

Tham số

Trả về

Promise<DatasetEntry & Pick<ApiDatasetInfo, T>>

Được định nghĩa trong

packages/hub/src/lib/dataset-info.ts:10

deleteBranch

▸ deleteBranch(params): Promise<void>

Tham số

Trả về

Promise<void>

Được định nghĩa trong

packages/hub/src/lib/delete-branch.ts:7

deleteCollection

▸ deleteCollection(params): Promise<void>

Tham số

Trả về

Promise<void>

Được định nghĩa trong

packages/hub/src/lib/delete-collection.ts:7

deleteFile

▸ deleteFile(params): Promise<CommitOutput | undefined>

Tham số

Trả về

Promise<CommitOutput | undefined>

Được định nghĩa trong

packages/hub/src/lib/delete-file.ts:5

deleteFiles

▸ deleteFiles(params): Promise<CommitOutput | undefined>

Tham số

Trả về

Promise<CommitOutput | undefined>

Được định nghĩa trong

packages/hub/src/lib/delete-files.ts:5

deleteRepo

▸ deleteRepo(params): Promise<void>

Tham số

Trả về

Promise<void>

Được định nghĩa trong

packages/hub/src/lib/delete-repo.ts:8

deleteScheduledJob

▸ deleteScheduledJob(params): Promise<void>

Xóa một công việc đã lên lịch.

Tham số

Trả về

Promise<void>

Được định nghĩa trong

packages/hub/src/lib/jobs/delete-scheduled-job.ts:10

downloadFile

▸ downloadFile(params): Promise<Blob | null>

Tham số

Trả về

Promise<Blob | null>

null khi tệp không tồn tại

Được định nghĩa trong

packages/hub/src/lib/download-file.ts:13

downloadFileToCacheDir

▸ downloadFileToCacheDir(params): Promise<string>

Tải xuống một tệp nhất định nếu tệp đó chưa có trong bộ nhớ đệm cục bộ.

Tham số

Trả về

Promise<string>

liên kết mềm đến đối tượng blob

Được định nghĩa trong

packages/hub/src/lib/download-file-to-cache-dir.ts:46

duplicateJob

▸ duplicateJob(params): Promise<ApiJob>

Nhân bản một công việc (chạy lại với cùng thông số cấu hình).

Tham số

Trả về

Promise<ApiJob>

Được định nghĩa trong

packages/hub/src/lib/jobs/duplicate-job.ts:11

encodeShardFilename

▸ encodeShardFilename(filename): string

Phòng thủ nhiều lớp: URL tải xuống được xây dựng bằng cách chèn chuỗi, vì vậy hãy mã hóa từng đoạn đường dẫn của tên tệp (đã được xác thực) thay vì tin rằng nó an toàn cho URL.

Tham số

Trả về

string

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:570

fileDownloadInfo

▸ fileDownloadInfo(params): Promise<FileDownloadInfoOutput | null>

Tham số

Trả về

Promise<FileDownloadInfoOutput | null>

null khi tệp không tồn tại

Được định nghĩa trong

packages/hub/src/lib/file-download-info.ts:28

fileExists

▸ fileExists(params): Promise<boolean>

Tham số

Trả về

Promise<boolean>

Được định nghĩa trong

packages/hub/src/lib/file-exists.ts:8

getBlobStat

▸ getBlobStat(blobPath, blobStats): Promise<Stats>

Tham số

Trả về

Promise<Stats>

Được định nghĩa trong

packages/hub/src/lib/cache-management.ts:254

getHFHubCachePath

▸ getHFHubCachePath(): string

Trả về

string

Được định nghĩa trong

packages/hub/src/lib/cache-management.ts:19

getJob

▸ getJob(params): Promise<ApiJob>

Lấy một công việc cụ thể theo ID.

Tham số

Trả về

Promise<ApiJob>

Được định nghĩa trong

packages/hub/src/lib/jobs/get-job.ts:11

getQuantizationMultiplier

▸ getQuantizationMultiplier(tensorName, dtype, quantConfig?, expertDtype?, mlxQuantizedModules?): number

Lấy hệ số nhân tham số cho một tensor lượng tử hóa dựa trên phương pháp lượng tử hóa.

Có thể là số thập phân — xem packingFactor.

Tham số

Trả về

number

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:1259

getRepoFolderName

▸ getRepoFolderName(«destructured»): string

Tham số

Trả về

string

Được định nghĩa trong

packages/hub/src/lib/cache-management.ts:27

getScheduledJob

▸ getScheduledJob(params): Promise<ApiScheduledJob>

Lấy một công việc được lên lịch cụ thể theo ID.

Tham số

Trả về

Promise<ApiScheduledJob>

Được định nghĩa trong

packages/hub/src/lib/jobs/get-scheduled-job.ts:11

globMatch

▸ globMatch(pattern, str): boolean

Khớp glob không dùng RegExp: tách pattern theo * và kiểm tra rằng mỗi đoạn literal xuất hiện theo thứ tự trong str. Tránh hoàn toàn RegExp (không có rủi ro ReDoS, không có SyntaxError từ các pattern do kẻ tấn công kiểm soát trong config.json).

Tham số

Trả về

boolean

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:1153

isQuantizedTensor

▸ isQuantizedTensor(tensorName, quantConfig?, mlxQuantizedModules?): boolean

Xác định xem một tensor có được lượng tử hóa hay không dựa trên cấu hình lượng tử hóa và tên tensor.

Python’s transformers sử dụng khớp chuỗi con đơn giản cho modules_to_not_convert, do đó các tên đơn giản như "lm_head" phải khớp với "model.lm_head.weight". Khi mẫu chứa *, chúng tôi chuyển sang khớp glob đúng để tăng tính linh hoạt.

Tham số

Trả về

boolean

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:1189

listCollections

▸ listCollections(params?): AsyncGenerator<ApiCollectionInfo>

Tham số

Trả về

AsyncGenerator<ApiCollectionInfo>

Được định nghĩa trong

packages/hub/src/lib/list-collections.ts:13

listCommits

▸ listCommits(params): AsyncGenerator<CommitData>

Tham số

Trả về

AsyncGenerator<CommitData>

Được định nghĩa trong

packages/hub/src/lib/list-commits.ts:18

listDatasets

▸ listDatasets<T>(params?): AsyncGenerator<DatasetEntry & Pick<ApiDatasetInfo, T>>

Tham số kiểu

Tham số

Trả về

AsyncGenerator<DatasetEntry & Pick<ApiDatasetInfo, T>>

Được định nghĩa trong

packages/hub/src/lib/list-datasets.ts:48

listFiles

▸ listFiles(params): AsyncGenerator<ListFileEntry>

Liệt kê các tệp trong một thư mục. Để liệt kê TẤT CẢ tệp trong thư mục, hãy gọi nó với params.recursive được đặt thành true.

Tham số

Trả về

AsyncGenerator<ListFileEntry>

Được định nghĩa trong

packages/hub/src/lib/list-files.ts:54

listJobHardware

▸ listJobHardware(params?): Promise<ApiJobHardware[]>

Lấy danh sách phần cứng khả dụng cho các tác vụ. Endpoint này là công khai và không yêu cầu xác thực, nhưng xác thực là tùy chọn.

Tham số

Trả về

Promise<ApiJobHardware[]>

Được định nghĩa trong

packages/hub/src/lib/jobs/list-job-hardware.ts:12

listJobs

▸ listJobs(params): Promise<ApiJob[]>

Liệt kê các công việc cho một namespace (người dùng hoặc tổ chức).

Tham số

Trả về

Promise<ApiJob[]>

Được định nghĩa trong

packages/hub/src/lib/jobs/list-jobs.ts:11

listModels

▸ listModels<T>(params?): AsyncGenerator<ModelEntry & ResolveModelAdditionalFields<T>>

Tham số kiểu

Tham số

Trả về

AsyncGenerator<ModelEntry & ResolveModelAdditionalFields<T>>

Được định nghĩa trong

packages/hub/src/lib/list-models.ts:69

listScheduledJobs

▸ listScheduledJobs(params): Promise<ApiScheduledJob[]>

Liệt kê các công việc đã lên lịch cho một namespace.

Tham số

Trả về

Promise<ApiScheduledJob[]>

Được định nghĩa trong

packages/hub/src/lib/jobs/list-scheduled-jobs.ts:11

listSpaces

▸ listSpaces<T>(params?): AsyncGenerator<SpaceEntry & Pick<ApiSpaceInfo, T>>

Tham số kiểu

Tham số

Trả về

AsyncGenerator<SpaceEntry & Pick<ApiSpaceInfo, T>>

Được định nghĩa trong

packages/hub/src/lib/list-spaces.ts:45

matchesCompressedTensorsTarget

▸ matchesCompressedTensorsTarget(target, moduleName): boolean

Khớp tên module với một mục tiêu của compressed-tensors.

Targets là tên module chính xác, tên class (ví dụ "Linear", mà chúng ta không thể phân giải từ tên tensor và do đó bỏ qua), hoặc các biểu thức chính tắc Python có tiền tố re:. Để tránh đánh giá RegExp do kẻ tấn công kiểm soát từ config.json (ReDoS, SyntaxError — xem globMatch), chúng ta chuyển đổi tập con regex phổ biến (.* wildcard, ^/$ anchors, \. escapes) sang globMatch và coi các target sử dụng bất kỳ cú pháp regex nào khác là không khớp.

Tham số

Trả về

boolean

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:1231

modelInfo

▸ modelInfo<T>(params): Promise<ModelEntry & ResolveModelAdditionalFields<T>>

Tham số kiểu

Tham số

Trả về

Promise<ModelEntry & ResolveModelAdditionalFields<T>>

Được định nghĩa trong

packages/hub/src/lib/model-info.ts:17

oauthHandleRedirect

▸ oauthHandleRedirect(opts?): Promise<OAuthResult>

Để gọi sau khi nhà cung cấp OAuth chuyển hướng trở lại ứng dụng.

Ngoài ra, còn có một hàm trợ giúp oauthHandleRedirectIfPresent, sẽ gọi oauthHandleRedirect nếu URL chứa mã oauth trong các tham số truy vấn và trả về false trong trường hợp ngược lại.

Tham số

Trả về

Promise<OAuthResult>

Được định nghĩa trong

packages/hub/src/lib/oauth-handle-redirect.ts:123

oauthHandleRedirectIfPresent

▸ oauthHandleRedirectIfPresent(opts?): Promise<OAuthResult | false>

Để gọi sau khi nhà cung cấp OAuth chuyển hướng trở lại ứng dụng.

Nó trả về false nếu URL không chứa mã oauth trong các tham số truy vấn, ngược lại nó sẽ gọi oauthHandleRedirect.

Tùy thuộc vào ứng dụng của bạn, bạn có thể muốn gọi trực tiếp oauthHandleRedirect thay vì cách trên.

Tham số

Trả về

Promise<OAuthResult | false>

Được định nghĩa trong

packages/hub/src/lib/oauth-handle-redirect.ts:293

oauthLoginUrl

▸ oauthLoginUrl(opts?): Promise<string>

Sử dụng “Sign in with Hub” để xác thực người dùng và lấy thông tin người dùng oauth / access token.

Trả về một url để chuyển hướng. Sau khi người dùng được chuyển hướng trở lại ứng dụng của bạn, hãy gọi oauthHandleRedirect để lấy thông tin người dùng oauth / access token.

Khi được gọi từ bên trong một Space tĩnh có bật OAuth, nó sẽ tải cấu hình từ space đó, ngược lại bạn cần phải chỉ định ít nhất là client ID của OAuth App của bạn.

Tham số

Trả về

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

(Về mặt lý thuyết, hàm này có thể được sử dụng để xác thực người dùng cho bất kỳ nhà cung cấp OAuth nào hỗ trợ PKCE và OpenID Connect bằng cách thay đổi hubUrl, nhưng hiện tại nó chỉ được kiểm thử với Hugging Face Hub.)

Được định nghĩa trong

packages/hub/src/lib/oauth-login-url.ts:31

parseRepoType

▸ parseRepoType(type): RepoType

Tham số

Trả về

RepoType

Được định nghĩa trong

packages/hub/src/lib/cache-management.ts:264

parseSafetensorsMetadata

▸ parseSafetensorsMetadata(params): Promise<SetRequired<SafetensorsParseFromRepo, "parameterCount">>

Phân tích model.safetensors.index.json hoặc model.safetensors từ một model được lưu trữ trên Hugging Face bằng cách sử dụng các yêu cầu phạm vi thông minh để trích xuất metadata của nó.

Tham số

Trả về

Promise<SetRequired<SafetensorsParseFromRepo, "parameterCount">>

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:738

▸ parseSafetensorsMetadata(params): Promise<SafetensorsParseFromRepo>

Tham số

Trả về

Promise<SafetensorsParseFromRepo>

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:775

parseSafetensorsShardFilename

▸ parseSafetensorsShardFilename(filename): SafetensorsShardFileInfo | null

Tham số

Trả về

SafetensorsShardFileInfo | null

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:36

parseTotalParameters

▸ parseTotalParameters(value, computedTotal?): number | undefined

Đọc shortcut total_parameters từ metadata của header/index. Giá trị này do chính tệp tự khai báo và Hub hiển thị nguyên văn, bỏ qua bước xác thực header ở trên — do đó, hãy giới hạn nó ở mức số lượng đã tính toán khi có sẵn (không ảnh hưởng gì đến các tệp hợp lệ, nơi hai giá trị này trùng khớp).

Tham số

Trả về

number | undefined

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:699

pathsInfo

▸ pathsInfo(params): Promise<PathInfo & { lastCommit: CommitInfo ; securityFileStatus: SecurityFileStatus }[]>

Tham số

Trả về

Promise<PathInfo & { lastCommit: CommitInfo ; securityFileStatus: SecurityFileStatus }[]>

Được định nghĩa trong

packages/hub/src/lib/paths-info.ts:52

▸ pathsInfo(params): Promise<PathInfo[]>

Tham số

Trả về

Promise<PathInfo[]>

Được định nghĩa trong

packages/hub/src/lib/paths-info.ts:65

relativeUnderFolder

▸ relativeUnderFolder(filePath, folderPath): string

Tính đường dẫn của filePath tương đối với folderPath. Được dùng để ánh xạ các đường dẫn nguồn dưới một thư mục đang được sao chép sang các đường dẫn đích dưới tiền tố mới.

Tham số

Trả về

string

Được định nghĩa trong

packages/hub/src/lib/copy-files.ts:558

repoExists

▸ repoExists(params): Promise<boolean>

Tham số

Trả về

Promise<boolean>

Được định nghĩa trong

packages/hub/src/lib/repo-exists.ts:7

resumeScheduledJob

▸ resumeScheduledJob(params): Promise<void>

Tiếp tục một công việc đã lên lịch.

Tham số

Trả về

Promise<void>

Được định nghĩa trong

packages/hub/src/lib/jobs/resume-scheduled-job.ts:10

runJob

▸ runJob(params): Promise<ApiJob>

Chạy một tác vụ mới.

Tham số

Trả về

Promise<ApiJob>

Được định nghĩa trong

packages/hub/src/lib/jobs/run-job.ts:13

runScheduledJob

▸ runScheduledJob(params): Promise<ApiJob | null>

Kích hoạt một công việc được lên lịch để chạy ngay lập tức. Trả về công việc đã được kích hoạt, hoặc null nếu một phiên bản khác đang chạy.

Tham số

Trả về

Promise<ApiJob | null>

Được định nghĩa trong

packages/hub/src/lib/jobs/run-scheduled-job.ts:12

scanCacheDir

▸ scanCacheDir(cacheDir?): Promise<HFCacheInfo>

Tham số

Trả về

Promise<HFCacheInfo>

Được định nghĩa trong

packages/hub/src/lib/cache-management.ts:72

scanCachedRepo

▸ scanCachedRepo(repoPath): Promise<CachedRepoInfo>

Tham số

Trả về

Promise<CachedRepoInfo>

Được định nghĩa trong

packages/hub/src/lib/cache-management.ts:118

scanRefsDir

▸ scanRefsDir(refsPath, refsByHash): Promise<void>

Tham số

Trả về

Promise<void>

Được định nghĩa trong

packages/hub/src/lib/cache-management.ts:210

scanSnapshotDir

▸ scanSnapshotDir(revisionPath, cachedFiles, blobStats): Promise<void>

Tham số

Trả về

Promise<void>

Được định nghĩa trong

packages/hub/src/lib/cache-management.ts:227

snapshotDownload

▸ snapshotDownload(params): Promise<string>

Tải xuống toàn bộ kho lưu trữ tại một phiên bản nhất định trong thư mục cache getHFHubCachePath. Bạn có thể liệt kê tất cả các kho lưu trữ đã được cache bằng cách sử dụng scanCachedRepo

Tham số

Trả về

Promise<string>

Remarks

Nó sử dụng downloadFileToCacheDir bên trong.

Được định nghĩa trong

packages/hub/src/lib/snapshot-download.ts:20

spaceInfo

▸ spaceInfo<T>(params): Promise<SpaceEntry & Pick<ApiSpaceInfo, T>>

Tham số kiểu

Tham số

Trả về

Promise<SpaceEntry & Pick<ApiSpaceInfo, T>>

Được định nghĩa trong

packages/hub/src/lib/space-info.ts:11

streamJobEvents

▸ streamJobEvents(params): AsyncGenerator<string, void, unknown>

Dòng sự kiện công việc bằng Server-Sent Events (SSE). Trả về một đối tượng lặp bất đồng bộ gồm các khối sự kiện.

Tham số

Trả về

AsyncGenerator<string, void, unknown>

Được định nghĩa trong

packages/hub/src/lib/jobs/stream-job-events.ts:11

streamJobLogs

▸ streamJobLogs(params): AsyncGenerator<{ message: string ; timestamp: Date }, void, unknown>

Dòng nhật ký công việc (job logs) bằng cách sử dụng Server-Sent Events (SSE). Trả về một đối tượng lặp bất đồng bộ (async iterable) của các khối nhật ký (log chunks).

Tham số

Trả về

AsyncGenerator<{ message: string ; timestamp: Date }, void, unknown>

Được định nghĩa trong

packages/hub/src/lib/jobs/stream-job-logs.ts:11

streamJobMetrics

▸ streamJobMetrics(params): AsyncGenerator<string, void, unknown>

Dòng chỉ số công việc (job metrics) bằng Server-Sent Events (SSE). Trả về một đối tượng lặp bất đồng bộ (async iterable) của các khối chỉ số (metric chunks).

Tham số

Trả về

AsyncGenerator<string, void, unknown>

Được định nghĩa trong

packages/hub/src/lib/jobs/stream-job-metrics.ts:11

streamJson

▸ streamJson(source, options?): AsyncGenerator<JsonStreamEvent, void, undefined>

Tham số

Trả về

AsyncGenerator<JsonStreamEvent, void, undefined>

Được định nghĩa trong

packages/hub/src/utils/streamJson.ts:123

suspendScheduledJob

▸ suspendScheduledJob(params): Promise<void>

Tạm dừng một công việc được lên lịch.

Tham số

Trả về

Promise<void>

Được định nghĩa trong

packages/hub/src/lib/jobs/suspend-scheduled-job.ts:10

uploadFile

▸ uploadFile(params): Promise<CommitOutput | undefined>

Tham số

Trả về

Promise<CommitOutput | undefined>

Được định nghĩa trong

packages/hub/src/lib/upload-file.ts:39

uploadFiles

▸ uploadFiles(params): Promise<CommitOutput | undefined>

Tham số

Trả về

Promise<CommitOutput | undefined>

Được định nghĩa trong

packages/hub/src/lib/upload-files.ts:6

uploadFilesWithProgress

▸ uploadFilesWithProgress(params): AsyncGenerator<CommitProgressEvent, CommitOutput | undefined>

Tải lên với tiến trình

Cần có XMLHttpRequest để có các sự kiện tiến trình cho việc tải lên các model, datasets và spaces. Đặt useWebWorkers thành true để có các sự kiện tiến trình cho việc băm (hashing) các model, datasets và spaces.

Tham số

Trả về

AsyncGenerator<CommitProgressEvent, CommitOutput | undefined>

Được định nghĩa trong

packages/hub/src/lib/upload-files-with-progress.ts:21

validateTensorEntry

▸ validateTensorEntry(path, tensorName, info, fileSizeBytes): void

Kiểm tra một mục tensor trong phần header: các chiều là số nguyên hữu hạn nhỏ hơn MAX_TENSOR_DIM, data_offsets hợp lệ, và — khi kích thước tệp đã biết — khoảng byte được khai báo nằm gọn trong tệp. data_offsets được kiểm tra thay vì shape * dtype size vì hai giá trị này có thể khác nhau một cách hợp lệ (do padding), nên offset là nguồn sự thật duy nhất mà định dạng cung cấp.

Tham số

Trả về

void

Được định nghĩa trong

packages/hub/src/lib/parse-safetensors-metadata.ts:246

whoAmI

▸ whoAmI(params): Promise<WhoAmI & { auth: AuthInfo }>

Tham số

Trả về

Promise<WhoAmI & { auth: AuthInfo }>

Được định nghĩa trong

packages/hub/src/lib/who-am-i.ts:63