# @huggingface/hub ## Kelas - [HubApiError](classes/HubApiError) - [InvalidApiResponseFormatError](classes/InvalidApiResponseFormatError) - [JsonStreamParseError](classes/JsonStreamParseError) - [SafetensorParseError](classes/SafetensorParseError) - [\_\_internal\_XetBlob](classes/_internal_XetBlob) ## Antarmuka - [AuthInfo](interfaces/AuthInfo) - [CachedFileInfo](interfaces/CachedFileInfo) - [CachedRepoInfo](interfaces/CachedRepoInfo) - [CachedRevisionInfo](interfaces/CachedRevisionInfo) - [CommitCopyFile](interfaces/CommitCopyFile) - [CommitData](interfaces/CommitData) - [CommitDeletedEntry](interfaces/CommitDeletedEntry) - [KomitEditFile](interfaces/CommitEditFile) - [CommitEditFileParams](interfaces/CommitEditFileParams) - [CommitFile](interfaces/CommitFile) - [CommitInfo](interfaces/CommitInfo) - [CommitOutput](interfaces/CommitOutput) - [CopyDestination](interfaces/CopyDestination) - [CopyFilesEntry](interfaces/CopyFilesEntry) - [CopyProgressEvent](interfaces/CopyProgressEvent) - [Salin Sumber](interfaces/CopySource) - [Kredensial](interfaces/Credentials) - [DatasetEntry](interfaces/DatasetEntry) - [FileDownloadInfoOutput](interfaces/FileDownloadInfoOutput) - [HFCacheInfo](interfaces/HFCacheInfo) - [JobVolume](interfaces/JobVolume) - [LfsPathInfo](interfaces/LfsPathInfo) - [ListFileEntry](interfaces/ListFileEntry) - [MlxQuantizationConfig](interfaces/MlxQuantizationConfig) - [ModelConfig](interfaces/ModelConfig) - [ModelDerivedFields](interfaces/ModelDerivedFields) - [ModelEntry](interfaces/ModelEntry) - [OAuthResult](interfaces/OAuthResult) - [ParallelDownloadOptions](interfaces/ParallelDownloadOptions) - [PathInfo](interfaces/PathInfo) - [QuantizationConfig](interfaces/QuantizationConfig) - [RangeEditCacheEntry](interfaces/RangeEditCacheEntry) - [RepoId](interfaces/RepoId) - [SafetensorsIndexJson](interfaces/SafetensorsIndexJson) - [SafetensorsShardFileInfo](interfaces/SafetensorsShardFileInfo) - [SecurityFileStatus](interfaces/SecurityFileStatus) - [SpaceEntry](interfaces/SpaceEntry) - [SpaceResourceConfig](interfaces/SpaceResourceConfig) - [SpaceResourceRequirement](interfaces/SpaceResourceRequirement) - [SpaceRuntime](interfaces/SpaceRuntime) - [TensorInfo](interfaces/TensorInfo) - [UserInfo](interfaces/UserInfo) - [WhoAmIApp](interfaces/WhoAmIApp) - [WhoAmIOrg](interfaces/WhoAmIOrg) - [WhoAmIUser](interfaces/WhoAmIUser) - [XetFileInfo](interfaces/XetFileInfo) - [XetReadToken](interfaces/XetReadToken) ## Alias Tipe ### AccessToken Ƭ **AccessToken**: `string` Sebenarnya `hf_${string}`, tetapi untuk kenyamanan, menggunakan tipe string #### Didefinisikan di[[accesstoken.defined-in]] [packages/hub/src/types/public.ts:28](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L28) ___ ### AccessTokenRole Ƭ **AccessTokenRole**: ``"admin"`` \| ``"write"`` \| ``"contributor"`` \| ``"read"`` #### Didefinisikan di[[accesstokenrole.defined-in]] [packages/hub/src/types/public.ts:98](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L98) ___ ### AuthType Ƭ **Jenis autentikasi**: ``"access_token"`` \| ``"app_token"`` \| ``"app_token_as_user"`` #### Didefinisikan di[[authtype.defined-in]] [packages/hub/src/types/public.ts:100](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L100) ___ ### CommitOperation Ƭ **CommitOperation**: [`CommitDeletedEntry`](interfaces/CommitDeletedEntry) \| [`CommitFile`](interfaces/CommitFile) \| [`CommitEditFile`](interfaces/CommitEditFile) \| [`CommitCopyFile`](interfaces/CommitCopyFile) #### Didefinisikan di[[commitoperation.defined-in]] [packages/hub/src/lib/commit.ts:123](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L123) ___ ### CommitParams Ƭ **CommitParams**: \{ `abortSignal?`: `AbortSignal` ; `branch?`: `string` ; `description?`: `string` ; `fetch?`: typeof [`__type`](classes/_internal_XetBlob#__type) ; `hubUrl?`: `string` ; `isPullRequest?`: `boolean` ; `maxFolderDepth?`: `number` ; `operations`: [`CommitOperation`](modules#commitoperation)[] ; `parentCommit?`: `string` ; `rangeEditCache?`: [`RangeEditCache`](modules#rangeeditcache) ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `title`: `string` ; `useWebWorkers?`: `boolean` \| \{ `minSize?`: `number` ; `poolSize?`: `number` } ; `useXet?`: `boolean` } & `Partial`\<`CredentialsParams`\> #### Didefinisikan di[[commitparams.defined-in]] [packages/hub/src/lib/commit.ts:130](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L130) ___ ### CommitProgressEvent Ƭ **CommitProgressEvent**: \{ `event`: ``"phase"`` ; `phase`: ``"preuploading"`` \| ``"uploadingLargeFiles"`` \| ``"committing"`` } \| \{ `event`: ``"fileProgress"`` ; `path`: `string` ; `progress`: `number` ; `state`: ``"hashing"`` \| ``"uploading"`` \| ``"error"`` } #### Didefinisikan di[[commitprogressevent.defined-in]] [packages/hub/src/lib/commit.ts:200](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L200) ___ ### ContentSource Ƭ **SumberKonten**: `Blob` \| `URL` #### Didefinisikan di[[contentsource.defined-in]] [packages/hub/src/lib/commit.ts:44](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L44) ___ ### 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[[dtype.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:291](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L291) ___ ### 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`** ```ts for await (const event of streamJson(blob.stream())) { if (event.type === "key") { ... } } ``` #### Didefinisikan di[[jsonstreamevent.defined-in]] [packages/hub/src/utils/streamJson.ts:27](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/utils/streamJson.ts#L27) ___ ### ModelAdditionalField Ƭ **ModelAdditionalField**: `Exclude`\ \| keyof [`ModelDerivedFields`](interfaces/ModelDerivedFields) #### Didefinisikan di[[modeladditionalfield.defined-in]] [packages/hub/src/lib/list-models.ts:50](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-models.ts#L50) ___ ### PipelineType Ƭ **PipelineType**: keyof typeof `PIPELINE_DATA` #### Didefinisikan di[[pipelinetype.defined-in]] packages/tasks/dist/commonjs/pipelines.d.ts:380 ___ ### RangeEditCache Ƭ **RangeEditCache**: `Map`\<`string`, [`RangeEditCacheEntry`](interfaces/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 rekonstruksi dan file-chunk-hashes: status merkle parsial dan hash verifikasi sudah diketahui. Lewatkan instance [RangeEditCache](modules#rangeeditcache) yang sama ke panggilan `commit` berurutan yang menambahkan ke file yang sama untuk menghindari pemanggilan API metadata CAS pada setiap penambahan. #### Didefinisikan di[[rangeeditcache.defined-in]] [packages/hub/src/utils/rangeEdit.ts:16](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/utils/rangeEdit.ts#L16) ___ ### RepoDesignation Ƭ **RepoDesignation**: [`RepoId`](interfaces/RepoId) \| [`RepoFullName`](modules#repofullname) #### Didefinisikan di[[repodesignation.defined-in]] [packages/hub/src/types/public.ts:17](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L17) ___ ### RepoFullName Ƭ **NamaLengkapRepo**: `string` \| \`spaces/$\{string}\` \| \`datasets/$\{string}\` \| \`buckets/$\{string}\` \| \`kernels/$\{string}\` #### Didefinisikan di[[repofullname.defined-in]] [packages/hub/src/types/public.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L10) ___ ### RepoType Ƭ **RepoType**: ``"space"`` \| ``"dataset"`` \| ``"model"`` \| ``"bucket"`` \| ``"kernel"`` #### Didefinisikan di[[repotype.defined-in]] [packages/hub/src/types/public.ts:3](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L3) ___ ### ResolveModelAdditionalFields Ƭ **ResolveModelAdditionalFields**\<`T`\>: `Pick`\<`ApiModelInfo`, `T` & keyof `ApiModelInfo`\> & `Pick`\<[`ModelDerivedFields`](interfaces/ModelDerivedFields), `T` & keyof [`ModelDerivedFields`](interfaces/ModelDerivedFields)\> #### Parameter tipe[[resolvemodeladditionalfields.type-parameters]] | Nama | Tipe | | :------ | :------ | | `T` | extends [`ModelAdditionalField`](modules#modeladditionalfield) | #### Didefinisikan di[[resolvemodeladditionalfields.defined-in]] [packages/hub/src/lib/list-models.ts:54](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-models.ts#L54) ___ ### SafetensorsFileHeader Ƭ **SafetensorsFileHeader**: `Record`\<[`TensorName`](modules#tensorname), [`TensorInfo`](interfaces/TensorInfo)\> & \{ `__metadata__?`: \{ `total_parameters?`: `string` \| `number` } & `Record`\<`string`, `string`\> } #### Didefinisikan di[[safetensorsfileheader.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:324](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L324) ___ ### SafetensorsParseFromRepo Ƭ **SafetensorsParseFromRepo**: \{ `filepaths`: `string`[] ; `header`: [`SafetensorsFileHeader`](modules#safetensorsfileheader) ; `parameterCount?`: `Partial`\<`Record`\<[`Dtype`](modules#dtype), `number`\>\> ; `parameterTotal?`: `number` ; `sharded`: ``false`` } \| \{ `filepaths`: `string`[] ; `headers`: [`SafetensorsShardedHeaders`](modules#safetensorsshardedheaders) ; `index`: [`SafetensorsIndexJson`](interfaces/SafetensorsIndexJson) ; `parameterCount?`: `Partial`\<`Record`\<[`Dtype`](modules#dtype), `number`\>\> ; `parameterTotal?`: `number` ; `sharded`: ``true`` } #### Didefinisikan di[[safetensorsparsefromrepo.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:348](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L348) ___ ### SafetensorsShardedHeaders Ƭ **SafetensorsShardedHeaders**: `Record`\<`FileName`, [`SafetensorsFileHeader`](modules#safetensorsfileheader)\> #### Didefinisikan di[[safetensorsshardedheaders.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:346](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L346) ___ ### 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[[spacehardwareflavor.defined-in]] [packages/hub/src/types/public.ts:53](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L53) ___ ### SpaceSdk Ƭ **SpaceSdk**: ``"streamlit"`` \| ``"gradio"`` \| ``"docker"`` \| ``"static"`` #### Didefinisikan di[[spacesdk.defined-in]] [packages/hub/src/types/public.ts:84](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L84) ___ ### SpaceStage Ƭ **SpaceStage**: ``"NO_APP_FILE"`` \| ``"CONFIG_ERROR"`` \| ``"BUILDING"`` \| ``"BUILD_ERROR"`` \| ``"RUNNING"`` \| ``"RUNNING_BUILDING"`` \| ``"RUNTIME_ERROR"`` \| ``"DELETING"`` \| ``"PAUSED"`` \| ``"SLEEPING"`` #### Didefinisikan di[[spacestage.defined-in]] [packages/hub/src/types/public.ts:86](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/types/public.ts#L86) ___ ### TensorName Ƭ **NamaTensor**: `string` #### Didefinisikan di[[tensorname.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:290](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L290) ___ ### WhoAmI Ƭ **WhoAmI**: [`WhoAmIApp`](interfaces/WhoAmIApp) \| [`WhoAmIOrg`](interfaces/WhoAmIOrg) \| [`WhoAmIUser`](interfaces/WhoAmIUser) #### Didefinisikan di[[whoami.defined-in]] [packages/hub/src/lib/who-am-i.ts:51](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/who-am-i.ts#L51) ## 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[[datasetexpandablekeys.defined-in]] [packages/hub/src/lib/list-datasets.ts:17](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-datasets.ts#L17) ___ ### DATASET\_EXPAND\_KEYS • `Const` **DATASET\_EXPAND\_KEYS**: hanya-baca [``"private"``, ``"downloads"``, ``"gated"``, ``"likes"``, ``"lastModified"``] #### Didefinisikan di[[datasetexpandkeys.defined-in]] [packages/hub/src/lib/list-datasets.ts:9](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-datasets.ts#L9) ___ ### DEFAULT\_REVISION • `Const` **DEFAULT\_REVISION**: ``"main"`` #### Didefinisikan di[[defaultrevision.defined-in]] [packages/hub/src/lib/snapshot-download.ts:13](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/snapshot-download.ts#L13) ___ ### DIFFUSERS\_SAFETENSORS\_FILE • `Const` **DIFFUSERS\_SAFETENSORS\_FILE**: ``"diffusion_pytorch_model.safetensors"`` #### Didefinisikan di[[diffuserssafetensorsfile.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:21](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L21) ___ ### DIFFUSERS\_SAFETENSORS\_INDEX\_FILE • `Const` **DIFFUSERS\_SAFETENSORS\_INDEX\_FILE**: ``"diffusion_pytorch_model.safetensors.index.json"`` #### Didefinisikan di[[diffuserssafetensorsindexfile.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:22](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L22) ___ ### DIFFUSERS\_WEIGHTS\_SUBFOLDERS • `Const` **DIFFUSERS\_WEIGHTS\_SUBFOLDERS**: hanya-baca [``"transformer"``, ``"unet"``] #### Didefinisikan di[[diffusersweightssubfolders.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:23](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L23) ___ ### HUB\_URL • `Const` **HUB\_URL**: ``"https://huggingface.co"`` URL dasar dari Hugging Face Hub. #### Didefinisikan di[[huburl.defined-in]] [packages/hub/src/consts.ts:4](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/consts.ts#L4) ___ ### MODEL\_DERIVED\_FIELD\_TO\_API\_KEY • `Const` **MODEL\_DERIVED\_FIELD\_TO\_API\_KEY**: `Record`\ #### Didefinisikan di[[modelderivedfieldtoapikey.defined-in]] [packages/hub/src/lib/list-models.ts:46](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-models.ts#L46) ___ ### 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[[modelexpandablekeys.defined-in]] [packages/hub/src/lib/list-models.ts:18](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-models.ts#L18) ___ ### MODEL\_EXPAND\_KEYS • `Const` **MODEL\_EXPAND\_KEYS**: readonly [``"pipeline_tag"``, ``"private"``, ``"gated"``, ``"downloads"``, ``"likes"``, ``"lastModified"``] #### Didefinisikan di[[modelexpandkeys.defined-in]] [packages/hub/src/lib/list-models.ts:9](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-models.ts#L9) ___ ### REGEX\_KOMIT\_HASH • `Const` **REGEX\_COMMIT\_HASH**: `RegExp` #### Didefinisikan di[[regexcommithash.defined-in]] [packages/hub/src/lib/download-file-to-cache-dir.ts:16](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/download-file-to-cache-dir.ts#L16) ___ ### REPO\_ID\_SEPARATOR • `Const` **REPO\_ID\_SEPARATOR**: `string` = `"--"` #### Didefinisikan di[[repoidseparator.defined-in]] [packages/hub/src/lib/cache-management.ts:25](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L25) ___ ### RE\_SAFETENSORS\_FILE • `Const` **RE\_SAFETENSORS\_FILE**: `RegExp` #### Didefinisikan di[[resafetensorsfile.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:26](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L26) ___ ### RE\_SAFETENSORS\_INDEX\_FILE • `Const` **RE\_SAFETENSORS\_INDEX\_FILE**: `RegExp` #### Didefinisikan di[[resafetensorsindexfile.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:27](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L27) ___ ### RE\_SAFETENSORS\_SHARD\_FILE • `Const` **RE\_SAFETENSORS\_SHARD\_FILE**: `RegExp` #### Didefinisikan di[[resafetensorsshardfile.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:28](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L28) ___ ### SAFETENSORS\_FILE • `Const` **SAFETENSORS\_FILE**: ``"model.safetensors"`` #### Didefinisikan di[[safetensorsfile.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:17](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L17) ___ ### SAFETENSORS\_INDEX\_FILE • `Const` **SAFETENSORS\_INDEX\_FILE**: ``"model.safetensors.index.json"`` #### Didefinisikan di[[safetensorsindexfile.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:18](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L18) ___ ### 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[[spaceexpandablekeys.defined-in]] [packages/hub/src/lib/list-spaces.ts:15](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-spaces.ts#L15) ___ ### SPACE\_EXPAND\_KEYS • `Const` **SPACE\_EXPAND\_KEYS**: readonly [``"sdk"``, ``"likes"``, ``"private"``, ``"lastModified"``] #### Didefinisikan di[[spaceexpandkeys.defined-in]] [packages/hub/src/lib/list-spaces.ts:9](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-spaces.ts#L9) ## Fungsi ### \_\_internal\_sha256 ▸ **__internal_sha256**(`buffer`, `opts?`): `AsyncGenerator`\<`number`, `string`\> #### Parameter[[internalsha256.parameters]] | Nama | Tipe | | :------ | :------ | | `buffer` | `Blob` | | `opts?` | `Object` | | `opts.abortSignal?` | `AbortSignal` | | `opts.useWebWorker?` | `boolean` \| \{ `minSize?`: `number` ; `poolSize?`: `number` } | #### Mengembalikan[[internalsha256.returns]] `AsyncGenerator`\<`number`, `string`\> sha yang dienkod hex **`Yields`** progress (0-1) #### Didefinisikan di[[internalsha256.defined-in]] [packages/hub/src/utils/sha256.ts:72](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/utils/sha256.ts#L72) ___ ### 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 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 (berulang kali, untuk menangkap `%252e%252e`), dan tolak apa pun yang bukan merupakan path relatif biasa. #### Parameter[[assertsafeshardfilename.parameters]] | Nama | Tipe | | :------ | :------ | | `filename` | `string` | #### Mengembalikan[[assertsafeshardfilename.returns]] `void` #### Didefinisikan di[[assertsafeshardfilename.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:511](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L511) ___ ### cancelJob ▸ **cancelJob**(`params`): `Promise`\<`ApiJob`\> Batalkan sebuah pekerjaan. #### Parameter[[canceljob.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `jobId`: `string` ; `namespace`: `string` } & `CredentialsParams` | #### Mengembalikan[[canceljob.returns]] `Promise`\<`ApiJob`\> #### Didefinisikan di[[canceljob.defined-in]] [packages/hub/src/lib/jobs/cancel-job.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/cancel-job.ts#L10) ___ ### checkRepoAccess ▸ **checkRepoAccess**(`params`): `Promise`\<`void`\> Periksa apakah kami memiliki akses baca ke repositori. Lempar error [HubApiError](classes/HubApiError) jika kami tidak memiliki akses. HubApiError.statusCode akan menjadi 401, 403, atau 404. #### Parameter[[checkrepoaccess.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[checkrepoaccess.returns]] `Promise`\<`void`\> #### Didefinisikan di[[checkrepoaccess.defined-in]] [packages/hub/src/lib/check-repo-access.ts:13](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/check-repo-access.ts#L13) ___ ### commit ▸ **commit**(`params`): `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\> #### Parameter[[commit.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | [`CommitParams`](modules#commitparams) | #### Mengembalikan[[commit.returns]] `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\> undefined untuk unggahan bucket, CommitOutput lainnya #### Didefinisikan di[[commit.defined-in]] [packages/hub/src/lib/commit.ts:1031](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L1031) ___ ### commitIter ▸ **commitIter**(`params`): `AsyncGenerator`\<[`CommitProgressEvent`](modules#commitprogressevent), [`CommitOutput`](interfaces/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[[commititer.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | [`CommitParams`](modules#commitparams) | #### Mengembalikan[[commititer.returns]] `AsyncGenerator`\<[`CommitProgressEvent`](modules#commitprogressevent), [`CommitOutput`](interfaces/CommitOutput) \| `undefined`\> #### Didefinisikan di[[commititer.defined-in]] [packages/hub/src/lib/commit.ts:219](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L219) ___ ### commitIterBucket ▸ **commitIterBucket**(`params`): `AsyncGenerator`\<[`CommitProgressEvent`](modules#commitprogressevent)\> #### Parameter[[commititerbucket.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | [`CommitParams`](modules#commitparams) | #### Mengembalikan[[commititerbucket.returns]] `AsyncGenerator`\<[`CommitProgressEvent`](modules#commitprogressevent)\> #### Didefinisikan di[[commititerbucket.defined-in]] [packages/hub/src/lib/commit.ts:775](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/commit.ts#L775) ___ ### computeNumOfParamsByDtypeSingleFile ▸ **computeNumOfParamsByDtypeSingleFile**(`header`, `quantConfig?`, `expertDtype?`): `Partial`\<`Record`\<[`Dtype`](modules#dtype), `number`\>\> Menjumlahkan parameter per dtype untuk header satu file, menerapkan faktor pengemasan kuantisasi dan melewati tensor pembukuan. #### Parameter[[computenumofparamsbydtypesinglefile.parameters]] | Nama | Tipe | | :------ | :------ | | `header` | [`SafetensorsFileHeader`](modules#safetensorsfileheader) | | `quantConfig?` | [`QuantizationConfig`](interfaces/QuantizationConfig) | | `expertDtype?` | `string` | #### Mengembalikan[[computenumofparamsbydtypesinglefile.returns]] `Partial`\<`Record`\<[`Dtype`](modules#dtype), `number`\>\> #### Didefinisikan di[[computenumofparamsbydtypesinglefile.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:1379](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L1379) ___ ### 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 (misalnya `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[[copyfile.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `destination`: [`CopyDestination`](interfaces/CopyDestination) ; `source`: [`CopySource`](interfaces/CopySource) } & `SharedParams` | #### Mengembalikan[[copyfile.returns]] `Promise`\<`undefined`\> **`Example`** ```ts 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[[copyfile.defined-in]] [packages/hub/src/lib/copy-files.ts:111](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L111) ___ ### copyFileIter ▸ **copyFileIter**(`params`): `AsyncGenerator`\<[`CopyProgressEvent`](interfaces/CopyProgressEvent), `undefined`\> Varian async-iterator dari [copyFile](modules#copyfile) yang menghasilkan [CopyProgressEvent](interfaces/CopyProgressEvent) saat mengunduh file sumber non-xet (file yang didukung xet disalin di sisi server dan tidak memancarkan event). Lihat [copyFile](modules#copyfile) untuk semantik. #### Parameter[[copyfileiter.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `destination`: [`CopyDestination`](interfaces/CopyDestination) ; `source`: [`CopySource`](interfaces/CopySource) } & `SharedParams` | #### Mengembalikan[[copyfileiter.returns]] `AsyncGenerator`\<[`CopyProgressEvent`](interfaces/CopyProgressEvent), `undefined`\> **`Example`** ```ts for await (const event of copyFileIter({ source, destination, accessToken })) { console.log(`downloaded ${event.path} (${event.downloaded}/${event.total})`); } ``` #### Didefinisikan di[[copyfileiter.defined-in]] [packages/hub/src/lib/copy-files.ts:144](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L144) ___ ### 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[[copyfiles.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `destination`: `BucketDesignation` ; `files`: [`CopyFilesEntry`](interfaces/CopyFilesEntry)[] } & `SharedParams` | #### Mengembalikan[[copyfiles.returns]] `Promise`\<`undefined`\> **`Example`** ```ts 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[[copyfiles.defined-in]] [packages/hub/src/lib/copy-files.ts:199](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L199) ___ ### copyFilesIter ▸ **copyFilesIter**(`params`): `AsyncGenerator`\<[`CopyProgressEvent`](interfaces/CopyProgressEvent), `undefined`\> Varian async-iterator dari [copyFiles](modules#copyfiles) yang menghasilkan [CopyProgressEvent](interfaces/CopyProgressEvent) saat mengunduh file sumber non-xet (file yang didukung xet disalin di sisi server dan tidak memancarkan event). Lihat [copyFiles](modules#copyfiles) untuk semantik. #### Parameter[[copyfilesiter.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `destination`: `BucketDesignation` ; `files`: [`CopyFilesEntry`](interfaces/CopyFilesEntry)[] } & `SharedParams` | #### Mengembalikan[[copyfilesiter.returns]] `AsyncGenerator`\<[`CopyProgressEvent`](interfaces/CopyProgressEvent), `undefined`\> #### Didefinisikan di[[copyfilesiter.defined-in]] [packages/hub/src/lib/copy-files.ts:219](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L219) ___ ### 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](interfaces/CopySource#path); folder sumber itu sendiri tidak dipertahankan di tujuan kecuali [CopyDestination.path](interfaces/CopyDestination#path) menyimpannya. #### Parameter[[copyfolder.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `destination`: `Omit`\<[`CopyDestination`](interfaces/CopyDestination), ``"path"``\> & \{ `path?`: `string` } ; `source`: `Omit`\<[`CopySource`](interfaces/CopySource), ``"path"``\> & \{ `path?`: `string` } } & `SharedParams` | #### Mengembalikan[[copyfolder.returns]] `Promise`\<`undefined`\> **`Example`** ```ts // 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[[copyfolder.defined-in]] [packages/hub/src/lib/copy-files.ts:277](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L277) ___ ### copyFolderIter ▸ **copyFolderIter**(`params`): `AsyncGenerator`\<[`CopyProgressEvent`](interfaces/CopyProgressEvent), `undefined`\> Varian async-iterator dari [copyFolder](modules#copyfolder) yang menghasilkan [CopyProgressEvent](interfaces/CopyProgressEvent) saat mengunduh file sumber non-xet (file yang didukung xet disalin di sisi server dan tidak memancarkan event). Lihat [copyFolder](modules#copyfolder) untuk semantik. #### Parameter[[copyfolderiter.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `destination`: `Omit`\<[`CopyDestination`](interfaces/CopyDestination), ``"path"``\> & \{ `path?`: `string` } ; `source`: `Omit`\<[`CopySource`](interfaces/CopySource), ``"path"``\> & \{ `path?`: `string` } } & `SharedParams` | #### Mengembalikan[[copyfolderiter.returns]] `AsyncGenerator`\<[`CopyProgressEvent`](interfaces/CopyProgressEvent), `undefined`\> #### Didefinisikan di[[copyfolderiter.defined-in]] [packages/hub/src/lib/copy-files.ts:297](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L297) ___ ### countCommits ▸ **countCommits**(`params`): `Promise`\<`number`\> #### Parameter[[countcommits.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[countcommits.returns]] `Promise`\<`number`\> #### Didefinisikan di[[countcommits.defined-in]] [packages/hub/src/lib/count-commits.ts:7](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/count-commits.ts#L7) ___ ### createBranch ▸ **createBranch**(`params`): `Promise`\<`void`\> #### Parameter[[createbranch.parameters]] | Nama | Tipe | Deskripsi | | :------ | :------ | :------ | | `params` | `Object` | - | | `params.accessToken?` | `string` | - | | `params.branch` | `string` | Nama cabang yang akan dibuat | | `params.empty?` | `boolean` | Gunakan ini untuk membuat cabang kosong, tanpa commit. | | `params.fetch?` | (`input`: `URL` \| `RequestInfo`, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> | [Referensi MDN](https://developer.mozilla.org/docs/Web/API/Window/fetch) | | `params.hubUrl?` | `string` | - | | `params.overwrite?` | `boolean` | Gunakan ini untuk menimpa cabang jika sudah ada. Jika Anda hanya menentukan `overwrite` tanpa `revision`/`empty`, dan cabang sudah ada, maka tidak akan ada efek apa pun. | | `params.repo` | [`RepoDesignation`](modules#repodesignation) | - | | `params.revision?` | `string` | Revisi untuk membuat cabang dari. Secara default menggunakan cabang default. Gunakan empty: true untuk membuat cabang kosong. | #### Mengembalikan[[createbranch.returns]] `Promise`\<`void`\> #### Didefinisikan di[[createbranch.defined-in]] [packages/hub/src/lib/create-branch.ts:6](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/create-branch.ts#L6) ___ ### createCollection ▸ **createCollection**(`params`): `Promise`\<\{ `slug`: `string` }\> #### Parameter[[createcollection.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `collection`: `ApiCreateCollectionPayload` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[createcollection.returns]] `Promise`\<\{ `slug`: `string` }\> #### Didefinisikan di[[createcollection.defined-in]] [packages/hub/src/lib/create-collection.ts:7](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/create-collection.ts#L7) ___ ### createRepo ▸ **createRepo**(`params`): `Promise`\<\{ `id`: `string` ; `repoUrl`: `string` }\> #### Parameter[[createrepo.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `files?`: \{ `content`: `ArrayBuffer` \| `Blob` ; `path`: `string` }[] ; `hardware?`: SpaceHardwareFlavor \| undefined ; `hubUrl?`: `string` ; `license?`: `string` ; `private?`: `boolean` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `resourceGroupId?`: `string` ; `sdk?`: SpaceSdk \| undefined ; `visibility?`: ``"public"`` \| ``"private"`` \| ``"protected"`` } & `CredentialsParams` | #### Mengembalikan[[createrepo.returns]] `Promise`\<\{ `id`: `string` ; `repoUrl`: `string` }\> #### Didefinisikan di[[createrepo.defined-in]] [packages/hub/src/lib/create-repo.ts:9](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/create-repo.ts#L9) ___ ### createScheduledJob ▸ **createScheduledJob**(`params`): `Promise`\<`ApiScheduledJob`\> Buat tugas terjadwal. #### Parameter[[createscheduledjob.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `namespace`: `string` } & CreateScheduledJobOptions & CredentialsParams | #### Mengembalikan[[createscheduledjob.returns]] `Promise`\<`ApiScheduledJob`\> #### Didefinisikan di[[createscheduledjob.defined-in]] [packages/hub/src/lib/jobs/create-scheduled-job.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/create-scheduled-job.ts#L11) ___ ### datasetInfo ▸ **datasetInfo**\<`T`\>(`params`): `Promise`\<[`DatasetEntry`](interfaces/DatasetEntry) & `Pick`\<`ApiDatasetInfo`, `T`\>\> #### Parameter tipe[[datasetinfo.type-parameters]] | Nama | Tipe | | :------ | :------ | | `T` | extends ``"author"`` \| ``"cardData"`` \| ``"disabled"`` \| ``"gitalyUid"`` \| ``"createdAt"`` \| ``"tags"`` \| ``"paperswithcode_id"`` \| ``"sha"`` \| ``"citation"`` \| ``"description"`` \| ``"downloadsAllTime"`` = `never` | #### Parameter[[datasetinfo.parameters]] | Nama | Tipe | | :------ | :------ | | `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`\> | #### Mengembalikan[[datasetinfo.returns]] `Promise`\<[`DatasetEntry`](interfaces/DatasetEntry) & `Pick`\<`ApiDatasetInfo`, `T`\>\> #### Didefinisikan di[[datasetinfo.defined-in]] [packages/hub/src/lib/dataset-info.ts:9](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/dataset-info.ts#L9) ___ ### deleteBranch ▸ **deleteBranch**(`params`): `Promise`\<`void`\> #### Parameter[[deletebranch.parameters]] | Nama | Tipe | Deskripsi | | :------ | :------ | :------ | | `params` | `Object` | - | | `params.accessToken?` | `string` | - | | `params.branch` | `string` | Nama cabang yang akan dihapus | | `params.fetch?` | (`input`: `URL` \| `RequestInfo`, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> | [Referensi MDN](https://developer.mozilla.org/docs/Web/API/Window/fetch) | | `params.hubUrl?` | `string` | - | | `params.repo` | [`RepoDesignation`](modules#repodesignation) | - | #### Mengembalikan[[deletebranch.returns]] `Promise`\<`void`\> #### Didefinisikan di[[deletebranch.defined-in]] [packages/hub/src/lib/delete-branch.ts:6](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/delete-branch.ts#L6) ___ ### deleteCollection ▸ **deleteCollection**(`params`): `Promise`\<`void`\> #### Parameter[[deletecollection.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `slug`: `string` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[deletecollection.returns]] `Promise`\<`void`\> #### Didefinisikan di[[deletecollection.defined-in]] [packages/hub/src/lib/delete-collection.ts:6](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/delete-collection.ts#L6) ___ ### deleteFile ▸ **deleteFile**(`params`): `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\> #### Parameter[[deletefile.parameters]] | Nama | Tipe | | :------ | :------ | | `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`](modules#repodesignation) } & `CredentialsParams` | #### Mengembalikan[[deletefile.returns]] `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\> #### Didefinisikan di[[deletefile.defined-in]] [packages/hub/src/lib/delete-file.ts:5](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/delete-file.ts#L5) ___ ### deleteFiles ▸ **deleteFiles**(`params`): `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\> #### Parameter[[deletefiles.parameters]] | Nama | Tipe | | :------ | :------ | | `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`](modules#repodesignation) } & `CredentialsParams` | #### Mengembalikan[[deletefiles.returns]] `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\> #### Didefinisikan di[[deletefiles.defined-in]] [packages/hub/src/lib/delete-files.ts:5](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/delete-files.ts#L5) ___ ### deleteRepo ▸ **deleteRepo**(`params`): `Promise`\<`void`\> #### Parameter[[deleterepo.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) } & `CredentialsParams` | #### Mengembalikan[[deleterepo.returns]] `Promise`\<`void`\> #### Didefinisikan di[[deleterepo.defined-in]] [packages/hub/src/lib/delete-repo.ts:7](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/delete-repo.ts#L7) ___ ### deleteScheduledJob ▸ **deleteScheduledJob**(`params`): `Promise`\<`void`\> Hapus pekerjaan terjadwal. #### Parameter[[deletescheduledjob.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `jobId`: `string` ; `namespace`: `string` } & `CredentialsParams` | #### Mengembalikan[[deletescheduledjob.returns]] `Promise`\<`void`\> #### Didefinisikan di[[deletescheduledjob.defined-in]] [packages/hub/src/lib/jobs/delete-scheduled-job.ts:9](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/delete-scheduled-job.ts#L9) ___ ### downloadFile ▸ **downloadFile**(`params`): `Promise`\<`Blob` \| ``null``\> #### Parameter[[downloadfile.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `downloadInfo?`: [`FileDownloadInfoOutput`](interfaces/FileDownloadInfoOutput) ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `parallelDownloads?`: `boolean` \| [`ParallelDownloadOptions`](interfaces/ParallelDownloadOptions) ; `path`: `string` ; `raw?`: `boolean` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string` ; `xet?`: `boolean` \| \{ `readToken`: [`XetReadToken`](interfaces/XetReadToken) } } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[downloadfile.returns]] `Promise`\<`Blob` \| ``null``\> null jika file tidak ada #### Didefinisikan di[[downloadfile.defined-in]] [packages/hub/src/lib/download-file.ts:13](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/download-file.ts#L13) ___ ### downloadFileToCacheDir ▸ **downloadFileToCacheDir**(`params`): `Promise`\<`string`\> Unduh file tertentu jika belum ada di cache lokal. #### Parameter[[downloadfiletocachedir.parameters]] | Nama | Tipe | | :------ | :------ | | `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`](modules#repodesignation) ; `revision?`: `string` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[downloadfiletocachedir.returns]] `Promise`\<`string`\> symlink ke objek blob #### Didefinisikan di[[downloadfiletocachedir.defined-in]] [packages/hub/src/lib/download-file-to-cache-dir.ts:46](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/download-file-to-cache-dir.ts#L46) ___ ### duplicateJob ▸ **duplicateJob**(`params`): `Promise`\<`ApiJob`\> Duplikasi pekerjaan (jalankan ulang dengan spesifikasi yang sama). #### Parameter[[duplicatejob.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `jobId`: `string` ; `namespace`: `string` } & `CredentialsParams` | #### Mengembalikan[[duplicatejob.returns]] `Promise`\<`ApiJob`\> #### Didefinisikan di[[duplicatejob.defined-in]] [packages/hub/src/lib/jobs/duplicate-job.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/duplicate-job.ts#L10) ___ ### encodeShardFilename ▸ **encodeShardFilename**(`filename`): `string` Pertahanan berlapis: URL unduhan dibangun melalui interpolasi string, sehingga enkripsi setiap segmen path dari nama file (yang sudah divalidasi) dilakukan, bukan dengan mempercayai bahwa nama file tersebut aman untuk URL. #### Parameter[[encodeshardfilename.parameters]] | Nama | Tipe | | :------ | :------ | | `filename` | `string` | #### Mengembalikan[[encodeshardfilename.returns]] `string` #### Didefinisikan di[[encodeshardfilename.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:570](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L570) ___ ### fileDownloadInfo ▸ **fileDownloadInfo**(`params`): `Promise`\<[`FileDownloadInfoOutput`](interfaces/FileDownloadInfoOutput) \| ``null``\> #### Parameter[[filedownloadinfo.parameters]] | Nama | Tipe | | :------ | :------ | | `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`](modules#repodesignation) ; `revision?`: `string` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[filedownloadinfo.returns]] `Promise`\<[`FileDownloadInfoOutput`](interfaces/FileDownloadInfoOutput) \| ``null``\> null jika file tidak ada #### Didefinisikan di[[filedownloadinfo.defined-in]] [packages/hub/src/lib/file-download-info.ts:27](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/file-download-info.ts#L27) ___ ### fileExists ▸ **fileExists**(`params`): `Promise`\<`boolean`\> #### Parameter[[fileexists.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `path`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[fileexists.returns]] `Promise`\<`boolean`\> #### Didefinisikan di[[fileexists.defined-in]] [packages/hub/src/lib/file-exists.ts:7](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/file-exists.ts#L7) ___ ### getBlobStat ▸ **getBlobStat**(`blobPath`, `blobStats`): `Promise`\<`Stats`\> #### Parameter[[getblobstat.parameters]] | Nama | Tipe | | :------ | :------ | | `blobPath` | `string` | | `blobStats` | `Map`\<`string`, `Stats`\> | #### Mengembalikan[[getblobstat.returns]] `Promise`\<`Stats`\> #### Didefinisikan di[[getblobstat.defined-in]] [packages/hub/src/lib/cache-management.ts:254](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L254) ___ ### getHFHubCachePath ▸ **getHFHubCachePath**(): `string` #### Mengembalikan[[gethfhubcachepath.returns]] `string` #### Didefinisikan di[[gethfhubcachepath.defined-in]] [packages/hub/src/lib/cache-management.ts:19](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L19) ___ ### getJob ▸ **getJob**(`params`): `Promise`\<`ApiJob`\> Dapatkan pekerjaan tertentu berdasarkan ID. #### Parameter[[getjob.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `jobId`: `string` ; `namespace`: `string` } & `CredentialsParams` | #### Mengembalikan[[getjob.returns]] `Promise`\<`ApiJob`\> #### Didefinisikan di[[getjob.defined-in]] [packages/hub/src/lib/jobs/get-job.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/get-job.ts#L10) ___ ### getQuantizationMultiplier ▸ **getQuantizationMultiplier**(`tensorName`, `dtype`, `quantConfig?`, `expertDtype?`, `mlxQuantizedModules?`): `number` Mendapatkan pengali parameter untuk tensor terkuantisasi berdasarkan metode kuantisasi. Bisa berupa pecahan — lihat `packingFactor`. #### Parameter[[getquantizationmultiplier.parameters]] | Nama | Tipe | | :------ | :------ | | `tensorName` | `string` | | `dtype` | [`Dtype`](modules#dtype) | | `quantConfig?` | [`QuantizationConfig`](interfaces/QuantizationConfig) | | `expertDtype?` | `string` | | `mlxQuantizedModules?` | `ReadonlySet`\<`string`\> | #### Mengembalikan[[getquantizationmultiplier.returns]] `number` #### Didefinisikan di[[getquantizationmultiplier.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:1259](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L1259) ___ ### getRepoFolderName ▸ **getRepoFolderName**(`«destructured»`): `string` #### Parameter[[getrepofoldername.parameters]] | Nama | Tipe | | :------ | :------ | | `«destructured»` | [`RepoId`](interfaces/RepoId) | #### Mengembalikan[[getrepofoldername.returns]] `string` #### Didefinisikan di[[getrepofoldername.defined-in]] [packages/hub/src/lib/cache-management.ts:27](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L27) ___ ### getScheduledJob ▸ **getScheduledJob**(`params`): `Promise`\<`ApiScheduledJob`\> Dapatkan pekerjaan terjadwal tertentu berdasarkan ID. #### Parameter[[getscheduledjob.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `jobId`: `string` ; `namespace`: `string` } & `CredentialsParams` | #### Mengembalikan[[getscheduledjob.returns]] `Promise`\<`ApiScheduledJob`\> #### Didefinisikan di[[getscheduledjob.defined-in]] [packages/hub/src/lib/jobs/get-scheduled-job.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/get-scheduled-job.ts#L10) ___ ### 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[[globmatch.parameters]] | Nama | Tipe | | :------ | :------ | | `pattern` | `string` | | `str` | `string` | #### Mengembalikan[[globmatch.returns]] `boolean` #### Didefinisikan di[[globmatch.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:1153](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L1153) ___ ### 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[[isquantizedtensor.parameters]] | Nama | Tipe | | :------ | :------ | | `tensorName` | `string` | | `quantConfig?` | [`QuantizationConfig`](interfaces/QuantizationConfig) | | `mlxQuantizedModules?` | `ReadonlySet`\<`string`\> | #### Mengembalikan[[isquantizedtensor.returns]] `boolean` #### Didefinisikan di[[isquantizedtensor.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:1189](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L1189) ___ ### listCollections ▸ **listCollections**(`params?`): `AsyncGenerator`\<`ApiCollectionInfo`\> #### Parameter[[listcollections.parameters]] | Nama | Tipe | | :------ | :------ | | `params?` | \{ search?: \{ owner?: string[] \| undefined; item?: string[] \| undefined; q?: string \| undefined; } \| undefined; sort?: "lastModified" \| "trending" \| "upvotes" \| undefined; limit?: number \| undefined; hubUrl?: string \| undefined; fetch?: \{ ...; } \| undefined; } & Partial\<...\> | #### Mengembalikan[[listcollections.returns]] `AsyncGenerator`\<`ApiCollectionInfo`\> #### Didefinisikan di[[listcollections.defined-in]] [packages/hub/src/lib/list-collections.ts:12](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-collections.ts#L12) ___ ### listCommits ▸ **listCommits**(`params`): `AsyncGenerator`\<[`CommitData`](interfaces/CommitData)\> #### Parameter[[listcommits.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `batchSize?`: `number` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[listcommits.returns]] `AsyncGenerator`\<[`CommitData`](interfaces/CommitData)\> #### Didefinisikan di[[listcommits.defined-in]] [packages/hub/src/lib/list-commits.ts:17](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-commits.ts#L17) ___ ### listDatasets ▸ **listDatasets**\<`T`\>(`params?`): `AsyncGenerator`\<[`DatasetEntry`](interfaces/DatasetEntry) & `Pick`\<`ApiDatasetInfo`, `T`\>\> #### Parameter tipe[[listdatasets.type-parameters]] | Nama | Tipe | | :------ | :------ | | `T` | extends ``"author"`` \| ``"cardData"`` \| ``"disabled"`` \| ``"gitalyUid"`` \| ``"createdAt"`` \| ``"tags"`` \| ``"paperswithcode_id"`` \| ``"sha"`` \| ``"citation"`` \| ``"description"`` \| ``"downloadsAllTime"`` = `never` | #### Parameter[[listdatasets.parameters]] | Nama | Tipe | | :------ | :------ | | `params?` | \{ search?: \{ query?: string \| undefined; owner?: string \| undefined; tags?: string[] \| undefined; } \| undefined; hubUrl?: string \| undefined; additionalFields?: T[] \| undefined; limit?: number \| undefined; sort?: "id" \| ... 8 more ... \| undefined; fetch?: \{ ...; } \| undefined; } & Partial\<...\> | #### Mengembalikan[[listdatasets.returns]] `AsyncGenerator`\<[`DatasetEntry`](interfaces/DatasetEntry) & `Pick`\<`ApiDatasetInfo`, `T`\>\> #### Didefinisikan di[[listdatasets.defined-in]] [packages/hub/src/lib/list-datasets.ts:47](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-datasets.ts#L47) ___ ### listFiles ▸ **listFiles**(`params`): `AsyncGenerator`\<[`ListFileEntry`](interfaces/ListFileEntry)\> Daftarkan file dalam folder. Untuk mendaftar SEMUA file dalam direktori, panggil dengan params.recursive diatur ke `true`. #### Parameter[[listfiles.parameters]] | Nama | Tipe | | :------ | :------ | | `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`](modules#repodesignation) ; `revision?`: `string` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[listfiles.returns]] `AsyncGenerator`\<[`ListFileEntry`](interfaces/ListFileEntry)\> #### Didefinisikan di[[listfiles.defined-in]] [packages/hub/src/lib/list-files.ts:53](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-files.ts#L53) ___ ### 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[[listjobhardware.parameters]] | Nama | Tipe | | :------ | :------ | | `params?` | \{ hubUrl?: string \| undefined; fetch?: \{ (input: URL \| RequestInfo, init?: RequestInit \| undefined): Promise\; (input: string \| ... 1 more ... \| Request, init?: RequestInit \| undefined): Promise\<...\>; } \| undefined; } & Partial\<...\> | #### Mengembalikan[[listjobhardware.returns]] `Promise`\<`ApiJobHardware`[]\> #### Didefinisikan di[[listjobhardware.defined-in]] [packages/hub/src/lib/jobs/list-job-hardware.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/list-job-hardware.ts#L11) ___ ### listJobs ▸ **listJobs**(`params`): `Promise`\<`ApiJob`[]\> Daftarkan pekerjaan untuk namespace (pengguna atau organisasi). #### Parameter[[listjobs.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `namespace`: `string` } & `CredentialsParams` | #### Mengembalikan[[listjobs.returns]] `Promise`\<`ApiJob`[]\> #### Didefinisikan di[[listjobs.defined-in]] [packages/hub/src/lib/jobs/list-jobs.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/list-jobs.ts#L10) ___ ### listModels ▸ **listModels**\<`T`\>(`params?`): `AsyncGenerator`\<[`ModelEntry`](interfaces/ModelEntry) & [`ResolveModelAdditionalFields`](modules#resolvemodeladditionalfields)\<`T`\>\> #### Parameter tipe[[listmodels.type-parameters]] | Nama | Tipe | | :------ | :------ | | `T` | extends [`ModelAdditionalField`](modules#modeladditionalfield) = `never` | #### Parameter[[listmodels.parameters]] | Nama | Tipe | | :------ | :------ | | `params?` | \{ search?: \{ query?: string \| undefined; owner?: string \| undefined; task?: "other" \| "text-classification" \| "token-classification" \| "table-question-answering" \| "question-answering" \| ... 52 more ... \| undefined; tags?: string[] \| undefined; inferenceProviders?: string[] \| undefined; apps?: string[] \| undefined; ... | #### Mengembalikan[[listmodels.returns]] `AsyncGenerator`\<[`ModelEntry`](interfaces/ModelEntry) & [`ResolveModelAdditionalFields`](modules#resolvemodeladditionalfields)\<`T`\>\> #### Didefinisikan di[[listmodels.defined-in]] [packages/hub/src/lib/list-models.ts:68](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-models.ts#L68) ___ ### listScheduledJobs ▸ **listScheduledJobs**(`params`): `Promise`\<`ApiScheduledJob`[]\> Daftarkan pekerjaan terjadwal untuk namespace. #### Parameter[[listscheduledjobs.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `namespace`: `string` } & `CredentialsParams` | #### Mengembalikan[[listscheduledjobs.returns]] `Promise`\<`ApiScheduledJob`[]\> #### Didefinisikan di[[listscheduledjobs.defined-in]] [packages/hub/src/lib/jobs/list-scheduled-jobs.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/list-scheduled-jobs.ts#L10) ___ ### listSpaces ▸ **listSpaces**\<`T`\>(`params?`): `AsyncGenerator`\<[`SpaceEntry`](interfaces/SpaceEntry) & `Pick`\<`ApiSpaceInfo`, `T`\>\> #### Parameter tipe[[listspaces.type-parameters]] | Nama | Tipe | | :------ | :------ | | `T` | extends ``"models"`` \| ``"datasets"`` \| ``"author"`` \| ``"cardData"`` \| ``"disabled"`` \| ``"gitalyUid"`` \| ``"createdAt"`` \| ``"tags"`` \| ``"sha"`` \| ``"subdomain"`` \| ``"runtime"`` = `never` | #### Parameter[[listspaces.parameters]] | Nama | Tipe | | :------ | :------ | | `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\<...\>; }... | #### Mengembalikan[[listspaces.returns]] `AsyncGenerator`\<[`SpaceEntry`](interfaces/SpaceEntry) & `Pick`\<`ApiSpaceInfo`, `T`\>\> #### Didefinisikan di[[listspaces.defined-in]] [packages/hub/src/lib/list-spaces.ts:44](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/list-spaces.ts#L44) ___ ### 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[[matchescompressedtensorstarget.parameters]] | Nama | Tipe | | :------ | :------ | | `target` | `string` | | `moduleName` | `string` | #### Mengembalikan[[matchescompressedtensorstarget.returns]] `boolean` #### Didefinisikan di[[matchescompressedtensorstarget.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:1231](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L1231) ___ ### modelInfo ▸ **modelInfo**\<`T`\>(`params`): `Promise`\<[`ModelEntry`](interfaces/ModelEntry) & [`ResolveModelAdditionalFields`](modules#resolvemodeladditionalfields)\<`T`\>\> #### Parameter tipe[[modelinfo.type-parameters]] | Nama | Tipe | | :------ | :------ | | `T` | extends [`ModelAdditionalField`](modules#modeladditionalfield) = `never` | #### Parameter[[modelinfo.parameters]] | Nama | Tipe | | :------ | :------ | | `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`\> | #### Mengembalikan[[modelinfo.returns]] `Promise`\<[`ModelEntry`](interfaces/ModelEntry) & [`ResolveModelAdditionalFields`](modules#resolvemodeladditionalfields)\<`T`\>\> #### Didefinisikan di[[modelinfo.defined-in]] [packages/hub/src/lib/model-info.ts:16](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/model-info.ts#L16) ___ ### oauthHandleRedirect ▸ **oauthHandleRedirect**(`opts?`): `Promise`\<[`OAuthResult`](interfaces/OAuthResult)\> Untuk dipanggil setelah penyedia OAuth mengalihkan kembali ke aplikasi. Terdapat juga fungsi bantu [oauthHandleRedirectIfPresent](modules#oauthhandleredirectifpresent), yang akan memanggil `oauthHandleRedirect` jika URL berisi kode oauth dalam parameter query dan mengembalikan `false` jika tidak. #### Parameter[[oauthhandleredirect.parameters]] | Nama | Tipe | Deskripsi | | :------ | :------ | :------ | | `opts?` | `Object` | - | | `opts.codeVerifier?` | `string` | codeVerifier yang dihasilkan oleh oauthLoginUrl **`Default`** ```ts localStorage.getItem("huggingface.co:oauth:code_verifier") ``` | | `opts.hubUrl?` | `string` | URL dari hub. Bawaan adalah [HUB_URL](modules#hub_url). | | `opts.nonce?` | `string` | nonce yang dihasilkan oleh oauthLoginUrl **`Default`** ```ts localStorage.getItem("huggingface.co:oauth:nonce") ``` | | `opts.redirectedUrl?` | `string` | URL yang akan dianalisis. **`Default`** ```ts window.location.href ``` | #### Mengembalikan[[oauthhandleredirect.returns]] `Promise`\<[`OAuthResult`](interfaces/OAuthResult)\> #### Didefinisikan di[[oauthhandleredirect.defined-in]] [packages/hub/src/lib/oauth-handle-redirect.ts:123](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/oauth-handle-redirect.ts#L123) ___ ### oauthHandleRedirectIfPresent ▸ **oauthHandleRedirectIfPresent**(`opts?`): `Promise`\<[`OAuthResult`](interfaces/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](modules#oauthhandleredirect). Tergantung pada aplikasi Anda, Anda mungkin ingin memanggil [oauthHandleRedirect](modules#oauthhandleredirect) secara langsung sebagai gantinya. #### Parameter[[oauthhandleredirectifpresent.parameters]] | Nama | Tipe | Deskripsi | | :------ | :------ | :------ | | `opts?` | `Object` | - | | `opts.codeVerifier?` | `string` | codeVerifier yang dihasilkan oleh oauthLoginUrl **`Default`** ```ts localStorage.getItem("huggingface.co:oauth:code_verifier") ``` | | `opts.hubUrl?` | `string` | URL dari hub. Bawaan adalah [HUB_URL](modules#hub_url). | | `opts.nonce?` | `string` | nonce yang dihasilkan oleh oauthLoginUrl **`Default`** ```ts localStorage.getItem("huggingface.co:oauth:nonce") ``` | | `opts.redirectedUrl?` | `string` | URL yang akan dianalisis. **`Default`** ```ts window.location.href ``` | #### Mengembalikan[[oauthhandleredirectifpresent.returns]] `Promise`\<[`OAuthResult`](interfaces/OAuthResult) \| ``false``\> #### Didefinisikan di[[oauthhandleredirectifpresent.defined-in]] [packages/hub/src/lib/oauth-handle-redirect.ts:293](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/oauth-handle-redirect.ts#L293) ___ ### 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 client ID dari aplikasi OAuth Anda. #### Parameter[[oauthloginurl.parameters]] | Nama | Tipe | Deskripsi | | :------ | :------ | :------ | | `opts?` | `Object` | - | | `opts.clientId?` | `string` | OAuth client ID. Untuk Spaces statis, Anda dapat mengabaikan ini dan nilai akan dimuat dari konfigurasi Space, selama `hf_oauth: true` hadir di metadata README.md. Untuk Spaces lainnya, nilai ini tersedia di backend melalui variabel lingkungan OAUTH_CLIENT_ID, selama `hf_oauth: true` hadir di metadata README.md. Anda juga dapat membuat Developer Application di https://huggingface.co/settings/connected-applications dan menggunakan client ID-nya. | | `opts.hubUrl?` | `string` | - | | `opts.localStorage?` | `Object` | Jika diberikan, akan diisi dengan kode verifier dan nonce yang digunakan untuk alur OAuth, alih-alih menggunakan localStorage. Saat memanggil `oauthHandleRedirectIfPresent` atau `oauthHandleRedirect`, Anda perlu memberikan nilai yang sama. | | `opts.localStorage.codeVerifier?` | `string` | - | | `opts.localStorage.nonce?` | `string` | - | | `opts.redirectUrl?` | `string` | Redirect URI, secara default menggunakan URL saat ini. Untuk Spaces, URL apa pun di dalam Space diizinkan. Untuk Developer Applications, Anda dapat menambahkan URL apa pun yang Anda inginkan ke daftar redirect URI yang diizinkan di https://huggingface.co/settings/connected-applications. | | `opts.scopes?` | `string` | OAuth scope, daftar scope yang dipisahkan spasi. Untuk Spaces statis, Anda dapat mengabaikan ini dan ia akan dimuat dari konfigurasi Spaces, selama `hf_oauth: true` hadir di metadata README.md. Untuk Spaces lainnya, ini tersedia untuk backend dalam variabel lingkungan OAUTH_SCOPES, selama `hf_oauth: true` hadir di metadata README.md. Default-nya adalah "openid profile". Anda juga dapat membuat Developer Application di https://huggingface.co/settings/connected-applications dan menggunakan scope-nya. Lihat https://huggingface.co/docs/hub/oauth untuk daftar scope yang tersedia. | | `opts.state?` | `string` | State yang akan diteruskan ke penyedia OAuth, yang akan dikembalikan dalam panggilan ke `oauthLogin` setelah redirect. | #### Mengembalikan[[oauthloginurl.returns]] `Promise`\<`string`\> **`Example`** ```ts 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`, tetapi saat ini hanya diuji dengan Hugging Face Hub.) #### Didefinisikan di[[oauthloginurl.defined-in]] [packages/hub/src/lib/oauth-login-url.ts:31](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/oauth-login-url.ts#L31) ___ ### parseRepoType ▸ **parseRepoType**(`type`): [`RepoType`](modules#repotype) #### Parameter[[parserepotype.parameters]] | Nama | Tipe | | :------ | :------ | | `type` | `string` | #### Mengembalikan[[parserepotype.returns]] [`RepoType`](modules#repotype) #### Didefinisikan di[[parserepotype.defined-in]] [packages/hub/src/lib/cache-management.ts:264](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L264) ___ ### parseSafetensorsMetadata ▸ **parseSafetensorsMetadata**(`params`): `Promise`\<`SetRequired`\<[`SafetensorsParseFromRepo`](modules#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[[parsesafetensorsmetadata.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `computeParametersCount`: ``true`` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `library?`: `string` ; `path?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string` ; `useSafetensorsMetadataEndpoint?`: `boolean` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[parsesafetensorsmetadata.returns]] `Promise`\<`SetRequired`\<[`SafetensorsParseFromRepo`](modules#safetensorsparsefromrepo), ``"parameterCount"``\>\> #### Didefinisikan di[[parsesafetensorsmetadata.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:738](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L738) ▸ **parseSafetensorsMetadata**(`params`): `Promise`\<[`SafetensorsParseFromRepo`](modules#safetensorsparsefromrepo)\> #### Parameter[[parsesafetensorsmetadata.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `computeParametersCount?`: `boolean` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `library?`: `string` ; `path?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string` ; `useSafetensorsMetadataEndpoint?`: `boolean` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[parsesafetensorsmetadata.returns]] `Promise`\<[`SafetensorsParseFromRepo`](modules#safetensorsparsefromrepo)\> #### Didefinisikan di[[parsesafetensorsmetadata.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:775](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L775) ___ ### parseSafetensorsShardFilename ▸ **parseSafetensorsShardFilename**(`filename`): [`SafetensorsShardFileInfo`](interfaces/SafetensorsShardFileInfo) \| ``null`` #### Parameter[[parsesafetensorsshardfilename.parameters]] | Nama | Tipe | | :------ | :------ | | `filename` | `string` | #### Mengembalikan[[parsesafetensorsshardfilename.returns]] [`SafetensorsShardFileInfo`](interfaces/SafetensorsShardFileInfo) \| ``null`` #### Didefinisikan di[[parsesafetensorsshardfilename.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:36](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L36) ___ ### 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[[parsetotalparameters.parameters]] | Nama | Tipe | | :------ | :------ | | `value` | `undefined` \| `string` \| `number` | | `computedTotal?` | `number` | #### Mengembalikan[[parsetotalparameters.returns]] `number` \| `undefined` #### Didefinisikan di[[parsetotalparameters.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:699](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L699) ___ ### pathsInfo ▸ **pathsInfo**(`params`): `Promise`\<[`PathInfo`](interfaces/PathInfo) & \{ `lastCommit`: [`CommitInfo`](interfaces/CommitInfo) ; `securityFileStatus`: [`SecurityFileStatus`](interfaces/SecurityFileStatus) }[]\> #### Parameter[[pathsinfo.parameters]] | Nama | Tipe | | :------ | :------ | | `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`](modules#repodesignation) ; `revision?`: `string` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[pathsinfo.returns]] `Promise`\<[`PathInfo`](interfaces/PathInfo) & \{ `lastCommit`: [`CommitInfo`](interfaces/CommitInfo) ; `securityFileStatus`: [`SecurityFileStatus`](interfaces/SecurityFileStatus) }[]\> #### Didefinisikan di[[pathsinfo.defined-in]] [packages/hub/src/lib/paths-info.ts:51](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/paths-info.ts#L51) ▸ **pathsInfo**(`params`): `Promise`\<[`PathInfo`](interfaces/PathInfo)[]\> #### Parameter[[pathsinfo.parameters]] | Nama | Tipe | | :------ | :------ | | `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`](modules#repodesignation) ; `revision?`: `string` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[pathsinfo.returns]] `Promise`\<[`PathInfo`](interfaces/PathInfo)[]\> #### Didefinisikan di[[pathsinfo.defined-in]] [packages/hub/src/lib/paths-info.ts:64](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/paths-info.ts#L64) ___ ### 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[[relativeunderfolder.parameters]] | Nama | Tipe | | :------ | :------ | | `filePath` | `string` | | `folderPath` | `string` | #### Mengembalikan[[relativeunderfolder.returns]] `string` #### Didefinisikan di[[relativeunderfolder.defined-in]] [packages/hub/src/lib/copy-files.ts:558](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/copy-files.ts#L558) ___ ### repoExists ▸ **repoExists**(`params`): `Promise`\<`boolean`\> #### Parameter[[repoexists.parameters]] | Nama | Tipe | Deskripsi | | :------ | :------ | :------ | | `params` | `Object` | - | | `params.accessToken?` | `string` | - | | `params.fetch?` | (`input`: `URL` \| `RequestInfo`, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> | Fungsi fetch kustom untuk digunakan sebagai pengganti fungsi default, misalnya untuk menggunakan proxy atau mengedit header. | | `params.hubUrl?` | `string` | - | | `params.repo` | [`RepoDesignation`](modules#repodesignation) | - | | `params.revision?` | `string` | ID revisi Git opsional yang dapat berupa nama cabang, tag, atau hash commit. | #### Mengembalikan[[repoexists.returns]] `Promise`\<`boolean`\> #### Didefinisikan di[[repoexists.defined-in]] [packages/hub/src/lib/repo-exists.ts:6](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/repo-exists.ts#L6) ___ ### resumeScheduledJob ▸ **resumeScheduledJob**(`params`): `Promise`\<`void`\> Lanjutkan pekerjaan terjadwal. #### Parameter[[resumescheduledjob.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `jobId`: `string` ; `namespace`: `string` } & `CredentialsParams` | #### Mengembalikan[[resumescheduledjob.returns]] `Promise`\<`void`\> #### Didefinisikan di[[resumescheduledjob.defined-in]] [packages/hub/src/lib/jobs/resume-scheduled-job.ts:9](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/resume-scheduled-job.ts#L9) ___ ### runJob ▸ **runJob**(`params`): `Promise`\<`ApiJob`\> Jalankan tugas baru. #### Parameter[[runjob.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `namespace`: `string` } & CreateJobOptions & CredentialsParams | #### Mengembalikan[[runjob.returns]] `Promise`\<`ApiJob`\> #### Didefinisikan di[[runjob.defined-in]] [packages/hub/src/lib/jobs/run-job.ts:12](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/run-job.ts#L12) ___ ### runScheduledJob ▸ **runScheduledJob**(`params`): `Promise`\<`ApiJob` \| ``null``\> Pemicu eksekusi segera untuk pekerjaan terjadwal. Mengembalikan pekerjaan yang dipicu, atau null jika instance lain sudah berjalan. #### Parameter[[runscheduledjob.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `jobId`: `string` ; `namespace`: `string` } & `CredentialsParams` | #### Mengembalikan[[runscheduledjob.returns]] `Promise`\<`ApiJob` \| ``null``\> #### Didefinisikan di[[runscheduledjob.defined-in]] [packages/hub/src/lib/jobs/run-scheduled-job.ts:11](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/run-scheduled-job.ts#L11) ___ ### scanCacheDir ▸ **scanCacheDir**(`cacheDir?`): `Promise`\<[`HFCacheInfo`](interfaces/HFCacheInfo)\> #### Parameter[[scancachedir.parameters]] | Nama | Tipe | Nilai default | | :------ | :------ | :------ | | `cacheDir` | `undefined` \| `string` | `undefined` | #### Mengembalikan[[scancachedir.returns]] `Promise`\<[`HFCacheInfo`](interfaces/HFCacheInfo)\> #### Didefinisikan di[[scancachedir.defined-in]] [packages/hub/src/lib/cache-management.ts:72](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L72) ___ ### scanCachedRepo ▸ **scanCachedRepo**(`repoPath`): `Promise`\<[`CachedRepoInfo`](interfaces/CachedRepoInfo)\> #### Parameter[[scancachedrepo.parameters]] | Nama | Tipe | | :------ | :------ | | `repoPath` | `string` | #### Mengembalikan[[scancachedrepo.returns]] `Promise`\<[`CachedRepoInfo`](interfaces/CachedRepoInfo)\> #### Didefinisikan di[[scancachedrepo.defined-in]] [packages/hub/src/lib/cache-management.ts:118](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L118) ___ ### scanRefsDir ▸ **scanRefsDir**(`refsPath`, `refsByHash`): `Promise`\<`void`\> #### Parameter[[scanrefsdir.parameters]] | Nama | Tipe | | :------ | :------ | | `refsPath` | `string` | | `refsByHash` | `Map`\<`string`, `string`[]\> | #### Mengembalikan[[scanrefsdir.returns]] `Promise`\<`void`\> #### Didefinisikan di[[scanrefsdir.defined-in]] [packages/hub/src/lib/cache-management.ts:210](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L210) ___ ### scanSnapshotDir ▸ **scanSnapshotDir**(`revisionPath`, `cachedFiles`, `blobStats`): `Promise`\<`void`\> #### Parameter[[scansnapshotdir.parameters]] | Nama | Tipe | | :------ | :------ | | `revisionPath` | `string` | | `cachedFiles` | [`CachedFileInfo`](interfaces/CachedFileInfo)[] | | `blobStats` | `Map`\<`string`, `Stats`\> | #### Mengembalikan[[scansnapshotdir.returns]] `Promise`\<`void`\> #### Didefinisikan di[[scansnapshotdir.defined-in]] [packages/hub/src/lib/cache-management.ts:227](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/cache-management.ts#L227) ___ ### snapshotDownload ▸ **snapshotDownload**(`params`): `Promise`\<`string`\> Mengunduh seluruh repositori pada revisi tertentu di direktori cache [getHFHubCachePath](modules#gethfhubcachepath). Anda dapat mendaftar semua repositori yang di-cache menggunakan [scanCachedRepo](modules#scancachedrepo) #### Parameter[[snapshotdownload.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `cacheDir?`: `string` ; `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `revision?`: `string` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[snapshotdownload.returns]] `Promise`\<`string`\> **`Remarks`** Secara internal, ini menggunakan [downloadFileToCacheDir](modules#downloadfiletocachedir). #### Didefinisikan di[[snapshotdownload.defined-in]] [packages/hub/src/lib/snapshot-download.ts:20](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/snapshot-download.ts#L20) ___ ### spaceInfo ▸ **spaceInfo**\<`T`\>(`params`): `Promise`\<[`SpaceEntry`](interfaces/SpaceEntry) & `Pick`\<`ApiSpaceInfo`, `T`\>\> #### Parameter tipe[[spaceinfo.type-parameters]] | Nama | Tipe | | :------ | :------ | | `T` | extends ``"models"`` \| ``"datasets"`` \| ``"author"`` \| ``"cardData"`` \| ``"disabled"`` \| ``"gitalyUid"`` \| ``"createdAt"`` \| ``"tags"`` \| ``"sha"`` \| ``"subdomain"`` \| ``"runtime"`` = `never` | #### Parameter[[spaceinfo.parameters]] | Nama | Tipe | | :------ | :------ | | `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`\> | #### Mengembalikan[[spaceinfo.returns]] `Promise`\<[`SpaceEntry`](interfaces/SpaceEntry) & `Pick`\<`ApiSpaceInfo`, `T`\>\> #### Didefinisikan di[[spaceinfo.defined-in]] [packages/hub/src/lib/space-info.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/space-info.ts#L10) ___ ### streamJobEvents ▸ **streamJobEvents**(`params`): `AsyncGenerator`\<`string`, `void`, `unknown`\> Gunakan Server-Sent Events (SSE) untuk streaming peristiwa job. Mengembalikan iterable asinkron dari potongan-potongan peristiwa. #### Parameter[[streamjobevents.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `jobId`: `string` ; `namespace`: `string` } & `CredentialsParams` | #### Mengembalikan[[streamjobevents.returns]] `AsyncGenerator`\<`string`, `void`, `unknown`\> #### Didefinisikan di[[streamjobevents.defined-in]] [packages/hub/src/lib/jobs/stream-job-events.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/stream-job-events.ts#L10) ___ ### 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[[streamjoblogs.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `jobId`: `string` ; `namespace`: `string` } & `CredentialsParams` | #### Mengembalikan[[streamjoblogs.returns]] `AsyncGenerator`\<\{ `message`: `string` ; `timestamp`: `Date` }, `void`, `unknown`\> #### Didefinisikan di[[streamjoblogs.defined-in]] [packages/hub/src/lib/jobs/stream-job-logs.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/stream-job-logs.ts#L10) ___ ### streamJobMetrics ▸ **streamJobMetrics**(`params`): `AsyncGenerator`\<`string`, `void`, `unknown`\> Gunakan Server-Sent Events (SSE) untuk mengalirkan metrik job. Mengembalikan iterable asinkron dari chunk metrik. #### Parameter[[streamjobmetrics.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `jobId`: `string` ; `namespace`: `string` } & `CredentialsParams` | #### Mengembalikan[[streamjobmetrics.returns]] `AsyncGenerator`\<`string`, `void`, `unknown`\> #### Didefinisikan di[[streamjobmetrics.defined-in]] [packages/hub/src/lib/jobs/stream-job-metrics.ts:10](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/stream-job-metrics.ts#L10) ___ ### streamJson ▸ **streamJson**(`source`, `options?`): `AsyncGenerator`\<[`JsonStreamEvent`](modules#jsonstreamevent), `void`, `undefined`\> #### Parameter[[streamjson.parameters]] | Nama | Tipe | Deskripsi | | :------ | :------ | :------ | | `source` | `ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\> \| `AsyncIterable`\<`Uint8Array`\<`ArrayBufferLike`\>, `any`, `any`\> | - | | `options?` | `Object` | - | | `options.maxDepth?` | `number` | Kedalaman nesting maksimum objek/array. **`Default`** ```ts 1_000 ``` | | `options.maxTokenLength?` | `number` | Panjang maksimum, dalam karakter, dari satu token string / angka. **`Default`** ```ts 16_000_000 ``` | #### Mengembalikan[[streamjson.returns]] `AsyncGenerator`\<[`JsonStreamEvent`](modules#jsonstreamevent), `void`, `undefined`\> #### Didefinisikan di[[streamjson.defined-in]] [packages/hub/src/utils/streamJson.ts:123](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/utils/streamJson.ts#L123) ___ ### suspendScheduledJob ▸ **suspendScheduledJob**(`params`): `Promise`\<`void`\> Suspend (jeda) sebuah pekerjaan terjadwal. #### Parameter[[suspendscheduledjob.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` ; `jobId`: `string` ; `namespace`: `string` } & `CredentialsParams` | #### Mengembalikan[[suspendscheduledjob.returns]] `Promise`\<`void`\> #### Didefinisikan di[[suspendscheduledjob.defined-in]] [packages/hub/src/lib/jobs/suspend-scheduled-job.ts:9](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/jobs/suspend-scheduled-job.ts#L9) ___ ### uploadFile ▸ **uploadFile**(`params`): `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\> #### Parameter[[uploadfile.parameters]] | Nama | Tipe | | :------ | :------ | | `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` \| [`CommitEditFileParams`](interfaces/CommitEditFileParams) \| `File` \| \{ `content`: [`ContentSource`](modules#contentsource) ; `path`: `string` } ; `hubUrl?`: `string` ; `isPullRequest?`: `boolean` ; `parentCommit?`: `string` ; `rangeEditCache?`: [`RangeEditCache`](modules#rangeeditcache) ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `useWebWorkers?`: `boolean` \| \{ `minSize?`: `number` ; `poolSize?`: `number` } ; `useXet?`: `boolean` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[uploadfile.returns]] `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\> #### Didefinisikan di[[uploadfile.defined-in]] [packages/hub/src/lib/upload-file.ts:39](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/upload-file.ts#L39) ___ ### uploadFiles ▸ **uploadFiles**(`params`): `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\> #### Parameter[[uploadfiles.parameters]] | Nama | Tipe | | :------ | :------ | | `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` \| [`CommitEditFileParams`](interfaces/CommitEditFileParams) \| `File` \| \{ `content`: [`ContentSource`](modules#contentsource) ; `path`: `string` })[] ; `hubUrl?`: `string` ; `isPullRequest?`: `boolean` ; `maxFolderDepth?`: `number` ; `parentCommit?`: `string` ; `rangeEditCache?`: [`RangeEditCache`](modules#rangeeditcache) ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `useWebWorkers?`: `boolean` \| \{ `minSize?`: `number` ; `poolSize?`: `number` } ; `useXet?`: `boolean` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[uploadfiles.returns]] `Promise`\<[`CommitOutput`](interfaces/CommitOutput) \| `undefined`\> #### Didefinisikan di[[uploadfiles.defined-in]] [packages/hub/src/lib/upload-files.ts:6](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/upload-files.ts#L6) ___ ### uploadFilesWithProgress ▸ **uploadFilesWithProgress**(`params`): `AsyncGenerator`\<[`CommitProgressEvent`](modules#commitprogressevent), [`CommitOutput`](interfaces/CommitOutput) \| `undefined`\> Unggahan dengan kemajuan Membutuhkan XMLHttpRequest agar tersedia untuk event progres pada unggahan model, dataset, dan spaces. Atur useWebWorkers ke true agar event progres untuk hashing tersedia pada model, dataset, dan spaces. #### Parameter[[uploadfileswithprogress.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `abortSignal?`: `AbortSignal` ; `branch?`: `string` ; `commitDescription?`: `string` ; `commitTitle?`: `string` ; `files`: (`URL` \| [`CommitEditFileParams`](interfaces/CommitEditFileParams) \| `File` \| \{ `content`: [`ContentSource`](modules#contentsource) ; `path`: `string` })[] ; `hubUrl?`: `string` ; `isPullRequest?`: `boolean` ; `maxFolderDepth?`: `number` ; `parentCommit?`: `string` ; `rangeEditCache?`: [`RangeEditCache`](modules#rangeeditcache) ; `repo`: [`RepoDesignation`](modules#repodesignation) ; `useWebWorkers?`: `boolean` \| \{ `minSize?`: `number` ; `poolSize?`: `number` } ; `useXet?`: `boolean` } & `Partial`\<`CredentialsParams`\> | #### Mengembalikan[[uploadfileswithprogress.returns]] `AsyncGenerator`\<[`CommitProgressEvent`](modules#commitprogressevent), [`CommitOutput`](interfaces/CommitOutput) \| `undefined`\> #### Didefinisikan di[[uploadfileswithprogress.defined-in]] [packages/hub/src/lib/upload-files-with-progress.ts:21](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/upload-files-with-progress.ts#L21) ___ ### 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 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[[validatetensorentry.parameters]] | Nama | Tipe | | :------ | :------ | | `path` | `string` | | `tensorName` | `string` | | `info` | [`TensorInfo`](interfaces/TensorInfo) | | `fileSizeBytes` | `undefined` \| `number` | #### Mengembalikan[[validatetensorentry.returns]] `void` #### Didefinisikan di[[validatetensorentry.defined-in]] [packages/hub/src/lib/parse-safetensors-metadata.ts:246](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/parse-safetensors-metadata.ts#L246) ___ ### whoAmI ▸ **whoAmI**(`params`): `Promise`\<[`WhoAmI`](modules#whoami) & \{ `auth`: [`AuthInfo`](interfaces/AuthInfo) }\> #### Parameter[[whoami.parameters]] | Nama | Tipe | | :------ | :------ | | `params` | \{ `fetch?`: (`input`: URL \| RequestInfo, `init?`: `RequestInit`) => `Promise`\<`Response`\>(`input`: `string` \| `URL` \| `Request`, `init?`: `RequestInit`) => `Promise`\<`Response`\> ; `hubUrl?`: `string` } & `CredentialsParams` | #### Mengembalikan[[whoami.returns]] `Promise`\<[`WhoAmI`](modules#whoami) & \{ `auth`: [`AuthInfo`](interfaces/AuthInfo) }\> #### Didefinisikan di[[whoami.defined-in]] [packages/hub/src/lib/who-am-i.ts:62](https://github.com/huggingface/huggingface.js/blob/main/packages/hub/src/lib/who-am-i.ts#L62)