@huggingface/hub

Kelas

• HubApiError
• InvalidApiResponseFormatError
• JsonStreamParseError
• SafetensorParseError
• __internal_XetBlob

Antarmuka

• AuthInfo
• CachedFileInfo
• CachedRepoInfo
• CachedRevisionInfo
• CommitCopyFile
• CommitData
• CommitDeletedEntry
• KomitEditFile
• CommitEditFileParams
• CommitFile
• CommitInfo
• CommitOutput
• CopyDestination
• CopyFilesEntry
• CopyProgressEvent
• Salin Sumber
• Kredensial
• 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

Alias Tipe

AccessToken

Ƭ AccessToken: string

Sebenarnya hf_${string}, tetapi untuk kenyamanan, menggunakan tipe string

Didefinisikan di

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

AccessTokenRole

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

Didefinisikan di

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

AuthType

Ƭ Jenis autentikasi: "access_token" | "app_token" | "app_token_as_user"

Didefinisikan di

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

CommitOperation

Ƭ CommitOperation: CommitDeletedEntry | CommitFile | CommitEditFile | CommitCopyFile

Didefinisikan di

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

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>

Didefinisikan di

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

CommitProgressEvent

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

Didefinisikan di

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

ContentSource

Ƭ SumberKonten: Blob | URL

Didefinisikan di

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

Dtype

Ƭ Tipe data: "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"

Didefinisikan di

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 }

Parser JSON yang minimal, bebas dependensi, dan inkremental (gaya SAX).

JSON.parse membutuhkan seluruh dokumen di memori dua kali (string sumber + pohon objek hasil), yang membuatnya tidak dapat digunakan untuk dokumen yang besar tetapi konten penting-nya sangat kecil — misalnya model.safetensors.index.json dari MoE besar, di mana weight_map berukuran 60 MB hanya ada untuk memberi tahu kami ~100 nama file shard yang berbeda.

Parser ini justru mengeluarkan aliran event datar saat byte tiba, sehingga konsumen hanya perlu menyimpan apa yang menjadi perhatiannya dan membiarkan sisanya dikumpulkan oleh pengumpul sampah. Penggunaan memori dibatasi oleh ukuran token individual terbesar (string / angka), bukan oleh ukuran dokumen.

Implementasinya adalah mesin keadaan yang dapat dilanjutkan: token apa pun dapat dipecah di batas chunk (termasuk sekuens UTF-8 multi-byte dan escape \uXXXX).

Ketatan: tata bahasa yang diterima adalah RFC 8259 (sama seperti JSON.parse), dikurangi beberapa pemeriksaan yang akan memakan biaya besar untuk manfaat kecil di sini — khususnya, bentuk angka divalidasi oleh Number() alih-alih oleh mesin keadaan, sehingga sejumlah kecil input yang ditolak oleh JSON.parse tetap diterima. Semua yang diterima oleh JSON.parse juga diterima, dengan nilai yang identik.

Example

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

Didefinisikan di

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

ModelAdditionalField

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

Didefinisikan di

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

PipelineType

Ƭ PipelineType: keyof typeof PIPELINE_DATA

Didefinisikan di

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

RangeEditCache

Ƭ RangeEditCache: Map<string, RangeEditCacheEntry>

Status in-memory dari file yang sebelumnya ditulis melalui jalur range-edit, yang diindeks berdasarkan hash xet-nya. Memungkinkan operasi append berikutnya (atau edit pada term terakhir file) untuk sepenuhnya melewati panggilan API reconstruction dan file-chunk-hashes: status merkle parsial dan hash verifikasi sudah diketahui.

Lewatkan instance RangeEditCache yang sama ke panggilan commit berurutan yang menambahkan ke file yang sama untuk menghindari pemanggilan API metadata CAS pada setiap penambahan.

Didefinisikan di

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

RepoDesignation

Ƭ RepoDesignation: RepoId | RepoFullName

Didefinisikan di

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

RepoFullName

Ƭ NamaLengkapRepo: string | `spaces/${string}` | `datasets/${string}` | `buckets/${string}` | `kernels/${string}`

Didefinisikan di

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

RepoType

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

Didefinisikan di

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

ResolveModelAdditionalFields

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

Parameter tipe

Didefinisikan di

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

SafetensorsFileHeader

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

Didefinisikan di

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 }

Didefinisikan di

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

SafetensorsShardedHeaders

Ƭ SafetensorsShardedHeaders: Record<FileName, SafetensorsFileHeader>

Didefinisikan di

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"

Didefinisikan di

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

SpaceSdk

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

Didefinisikan di

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"

Didefinisikan di

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

TensorName

Ƭ NamaTensor: string

Didefinisikan di

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

WhoAmI

Ƭ WhoAmI: WhoAmIApp | WhoAmIOrg | WhoAmIUser

Didefinisikan di

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

Variabel

DATASET _ EXPANDABLE _ KEYS

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

Didefinisikan di

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

DATASET _ EXPAND _ KEYS

• Const DATASET_EXPAND_KEYS: readonly ["private", "downloads", "gated", "likes", "lastModified"]

Didefinisikan di

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

REVISI _ DEFAULT

• Const DEFAULT_REVISION: "main"

Didefinisikan di

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

DIFFUSERS _ SAFETENSORS _ FILE

• Const DIFFUSERS_SAFETENSORS_FILE: "diffusion_pytorch_model.safetensors"

Didefinisikan di

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

DIFFUSERS _ SAFETENSORS _ INDEX _ FILE

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

Didefinisikan di

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

DIFFUSERS _ WEIGHTS _ SUBFOLDERS

• Const DIFFUSERS_WEIGHTS_SUBFOLDERS: readonly ["transformer", "unet"]

Didefinisikan di

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

HUB _ URL

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

URL dasar dari Hugging Face Hub.

Didefinisikan di

packages/hub/src/consts.ts:4

MODEL _ FIELD_YANG_DIURAIKAN _ KE _ API_KEY

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

Didefinisikan di

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

MODEL _ EXPANDABLE _ KEYS

• 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"]

Didefinisikan di

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

MODEL _ EXPAND _ KEYS

• Const MODEL_EXPAND_KEYS: readonly ["pipeline_tag", "private", "gated", "downloads", "likes", "lastModified"]

Didefinisikan di

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

REGEX _ COMMIT _ HASH

• Const REGEX_COMMIT_HASH: RegExp

Didefinisikan di

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

REPO _ ID _ SEPARATOR

• Const REPO_ID_SEPARATOR: string = "--"

Didefinisikan di

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

RE _ SAFETENSORS _ FILE

• Const RE_SAFETENSORS_FILE: RegExp

Didefinisikan di

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

RE _ SAFETENSORS _ INDEX _ FILE

• Const RE_SAFETENSORS_INDEX_FILE: RegExp

Didefinisikan di

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

RE _ SAFETENSORS _ SHARD _ FILE

• Const RE_SAFETENSORS_SHARD_FILE: RegExp

Didefinisikan di

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

SAFETENSORS _ FILE

• Const SAFETENSORS_FILE: "model.safetensors"

Didefinisikan di

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

SAFETENSORS _ INDEX _ FILE

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

Didefinisikan di

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

SPACE _ EXPANDABLE _ KEYS

• Const SPACE_EXPANDABLE_KEYS: readonly ["author", "cardData", "datasets", "disabled", "gitalyUid", "lastModified", "createdAt", "likes", "private", "runtime", "sdk", "sha", "subdomain", "tags", "models"]

Didefinisikan di

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

SPACE _ EXPAND _ KEYS

• Const SPACE_EXPAND_KEYS: readonly ["sdk", "likes", "private", "lastModified"]

Didefinisikan di

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

Fungsi

_ _ internal _ sha256

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

Parameter

Mengembalikan

AsyncGenerator<number, string>

sha yang dienkod hex

Yields

progres (0-1)

Didefinisikan di

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

assertSafeShardFilename

▸ assertSafeShardFilename(filename): void

Nama file weight_map berasal dari file repo, sehingga dikendalikan oleh penyerang: mereka harus tetap berupa path relatif di dalam direktori index itu sendiri.

Pemeriksaan literal includes("..") tidak cukup, karena URL tempat nama file berakhir akan diurai oleh parser URL WHATWG setelah pemeriksaan, dan parser tersebut melakukan dekoding persentase pada segmen titik: %2e%2e (atau .%2e, %2E%2E, …) adalah segmen .. baginya, sehingga ia keluar dari repo — dan dengan kredensial yang terlampir, permintaan tersebut tiba dengan otorisasi pada URL resolve repo lain.

Jadi, dekode sebelum memvalidasi (secara berulang, untuk menangkap %252e%252e), dan tolak apa pun yang bukan merupakan jalur relatif sederhana.

Parameter

Mengembalikan

void

Didefinisikan di

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

cancelJob

▸ cancelJob(params): Promise<ApiJob>

Batalkan sebuah pekerjaan.

Parameter

Mengembalikan

Promise<ApiJob>

Didefinisikan di

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

checkRepoAccess

▸ checkRepoAccess(params): Promise<void>

Periksa apakah kami memiliki akses baca ke repositori.

Lempar error HubApiError jika kami tidak memiliki akses. HubApiError.statusCode akan bernilai 401, 403, atau 404.

Parameter

Mengembalikan

Promise<void>

Didefinisikan di

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

commit

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

Parameter

Mengembalikan

Promise<CommitOutput | undefined>

undefined untuk unggahan bucket, CommitOutput lainnya

Didefinisikan di

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

commitIter

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

Fungsi internal untuk saat ini, digunakan oleh commit.

Dapat diungkap kemudian untuk menawarkan informasi kemajuan yang lebih terperinci

CommitOutput tidak ada untuk commit bucket

Parameter

Mengembalikan

AsyncGenerator<CommitProgressEvent, CommitOutput | undefined>

Didefinisikan di

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

commitIterBucket

▸ commitIterBucket(params): AsyncGenerator<CommitProgressEvent>

Parameter

Mengembalikan

AsyncGenerator<CommitProgressEvent>

Didefinisikan di

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

computeNumOfParamsByDtypeSingleFile

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

Menjumlahkan parameter per dtype untuk header satu file, menerapkan faktor pengemasan kuantisasi, dan melewati tensor pembukuan.

Parameter

Mengembalikan

Partial<Record<Dtype, number>>

Didefinisikan di

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

copyFile

▸ copyFile(params): Promise<undefined>

Salin satu file dari repo/bucket sumber ke bucket tujuan.

Salinan dilakukan di sisi server (tanpa transfer data) ketika file sumber didukung xet. Untuk file repo non-xet berukuran kecil (mis. config.json), file diunduh dan diunggah ulang ke bucket tujuan dalam commit yang sama.

File pointer LFS yang belum dimigrasikan ke xet ditolak di awal (jika tidak, file tersebut akan memerlukan pengunduhan blob LFS penuh).

Parameter

Mengembalikan

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_...",
});

Didefinisikan di

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

copyFileIter

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

Varian async-iterator dari copyFile yang menghasilkan CopyProgressEvent saat mengunduh file sumber non-xet (file yang didukung xet disalin di sisi server dan tidak memancarkan event). Lihat copyFile untuk semantik.

Parameter

Mengembalikan

AsyncGenerator<CopyProgressEvent, undefined>

Example

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

Didefinisikan di

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

copyFiles

▸ copyFiles(params): Promise<undefined>

Salin beberapa file (mungkin dari repositori/bucket sumber yang berbeda) ke bucket tujuan dalam satu commit.

Untuk file sumber yang didukung xet, penyalinan dilakukan di sisi server tanpa transfer data. Untuk file sumber non-xet (biasanya file repo kecil yang disimpan di git), file diunduh dan diunggah ulang sebagai bagian dari commit yang sama.

File pointer LFS yang belum dimigrasikan ke xet ditolak di awal.

Parameter

Mengembalikan

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_...",
});

Didefinisikan di

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

copyFilesIter

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

Varian async-iterator dari copyFiles yang menghasilkan CopyProgressEvent saat mengunduh file sumber non-xet (file yang didukung xet disalin di sisi server dan tidak memancarkan event). Lihat copyFiles untuk semantik.

Parameter

Mengembalikan

AsyncGenerator<CopyProgressEvent, undefined>

Didefinisikan di

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

copyFolder

▸ copyFolder(params): Promise<undefined>

Salin folder (secara rekursif) dari repo/bucket sumber ke bucket tujuan dalam satu commit.

Path per file dipecahkan relatif terhadap CopySource.path; folder sumber itu sendiri tidak dipertahankan di tujuan kecuali CopyDestination.path menyimpannya.

Parameter

Mengembalikan

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_...",
});

Didefinisikan di

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

copyFolderIter

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

Varian async-iterator dari copyFolder yang menghasilkan CopyProgressEvent saat mengunduh file sumber non-xet (file yang didukung xet disalin di sisi server dan tidak memancarkan event). Lihat copyFolder untuk semantik.

Parameter

Mengembalikan

AsyncGenerator<CopyProgressEvent, undefined>

Didefinisikan di

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

countCommits

▸ countCommits(params): Promise<number>

Parameter

Mengembalikan

Promise<number>

Didefinisikan di

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

createBranch

▸ createBranch(params): Promise<void>

Parameter

Mengembalikan

Promise<void>

Didefinisikan di

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

createCollection

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

Parameter

Mengembalikan

Promise<{ slug: string }>

Didefinisikan di

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

createRepo

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

Parameter

Mengembalikan

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

Didefinisikan di

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

createScheduledJob

▸ createScheduledJob(params): Promise<ApiScheduledJob>

Buat tugas terjadwal.

Parameter

Mengembalikan

Promise<ApiScheduledJob>

Didefinisikan di

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

datasetInfo

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

Parameter tipe

Parameter

Mengembalikan

Promise<DatasetEntry & Pick<ApiDatasetInfo, T>>

Didefinisikan di

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

deleteBranch

▸ deleteBranch(params): Promise<void>

Parameter

Mengembalikan

Promise<void>

Didefinisikan di

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

deleteCollection

▸ deleteCollection(params): Promise<void>

Parameter

Mengembalikan

Promise<void>

Didefinisikan di

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

deleteFile

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

Parameter

Mengembalikan

Promise<CommitOutput | undefined>

Didefinisikan di

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

deleteFiles

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

Parameter

Mengembalikan

Promise<CommitOutput | undefined>

Didefinisikan di

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

deleteRepo

▸ deleteRepo(params): Promise<void>

Parameter

Mengembalikan

Promise<void>

Didefinisikan di

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

deleteScheduledJob

▸ deleteScheduledJob(params): Promise<void>

Hapus pekerjaan terjadwal.

Parameter

Mengembalikan

Promise<void>

Didefinisikan di

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

downloadFile

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

Parameter

Mengembalikan

Promise<Blob | null>

null jika file tidak ada

Didefinisikan di

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

downloadFileToCacheDir

▸ downloadFileToCacheDir(params): Promise<string>

Unduh file tertentu jika belum ada di cache lokal.

Parameter

Mengembalikan

Promise<string>

symlink ke objek blob

Didefinisikan di

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

duplicateJob

▸ duplicateJob(params): Promise<ApiJob>

Duplikasi pekerjaan (jalankan ulang dengan spesifikasi yang sama).

Parameter

Mengembalikan

Promise<ApiJob>

Didefinisikan di

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

encodeShardFilename

▸ encodeShardFilename(filename): string

Pertahanan berlapis: URL unduhan dibangun melalui interpolasi string, sehingga enkripsi setiap segmen path dari nama file (yang sudah divalidasi) dilakukan alih-alih mempercayai bahwa nama file tersebut aman untuk URL.

Parameter

Mengembalikan

string

Didefinisikan di

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

fileDownloadInfo

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

Parameter

Mengembalikan

Promise<FileDownloadInfoOutput | null>

null jika file tidak ada

Didefinisikan di

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

fileExists

▸ fileExists(params): Promise<boolean>

Parameter

Mengembalikan

Promise<boolean>

Didefinisikan di

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

getBlobStat

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

Parameter

Mengembalikan

Promise<Stats>

Didefinisikan di

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

getHFHubCachePath

▸ getHFHubCachePath(): string

Mengembalikan

string

Didefinisikan di

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

getJob

▸ getJob(params): Promise<ApiJob>

Dapatkan pekerjaan tertentu berdasarkan ID.

Parameter

Mengembalikan

Promise<ApiJob>

Didefinisikan di

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

getQuantizationMultiplier

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

Mendapatkan pengali parameter untuk tensor terkuantisasi berdasarkan metode kuantisasi.

Bisa berupa pecahan — lihat packingFactor.

Parameter

Mengembalikan

number

Didefinisikan di

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

getRepoFolderName

▸ getRepoFolderName(«destructured»): string

Parameter

Mengembalikan

string

Didefinisikan di

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

getScheduledJob

▸ getScheduledJob(params): Promise<ApiScheduledJob>

Dapatkan pekerjaan terjadwal tertentu berdasarkan ID.

Parameter

Mengembalikan

Promise<ApiScheduledJob>

Didefinisikan di

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

globMatch

▸ globMatch(pattern, str): boolean

Glob match tanpa RegExp: memisahkan pola pada * dan memeriksa bahwa setiap segmen literal muncul secara berurutan di dalam str. Menghindari RegExp sepenuhnya (tidak ada risiko ReDoS, tidak ada SyntaxError dari pola yang dikendalikan penyerang di config.json).

Parameter

Mengembalikan

boolean

Didefinisikan di

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

isQuantizedTensor

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

Menentukan apakah tensor dikuantisasi berdasarkan konfigurasi kuantisasi dan nama tensor.

transformers Python menggunakan pencocokan substring biasa untuk modules_to_not_convert, sehingga nama polos seperti "lm_head" harus cocok dengan "model.lm_head.weight". Ketika pola mengandung *, kami beralih ke pencocokan glob yang tepat untuk fleksibilitas.

Parameter

Mengembalikan

boolean

Didefinisikan di

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

listCollections

▸ listCollections(params?): AsyncGenerator<ApiCollectionInfo>

Parameter

Mengembalikan

AsyncGenerator<ApiCollectionInfo>

Didefinisikan di

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

listCommits

▸ listCommits(params): AsyncGenerator<CommitData>

Parameter

Mengembalikan

AsyncGenerator<CommitData>

Didefinisikan di

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

listDatasets

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

Parameter tipe

Parameter

Mengembalikan

AsyncGenerator<DatasetEntry & Pick<ApiDatasetInfo, T>>

Didefinisikan di

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

listFiles

▸ listFiles(params): AsyncGenerator<ListFileEntry>

Daftarkan file dalam folder. Untuk mendaftar SEMUA file dalam direktori, panggil dengan params.recursive diatur ke true.

Parameter

Mengembalikan

AsyncGenerator<ListFileEntry>

Didefinisikan di

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

listJobHardware

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

Dapatkan daftar perangkat keras yang tersedia untuk pekerjaan. Endpoint ini bersifat publik dan tidak memerlukan autentikasi, tetapi autentikasi bersifat opsional.

Parameter

Mengembalikan

Promise<ApiJobHardware[]>

Didefinisikan di

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

listJobs

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

Daftarkan pekerjaan untuk namespace (pengguna atau organisasi).

Parameter

Mengembalikan

Promise<ApiJob[]>

Didefinisikan di

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

listModels

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

Parameter tipe

Parameter

Mengembalikan

AsyncGenerator<ModelEntry & ResolveModelAdditionalFields<T>>

Didefinisikan di

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

listScheduledJobs

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

Daftarkan pekerjaan terjadwal untuk namespace.

Parameter

Mengembalikan

Promise<ApiScheduledJob[]>

Didefinisikan di

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

listSpaces

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

Parameter tipe

Parameter

Mengembalikan

AsyncGenerator<SpaceEntry & Pick<ApiSpaceInfo, T>>

Didefinisikan di

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

matchesCompressedTensorsTarget

▸ matchesCompressedTensorsTarget(target, moduleName): boolean

Mencocokkan nama modul dengan target compressed-tensors.

Target adalah nama modul yang persis, nama kelas (misalnya "Linear", yang tidak dapat kami selesaikan dari nama tensor dan karenanya diabaikan), atau regex Python yang diawali dengan re:. Untuk menghindari evaluasi RegExp yang dikendalikan penyerang dari config.json (ReDoS, SyntaxError — lihat globMatch), kami menerjemahkan subset regex yang umum (.* wildcard, ^/$ anchors, \. escapes) ke globMatch dan memperlakukan target yang menggunakan sintaks regex lainnya sebagai tidak cocok.

Parameter

Mengembalikan

boolean

Didefinisikan di

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

modelInfo

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

Parameter tipe

Parameter

Mengembalikan

Promise<ModelEntry & ResolveModelAdditionalFields<T>>

Didefinisikan di

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

oauthHandleRedirect

▸ oauthHandleRedirect(opts?): Promise<OAuthResult>

Untuk dipanggil setelah penyedia OAuth mengalihkan kembali ke aplikasi.

Terdapat juga fungsi bantu oauthHandleRedirectIfPresent, yang akan memanggil oauthHandleRedirect jika URL berisi kode oauth dalam parameter query dan mengembalikan false jika tidak.

Parameter

Mengembalikan

Promise<OAuthResult>

Didefinisikan di

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

oauthHandleRedirectIfPresent

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

Untuk dipanggil setelah penyedia OAuth mengalihkan kembali ke aplikasi.

Kembalikan false jika URL tidak berisi kode oauth dalam parameter query, selain itu panggil oauthHandleRedirect.

Tergantung pada aplikasi Anda, Anda mungkin ingin memanggil oauthHandleRedirect secara langsung sebagai gantinya.

Parameter

Mengembalikan

Promise<OAuthResult | false>

Didefinisikan di

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

oauthLoginUrl

▸ oauthLoginUrl(opts?): Promise<string>

Gunakan “Sign in with Hub” untuk mengautentikasi pengguna, dan mendapatkan informasi pengguna oauth / token akses.

Mengembalikan url untuk dialihkan. Setelah pengguna dialihkan kembali ke aplikasi Anda, panggil oauthHandleRedirect untuk mendapatkan info pengguna oauth / access token.

Ketika dipanggil dari dalam Space statis dengan OAuth yang diaktifkan, konfigurasi akan dimuat dari space tersebut. Sebaliknya, Anda perlu setidaknya menentukan ID klien dari Aplikasi OAuth Anda.

Parameter

Mengembalikan

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

(Sejauh teori, fungsi ini dapat digunakan untuk mengautentikasi pengguna untuk penyedia OAuth mana pun yang mendukung PKCE dan OpenID Connect dengan mengubah hubUrl, namun saat ini hanya diuji dengan Hugging Face Hub.)

Didefinisikan di

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

parseRepoType

▸ parseRepoType(type): RepoType

Parameter

Mengembalikan

RepoType

Didefinisikan di

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

parseSafetensorsMetadata

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

Analisis model.safetensors.index.json atau model.safetensors dari model yang dihosting di Hugging Face menggunakan smart range requests untuk mengekstrak metadatanya.

Parameter

Mengembalikan

Promise<SetRequired<SafetensorsParseFromRepo, "parameterCount">>

Didefinisikan di

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

▸ parseSafetensorsMetadata(params): Promise<SafetensorsParseFromRepo>

Parameter

Mengembalikan

Promise<SafetensorsParseFromRepo>

Didefinisikan di

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

parseSafetensorsShardFilename

▸ parseSafetensorsShardFilename(filename): SafetensorsShardFileInfo | null

Parameter

Mengembalikan

SafetensorsShardFileInfo | null

Didefinisikan di

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

parseTotalParameters

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

Membaca shortcut total_parameters dari metadata header/index. Nilainya bersifat self-reported dan Hub menampilkannya apa adanya, melewati validasi header di atas — jadi batasi nilainya pada jumlah yang dihitung jika ada (tidak ada efek untuk file yang well-formed, di mana keduanya sama).

Parameter

Mengembalikan

number | undefined

Didefinisikan di

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

pathsInfo

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

Parameter

Mengembalikan

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

Didefinisikan di

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

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

Parameter

Mengembalikan

Promise<PathInfo[]>

Didefinisikan di

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

relativeUnderFolder

▸ relativeUnderFolder(filePath, folderPath): string

Hitung jalur filePath relatif terhadap folderPath. Digunakan untuk memetakan jalur sumber di bawah folder yang disalin ke jalur tujuan di bawah prefiks baru.

Parameter

Mengembalikan

string

Didefinisikan di

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

repoExists

▸ repoExists(params): Promise<boolean>

Parameter

Mengembalikan

Promise<boolean>

Didefinisikan di

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

resumeScheduledJob

▸ resumeScheduledJob(params): Promise<void>

Lanjutkan pekerjaan terjadwal.

Parameter

Mengembalikan

Promise<void>

Didefinisikan di

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

runJob

▸ runJob(params): Promise<ApiJob>

Jalankan tugas baru.

Parameter

Mengembalikan

Promise<ApiJob>

Didefinisikan di

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

runScheduledJob

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

Pemicu eksekusi segera untuk pekerjaan terjadwal. Mengembalikan pekerjaan yang dipicu, atau null jika instance lain sudah berjalan.

Parameter

Mengembalikan

Promise<ApiJob | null>

Didefinisikan di

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

scanCacheDir

▸ scanCacheDir(cacheDir?): Promise<HFCacheInfo>

Parameter

Mengembalikan

Promise<HFCacheInfo>

Didefinisikan di

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

scanCachedRepo

▸ scanCachedRepo(repoPath): Promise<CachedRepoInfo>

Parameter

Mengembalikan

Promise<CachedRepoInfo>

Didefinisikan di

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

scanRefsDir

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

Parameter

Mengembalikan

Promise<void>

Didefinisikan di

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

scanSnapshotDir

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

Parameter

Mengembalikan

Promise<void>

Didefinisikan di

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

snapshotDownload

▸ snapshotDownload(params): Promise<string>

Mengunduh seluruh repositori pada revisi tertentu di direktori cache getHFHubCachePath. Anda dapat mendaftar semua repositori yang di-cache menggunakan scanCachedRepo

Parameter

Mengembalikan

Promise<string>

Remarks

Secara internal, ini menggunakan downloadFileToCacheDir.

Didefinisikan di

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

spaceInfo

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

Parameter tipe

Parameter

Mengembalikan

Promise<SpaceEntry & Pick<ApiSpaceInfo, T>>

Didefinisikan di

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

streamJobEvents

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

Gunakan Server-Sent Events (SSE) untuk streaming peristiwa job. Mengembalikan iterable asinkron dari potongan-potongan peristiwa.

Parameter

Mengembalikan

AsyncGenerator<string, void, unknown>

Didefinisikan di

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

streamJobLogs

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

Gunakan Server-Sent Events (SSE) untuk streaming log job. Mengembalikan iterable asinkron dari potongan log.

Parameter

Mengembalikan

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

Didefinisikan di

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

streamJobMetrics

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

Gunakan Server-Sent Events (SSE) untuk mengalirkan metrik job. Mengembalikan iterable asinkron dari potongan metrik.

Parameter

Mengembalikan

AsyncGenerator<string, void, unknown>

Didefinisikan di

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

streamJson

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

Parameter

Mengembalikan

AsyncGenerator<JsonStreamEvent, void, undefined>

Didefinisikan di

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

suspendScheduledJob

▸ suspendScheduledJob(params): Promise<void>

Suspend (jeda) pekerjaan terjadwal.

Parameter

Mengembalikan

Promise<void>

Didefinisikan di

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

uploadFile

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

Parameter

Mengembalikan

Promise<CommitOutput | undefined>

Didefinisikan di

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

uploadFiles

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

Parameter

Mengembalikan

Promise<CommitOutput | undefined>

Didefinisikan di

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

uploadFilesWithProgress

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

Unggahan dengan kemajuan

Membutuhkan XMLHttpRequest agar tersedia untuk event progres pada unggahan model, dataset, dan spaces. Setel useWebWorkers ke true agar event progres untuk hashing tersedia pada model, dataset, dan spaces.

Parameter

Mengembalikan

AsyncGenerator<CommitProgressEvent, CommitOutput | undefined>

Didefinisikan di

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

validateTensorEntry

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

Memvalidasi satu entri tensor dari header: dimensi adalah bilangan bulat berhingga di bawah MAX_TENSOR_DIM, data_offsets masuk akal, dan — ketika ukuran file diketahui — rentang byte yang dideklarasikan muat di dalam file. data_offsets diperiksa, bukan shape * dtype size, karena keduanya dapat secara sah berbeda (padding), sehingga offset adalah satu-satunya kebenaran yang diberikan oleh format.

Parameter

Mengembalikan

void

Didefinisikan di

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

whoAmI

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

Parameter

Mengembalikan

Promise<WhoAmI & { auth: AuthInfo }>

Didefinisikan di

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