@huggingface/hub

Sınıflar

• HubApiError
• InvalidApiResponseFormatError
• JsonStreamParseError
• SafetensorParseError
• __internal_XetBlob

Arayüzler

• AuthInfo
• CachedFileInfo
• CachedRepoInfo
• CachedRevisionInfo
• CommitCopyFile
• CommitData
• CommitDeletedEntry
• CommitEditFile
• CommitEditFileParams
• CommitFile
• CommitInfo
• CommitOutput
• CopyDestination
• CopyFilesEntry
• CopyProgressEvent
• KaynakKopyala
• Kimlik Bilgileri
• DatasetEntry
• FileDownloadInfoOutput
• HFCacheInfo
• JobVolume
• LfsPathInfo
• ListFileEntry
• MlxQuantizationConfig
• ModelConfig
• ModelDerivedFields
• ModelEntry
• OAuthResult
• ParallelDownloadOptions
• PathInfo
• QuantizationConfig
• RangeEditCacheEntry
• RepoId
• SafetensorsIndexJson
• SafetensorsShardFileInfo
• SecurityFileStatus
• SpaceEntry
• SpaceResourceConfig
• SpaceResourceRequirement
• SpaceRuntime
• TensorInfo
• Kullanıcı Bilgisi
• WhoAmIApp
• WhoAmIOrg
• WhoAmIUser
• XetFileInfo
• XetReadToken

Tür Takma Adları

AccessToken

Ƭ AccessToken: string

Aslında hf_${string}, ancak kullanım kolaylığı için string tipi kullanılır

Tanımlandığı yer

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

AccessTokenRole

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

Tanımlandığı yer

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

AuthType

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

Tanımlandığı yer

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

CommitOperation

Ƭ CommitOperation: CommitDeletedEntry | CommitFile | CommitEditFile | CommitCopyFile

Tanımlandığı yer

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

CommitParams

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

Tanımlandığı yer

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

CommitProgressEvent

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

Tanımlandığı yer

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

ContentSource

Ƭ ContentSource: Blob | URL

Tanımlandığı yer

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

Dtype

Ƭ Veri türü: "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"

Tanımlandığı yer

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

JsonStreamEvent

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

Minimal, bağımlılıksız, artımlı (SAX tarzı) JSON ayrıştırıcısı.

JSON.parse, tüm belgeyi bellekte iki kez (kaynak dizesi + sonuç nesne ağacı) gerektirdiğinden, büyük boyutlu ancak ilginç içeriği çok küçük olan belgeler için kullanılamaz — örneğin, büyük bir MoE'nin model.safetensors.index.json dosyası, 60 MB'lık weight_map yalnızca ~100 farklı parça dosya adını belirtmek için varken.

Bu ayrıştırıcı bunun yerine baytlar geldikçe düz bir olay akışı üretir; böylece tüketici yalnızca ilgilendiği verileri tutabilir, gerisini çöp toplayıcıya bırakabilir. Bellek kullanımı, belgenin boyutuyla değil, en büyük tekil belirtecin (dize / sayı) boyutuyla sınırlıdır.

Uygulama, yeniden başlatılabilir bir durum makinesidir: herhangi bir token, parça sınırları arasında bölünebilir (çok baytlı UTF-8 dizileri ve \uXXXX kaçışları dahil).

Katılık: kabul edilen dil RFC 8259'dur (JSON.parse ile aynı), ancak burada az fayda için çok maliyetli olacak birkaç kontrol hariç tutulmuştur — özellikle sayı biçimleri durum makinesi yerine Number() ile doğrulanır, bu nedenle JSON.parse'ün reddettiği birkaç girdi kabul edilir. JSON.parse'ün kabul ettiği her şey, aynı değerlerle kabul edilir.

Example

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

Tanımlandığı yer

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

ModelAdditionalField

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

Tanımlandığı yer

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

PipelineType

Ƭ PipelineType: typeof PIPELINE_DATA anahtarları

Tanımlandığı yer

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

RangeEditCache

Ƭ RangeEditCache: Map<string, RangeEditCacheEntry>

Daha önce range-edit yolu üzerinden yazılmış bir dosyanın, xet hash'i ile anahtarlanan bellek içi durumu. Ardından gelen bir ekleme (veya dosyanın son teriminin düzenlenmesi) işleminin yeniden yapılandırma ve file-chunk-hashes API çağrılarını tamamen atlamasını sağlar: kısmi merkle durumu ve doğrulama hash'leri zaten bilinmektedir.

Aynı dosyaya eklemeler yapan ardışık commit çağrılarında, her eklemede CAS metadata API'lerinin çağrılmasını önlemek için aynı RangeEditCache örneğini iletin.

Tanımlandığı yer

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

RepoDesignation

Ƭ DepoTaylandirmasi: RepoId | RepoFullName

Tanımlandığı yer

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

RepoFullName

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

Tanımlandığı yer

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

RepoType

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

Tanımlandığı yer

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

ResolveModelAdditionalFields

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

Tip parametreleri

Tanımlandığı yer

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

SafetensorsFileHeader

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

Tanımlandığı yer

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

SafetensorsParseFromRepo

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

Tanımlandığı yer

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

SafetensorsShardedHeaders

Ƭ SafetensorsShardedHeaders: Record<FileName, SafetensorsFileHeader>

Tanımlandığı yer

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

SpaceHardwareFlavor

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

Tanımlandığı yer

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

SpaceSdk

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

Tanımlandığı yer

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

SpaceStage

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

Tanımlandığı yer

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

TensorName

Ƭ TensorName: string

Tanımlandığı yer

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

WhoAmI

Ƭ WhoAmI: WhoAmIApp | WhoAmIOrg | WhoAmIUser

Tanımlandığı yer

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

Değişkenler

DATASET _ EXPANDABLE _ KEYS

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

Tanımlandığı yer

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

DATASET _ EXPAND _ KEYS

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

Tanımlandığı yer

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

DEFAULT _ REVISION

• Const DEFAULT_REVISION: "main"

Tanımlandığı yer

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

DIFFUSERS _ SAFETENSORS _ DOSYA

• Const DIFFUSERS_SAFETENSORS_FILE: "diffusion_pytorch_model.safetensors"

Tanımlandığı yer

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

DIFFUSERS _ SAFETENSORS _ ENDEKS _ DOSYA

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

Tanımlandığı yer

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

DIFFUSERS _ AĞIRLIKLAR _ ALT KLASÖRLER

• Const DIFFUSERS_WEIGHTS_SUBFOLDERS: salt okunur ["transformer", "unet"]

Tanımlandığı yer

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

HUB _ URL

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

Hugging Face Hub'un temel URL'si.

Tanımlandığı yer

packages/hub/src/consts.ts:4

MODEL _ TURETILMI _ ALAN _ API _ ANAHTARI

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

Tanımlandığı yer

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

MODEL _ GENİŞLETİLEBİLİR _ ANAHTARLAR

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

Tanımlandığı yer

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

MODEL _ EXPAND _ KEYS

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

Tanımlandığı yer

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

REGEX _ COMMIT _ HASH

• Const REGEX_COMMIT_HASH: RegExp

Tanımlandığı yer

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

REPO _ ID _ SEPARATOR

• Const REPO_ID_SEPARATOR: string = "--"

Tanımlandığı yer

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

RE _ SAFETENSORS _ DOSYASI

• Const RE_SAFETENSORS_FILE: RegExp

Tanımlandığı yer

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

RE _ SAFETENSORS _ INDEX _ DOSYASI

• Const RE_SAFETENSORS_INDEX_FILE: RegExp

Tanımlandığı yer

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

RE _ SAFETENSORS _ SHARD _ FILE

• Const RE_SAFETENSORS_SHARD_FILE: RegExp

Tanımlandığı yer

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

SAFETENSORS _ DOSYA

• Const SAFETENSORS_FILE: "model.safetensors"

Tanımlandığı yer

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

SAFETENSORS _ INDEX _ DOSYASI

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

Tanımlandığı yer

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

SPACE _ EXPANDABLE _ KEYS

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

Tanımlandığı yer

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

SPACE _ EXPAND _ KEYS

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

Tanımlandığı yer

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

Fonksiyonlar

_ _ iç _ sha256

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

Parametreler

Dönüş

AsyncGenerator<number, string>

hex kodlanmış sha

Yields

ilerleme (0-1)

Tanımlandığı yer

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

assertSafeShardFilename

▸ assertSafeShardFilename(filename): void

weight_map dosya adları bir depo dosyasından gelir, bu nedenle saldırgan tarafından kontrol edilir: dizinin kendi dizini içinde göreli yollar olarak kalmalıdırlar.

Sadece includes("..") kontrolü yeterli değildir, çünkü dosya adının sonlandığı URL, kontrol sonrasında WHATWG URL ayrıştırıcısı tarafından ayrıştırılır ve bu ayrıştırıcı nokta segmentlerini yüzde kodundan çözer: %2e%2e (veya .%2e, %2E%2E, …) onun için bir .. segmentidir, bu nedenle depodan dışarı çıkar — ve bir kimlik bilgisi eklenmişse, istek başka bir depodaki resolve URL’sine yetkili olarak ulaşır.

Doğrulamadan önce çözümleyin (tekrar tekrar, %252e%252e gibi durumları yakalamak için) ve düz bir göreli yol olmayan her şeyi reddedin.

Parametreler

Dönüş

void

Tanımlandığı yer

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

cancelJob

▸ cancelJob(params): Promise<ApiJob>

Bir işi iptal edin.

Parametreler

Dönüş

Promise<ApiJob>

Tanımlandığı yer

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

checkRepoAccess

▸ checkRepoAccess(params): Promise<void>

Bir depoya okuma erişimimiz olup olmadığını kontrol edin.

Erişimimiz yoksa HubApiError hatası fırlatın. HubApiError.statusCode 401, 403 veya 404 olacaktır.

Parametreler

Dönüş

Promise<void>

Tanımlandığı yer

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

commit

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

Parametreler

Dönüş

Promise<CommitOutput | undefined>

bucket yüklemeleri için undefined, aksi halde CommitOutput

Tanımlandığı yer

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

commitIter

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

Şimdilik dahili bir işlev, commit tarafından kullanılır.

Daha sonra ince ayarlanmış ilerleme bilgisi sunmak için açığa çıkarılabilir

CommitOutput, bucket commit'leri için mevcut değildir

Parametreler

Dönüş

AsyncGenerator<CommitProgressEvent, CommitOutput | undefined>

Tanımlandığı yer

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

commitIterBucket

▸ commitIterBucket(params): AsyncGenerator<CommitProgressEvent>

Parametreler

Dönüş

AsyncGenerator<CommitProgressEvent>

Tanımlandığı yer

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

computeNumOfParamsByDtypeSingleFile

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

Bir dosyanın başlığı için parametreleri dtype başına toplar, kuantizasyon paketleme katsayılarını uygular ve defter tutma tensörlerini atlar.

Parametreler

Dönüş

Partial<Record<Dtype, number>>

Tanımlandığı yer

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

copyFile

▸ copyFile(params): Promise<undefined>

Kaynak depo/bakaktan tek bir dosyayı hedef bakaka kopyalayın.

Kaynak dosya xet destekliyorsa kopyalama işlemi sunucu tarafında gerçekleşir (veri aktarımı yapılmaz). Küçük, xet destekli olmayan depo dosyaları (ör. config.json) için dosya indirilir ve aynı commit içinde hedef kovaya yeniden yüklenir.

xet'e taşınmamış LFS işaretçi dosyaları baştan reddedilir (aksi halde tam LFS blob'unun indirilmesi gerekecekti).

Parametreler

Dönüş

Promise<undefined>

Example

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

Tanımlandığı yer

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

copyFileIter

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

copyFile'in asenkron-iteratör varyantı, xet dışı kaynak dosyaları indirirken CopyProgressEvent nesneleri üretir (xet destekli dosyalar sunucu tarafında kopyalanır ve olay yayınlamaz). Anlam için copyFile'e bakın.

Parametreler

Dönüş

AsyncGenerator<CopyProgressEvent, undefined>

Example

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

Tanımlandığı yer

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

copyFiles

▸ copyFiles(params): Promise<undefined>

Birden çok dosyayı (muhtemelen farklı kaynak depolarından/bucket'larından) tek bir commit ile hedef bucket'a kopyalayın.

xet destekli kaynak dosyalar için kopyalama işlemi sunucu tarafında, veri aktarımı olmadan gerçekleştirilir. xet destekli olmayan kaynak dosyalar (genellikle küçük, git'te saklanan depo dosyaları) için dosya, aynı commit'in bir parçası olarak indirilir ve yeniden yüklenir.

xet'e taşınmamış LFS işaretçi dosyaları baştan reddedilir.

Parametreler

Dönüş

Promise<undefined>

Example

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

Tanımlandığı yer

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

copyFilesIter

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

copyFiles'in asenkron-iteratör varyantı; xet tabanlı olmayan kaynak dosyaları indirirken CopyProgressEvent nesneleri üretir (xet tabanlı dosyalar sunucu tarafında kopyalanır ve olay yayınlamaz). Anlam için copyFiles'e bakın.

Parametreler

Dönüş

AsyncGenerator<CopyProgressEvent, undefined>

Tanımlandığı yer

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

copyFolder

▸ copyFolder(params): Promise<undefined>

Bir kaynak depo/bakaktan hedef bakata bir klasörü (özyinelemeli olarak) tek bir commit ile kopyalayın.

Dosya başına yollar, CopySource.path göreli olarak çözümlenir; kaynak klasörün kendisi, CopyDestination.path bunu korumadıkça hedefte korunmaz.

Parametreler

Dönüş

Promise<undefined>

Example

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

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

Tanımlandığı yer

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

copyFolderIter

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

copyFolder'in asenkron-iteratör varyantı; xet tabanlı olmayan kaynak dosyaları indirirken CopyProgressEvent nesneleri üretir (xet tabanlı dosyalar sunucu tarafında kopyalanır ve olay yayınlamaz). Anlam için copyFolder'e bakın.

Parametreler

Dönüş

AsyncGenerator<CopyProgressEvent, undefined>

Tanımlandığı yer

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

countCommits

▸ countCommits(params): Promise<number>

Parametreler

Dönüş

Promise<number>

Tanımlandığı yer

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

createBranch

▸ createBranch(params): Promise<void>

Parametreler

Dönüş

Promise<void>

Tanımlandığı yer

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

createCollection

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

Parametreler

Dönüş

Promise<{ slug: string }>

Tanımlandığı yer

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

createRepo

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

Parametreler

Dönüş

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

Tanımlandığı yer

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

createScheduledJob

▸ createScheduledJob(params): Promise<ApiScheduledJob>

Zamanlanmış bir iş oluşturun.

Parametreler

Dönüş

Promise<ApiScheduledJob>

Tanımlandığı yer

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

datasetInfo

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

Tip parametreleri

Parametreler

Dönüş

Promise<DatasetEntry & Pick<ApiDatasetInfo, T>>

Tanımlandığı yer

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

deleteBranch

▸ deleteBranch(params): Promise<void>

Parametreler

Dönüş

Promise<void>

Tanımlandığı yer

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

deleteCollection

▸ deleteCollection(params): Promise<void>

Parametreler

Dönüş

Promise<void>

Tanımlandığı yer

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

deleteFile

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

Parametreler

Dönüş

Promise<CommitOutput | undefined>

Tanımlandığı yer

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

deleteFiles

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

Parametreler

Dönüş

Promise<CommitOutput | undefined>

Tanımlandığı yer

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

deleteRepo

▸ deleteRepo(params): Promise<void>

Parametreler

Dönüş

Promise<void>

Tanımlandığı yer

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

deleteScheduledJob

▸ deleteScheduledJob(params): Promise<void>

Planlanmış bir işi siler.

Parametreler

Dönüş

Promise<void>

Tanımlandığı yer

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

downloadFile

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

Parametreler

Dönüş

Promise<Blob | null>

dosya yoksa null

Tanımlandığı yer

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

downloadFileToCacheDir

▸ downloadFileToCacheDir(params): Promise<string>

Yerel önbellekte henüz yoksa verilen dosyayı indirir.

Parametreler

Dönüş

Promise<string>

blob nesnesine sembolik bağlantı

Tanımlandığı yer

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

duplicateJob

▸ duplicateJob(params): Promise<ApiJob>

Bir işi kopyala (aynı özelliklerle yeniden çalıştır).

Parametreler

Dönüş

Promise<ApiJob>

Tanımlandığı yer

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

encodeShardFilename

▸ encodeShardFilename(filename): string

Derinlemesine savunma: indirme URL'si dize içgömme (string interpolation) ile oluşturulduğundan, (zaten doğrulanmış) dosya adının her yol segmentini URL güvenli olduğunu varsaymak yerine kodlayın.

Parametreler

Dönüş

string

Tanımlandığı yer

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

fileDownloadInfo

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

Parametreler

Dönüş

Promise<FileDownloadInfoOutput | null>

dosya yoksa null

Tanımlandığı yer

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

fileExists

▸ fileExists(params): Promise<boolean>

Parametreler

Dönüş

Promise<boolean>

Tanımlandığı yer

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

getBlobStat

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

Parametreler

Dönüş

Promise<Stats>

Tanımlandığı yer

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

getHFHubCachePath

▸ getHFHubCachePath(): string

Dönüş

string

Tanımlandığı yer

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

getJob

▸ getJob(params): Promise<ApiJob>

Belirli bir işi kimliğine göre alın.

Parametreler

Dönüş

Promise<ApiJob>

Tanımlandığı yer

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

getQuantizationMultiplier

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

Kantlama yöntemine göre kantlanmış bir tensörün parametre çarpanını alır.

Kesirli olabilir — bkz. packingFactor.

Parametreler

Dönüş

number

Tanımlandığı yer

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

getRepoFolderName

▸ getRepoFolderName(«destructured»): string

Parametreler

Dönüş

string

Tanımlandığı yer

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

getScheduledJob

▸ getScheduledJob(params): Promise<ApiScheduledJob>

Belirli bir zamanlanmış işi kimlik numarasına göre alın.

Parametreler

Dönüş

Promise<ApiScheduledJob>

Tanımlandığı yer

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

globMatch

▸ globMatch(pattern, str): boolean

RegExp olmadan glob eşleştirme: desen * üzerinden bölünür ve her literal segmentin str içinde sırayla yer aldığı kontrol edilir. Tamamen RegExp’ten kaçınılır (ReDoS riski yok, config.json’daki saldırgan tarafından kontrol edilen desenlerden kaynaklanan SyntaxError yok).

Parametreler

Dönüş

boolean

Tanımlandığı yer

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

isQuantizedTensor

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

Kantizasyon yapılandırması ve tensör adına göre bir tensörün kantize edilip edilmediğini belirler.

Python’ın transformers kütüphanesi modules_to_not_convert için düz alt dize eşleştirmesi kullanır, bu nedenle "lm_head" gibi çıplak adların "model.lm_head.weight" ile eşleşmesi gerekir. Desen * içeriyorsa esneklik için uygun glob eşleştirmesine geri düşülür.

Parametreler

Dönüş

boolean

Tanımlandığı yer

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

listCollections

▸ listCollections(params?): AsyncGenerator<ApiCollectionInfo>

Parametreler

Dönüş

AsyncGenerator<ApiCollectionInfo>

Tanımlandığı yer

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

listCommits

▸ listCommits(params): AsyncGenerator<CommitData>

Parametreler

Dönüş

AsyncGenerator<CommitData>

Tanımlandığı yer

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

listDatasets

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

Tip parametreleri

Parametreler

Dönüş

AsyncGenerator<DatasetEntry & Pick<ApiDatasetInfo, T>>

Tanımlandığı yer

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

listFiles

▸ listFiles(params): AsyncGenerator<ListFileEntry>

Bir klasördeki dosyaları listeler. Dizin içindeki TÜM dosyaları listelemek için, params.recursive parametresini true olarak ayarlayıp çağırın.

Parametreler

Dönüş

AsyncGenerator<ListFileEntry>

Tanımlandığı yer

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

listJobHardware

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

İşler için kullanılabilir donanım listesini alın. Bu uç nokta herkese açıktır ve kimlik doğrulama gerektirmez, ancak kimlik doğrulama isteğe bağlıdır.

Parametreler

Dönüş

Promise<ApiJobHardware[]>

Tanımlandığı yer

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

listJobs

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

Bir ad alanı (kullanıcı veya kuruluş) için işleri listele.

Parametreler

Dönüş

Promise<ApiJob[]>

Tanımlandığı yer

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

listModels

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

Tip parametreleri

Parametreler

Dönüş

AsyncGenerator<ModelEntry & ResolveModelAdditionalFields<T>>

Tanımlandığı yer

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

listScheduledJobs

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

Bir ad alanı için planlanmış işleri listeler.

Parametreler

Dönüş

Promise<ApiScheduledJob[]>

Tanımlandığı yer

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

listSpaces

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

Tip parametreleri

Parametreler

Dönüş

AsyncGenerator<SpaceEntry & Pick<ApiSpaceInfo, T>>

Tanımlandığı yer

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

matchesCompressedTensorsTarget

▸ matchesCompressedTensorsTarget(target, moduleName): boolean

Bir modül adını, compressed-tensors hedefiyle eşleştirir.

Hedefler, tam modül adları, sınıf adları (ör. "Linear", tensor adlarından çözemeyeceğimiz ve bu nedenle yoksaydığımız) veya re: önekiyle başlayan Python regexleridir. config.json dosyasından saldırgan kontrolündeki RegExp ifadelerini değerlendirmeyi önlemek için (ReDoS, SyntaxError — bkz. globMatch), yaygın regex alt kümesini (.* jokeri, ^/$ çapaları, \. kaçışları) globMatch'e çeviriyoruz ve başka herhangi bir regex sözdizimi kullanan hedefleri eşleşmeyen olarak değerlendiriyoruz.

Parametreler

Dönüş

boolean

Tanımlandığı yer

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

modelInfo

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

Tip parametreleri

Parametreler

Dönüş

Promise<ModelEntry & ResolveModelAdditionalFields<T>>

Tanımlandığı yer

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

oauthHandleRedirect

▸ oauthHandleRedirect(opts?): Promise<OAuthResult>

OAuth sağlayıcısı uygulamaya geri yönlendirdikten sonra çağrılır.

Ayrıca, URL'nin sorgu parametrelerinde bir oauth kodu içeriyorsa oauthHandleRedirect fonksiyonunu çağıran, aksi halde false döndüren oauthHandleRedirectIfPresent yardımcı fonksiyonu da mevcuttur.

Parametreler

Dönüş

Promise<OAuthResult>

Tanımlandığı yer

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

oauthHandleRedirectIfPresent

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

OAuth sağlayıcısı uygulamaya geri yönlendirdikten sonra çağrılır.

URL, sorgu parametrelerinde bir oauth kodu içermezse false döner, aksi takdirde oauthHandleRedirect çağrılır.

Uygulamanıza bağlı olarak, bunun yerine oauthHandleRedirect fonksiyonunu doğrudan çağırmak isteyebilirsiniz.

Parametreler

Dönüş

Promise<OAuthResult | false>

Tanımlandığı yer

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

oauthLoginUrl

▸ oauthLoginUrl(opts?): Promise<string>

Bir kullanıcıyı kimlik doğrulamak ve oauth kullanıcı bilgisi / erişim jetonu almak için “Sign in with Hub” kullanın.

Yönlendirilecek bir URL döndürür. Kullanıcı uygulamanıza geri yönlendirildikten sonra, oauth kullanıcı bilgilerini / erişim jetonunu almak için oauthHandleRedirect çağrısını yapın.

OAuth etkinleştirilmiş statik bir Space'in içinden çağrıldığında yapılandırma Space'ten yüklenir, aksi takdirde OAuth uygulamanızın istemci kimliğini belirtmeniz gerekir.

Parametreler

Dönüş

Promise<string>

Example

import { oauthLoginUrl, oauthHandleRedirectIfPresent } from "@huggingface/hub";

const oauthResult = await oauthHandleRedirectIfPresent();

if (!oauthResult) {
  // If the user is not logged in, redirect to the login page
  window.location.href = await oauthLoginUrl();
}

// You can use oauthResult.accessToken, oauthResult.accessTokenExpiresAt and oauthResult.userInfo
console.log(oauthResult);

(Teorik olarak, bu fonksiyon hubUrl değiştirilerek PKCE ve OpenID Connect destekleyen herhangi bir OAuth sağlayıcısı için kullanıcı kimlik doğrulaması yapmak üzere kullanılabilir, ancak şu anda yalnızca Hugging Face Hub ile test edilmiştir.)

Tanımlandığı yer

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

parseRepoType

▸ parseRepoType(type): RepoType

Parametreler

Dönüş

RepoType

Tanımlandığı yer

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

parseSafetensorsMetadata

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

Hugging Face'te barındırılan bir modelin model.safetensors.index.json veya model.safetensors dosyasını, metadata'sını çıkarmak için akıllı aralık istekleri kullanarak analiz edin.

Parametreler

Dönüş

Promise<SetRequired<SafetensorsParseFromRepo, "parameterCount">>

Tanımlandığı yer

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

▸ parseSafetensorsMetadata(params): Promise<SafetensorsParseFromRepo>

Parametreler

Dönüş

Promise<SafetensorsParseFromRepo>

Tanımlandığı yer

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

parseSafetensorsShardFilename

▸ parseSafetensorsShardFilename(filename): SafetensorsShardFileInfo | null

Parametreler

Dönüş

SafetensorsShardFileInfo | null

Tanımlandığı yer

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

parseTotalParameters

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

Başlık/endeks meta verisinden total_parameters kısayolunu okur. Bu değer kendi kendine bildirilen bir değerdir ve Hub onu olduğu gibi görüntüler, yukarıdaki başlık doğrulamasını atlar — bu nedenle, hesaplanmış bir sayıya sahip olduğumuzda (iki değerin de eşleştiği düzgün biçimlendirilmiş dosyalar için bir işe yaramaz işlem) bu değeri hesaplanmış sayıyla sınırlayın.

Parametreler

Dönüş

number | undefined

Tanımlandığı yer

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

pathsInfo

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

Parametreler

Dönüş

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

Tanımlandığı yer

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

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

Parametreler

Dönüş

Promise<PathInfo[]>

Tanımlandığı yer

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

relativeUnderFolder

▸ relativeUnderFolder(filePath, folderPath): string

filePath yolunun folderPath dizinine göre göreli yolunu hesaplar. Kopyalanan bir dizin altındaki kaynak yolları, yeni önek altındaki hedef yollara eşlemek için kullanılır.

Parametreler

Dönüş

string

Tanımlandığı yer

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

repoExists

▸ repoExists(params): Promise<boolean>

Parametreler

Dönüş

Promise<boolean>

Tanımlandığı yer

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

resumeScheduledJob

▸ resumeScheduledJob(params): Promise<void>

Planlanmış bir işi yeniden başlatın.

Parametreler

Dönüş

Promise<void>

Tanımlandığı yer

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

runJob

▸ runJob(params): Promise<ApiJob>

Yeni bir iş çalıştırın.

Parametreler

Dönüş

Promise<ApiJob>

Tanımlandığı yer

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

runScheduledJob

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

Zamanlanmış bir işin hemen çalıştırılmasını tetikleyin. Tetiklenen işi döndürür; başka bir örnek zaten çalışıyorsa null döndürür.

Parametreler

Dönüş

Promise<ApiJob | null>

Tanımlandığı yer

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

scanCacheDir

▸ scanCacheDir(cacheDir?): Promise<HFCacheInfo>

Parametreler

Dönüş

Promise<HFCacheInfo>

Tanımlandığı yer

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

scanCachedRepo

▸ scanCachedRepo(repoPath): Promise<CachedRepoInfo>

Parametreler

Dönüş

Promise<CachedRepoInfo>

Tanımlandığı yer

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

scanRefsDir

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

Parametreler

Dönüş

Promise<void>

Tanımlandığı yer

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

scanSnapshotDir

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

Parametreler

Dönüş

Promise<void>

Tanımlandığı yer

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

snapshotDownload

▸ snapshotDownload(params): Promise<string>

Belirtilen revizyondaki tüm depoyu getHFHubCachePath önbellek dizinine indirir. Önbellekteki tüm depoları scanCachedRepo kullanarak listeleyebilirsiniz.

Parametreler

Dönüş

Promise<string>

Remarks

İçsel olarak downloadFileToCacheDir kullanır.

Tanımlandığı yer

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

spaceInfo

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

Tip parametreleri

Parametreler

Dönüş

Promise<SpaceEntry & Pick<ApiSpaceInfo, T>>

Tanımlandığı yer

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

streamJobEvents

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

Sunucu Tarafı Olaylar (SSE) kullanarak iş olaylarını akış olarak iletin. Olay parçalarının asenkron bir yineleyicisini döndürür.

Parametreler

Dönüş

AsyncGenerator<string, void, unknown>

Tanımlandığı yer

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

streamJobLogs

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

Sunucu Tarafı Olaylar (SSE) kullanarak iş günlüklerini akış olarak alın. Günlük parçalarının asenkron bir yineleyicisini döndürür.

Parametreler

Dönüş

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

Tanımlandığı yer

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

streamJobMetrics

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

Sunucu Tarafı Olaylar (SSE) kullanarak iş metriklerini akış olarak iletin. Metrik parçalarının asenkron bir yineleyicisini döndürür.

Parametreler

Dönüş

AsyncGenerator<string, void, unknown>

Tanımlandığı yer

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

streamJson

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

Parametreler

Dönüş

AsyncGenerator<JsonStreamEvent, void, undefined>

Tanımlandığı yer

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

suspendScheduledJob

▸ suspendScheduledJob(params): Promise<void>

Planlanmış bir işi askıya alın (durdurun).

Parametreler

Dönüş

Promise<void>

Tanımlandığı yer

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

uploadFile

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

Parametreler

Dönüş

Promise<CommitOutput | undefined>

Tanımlandığı yer

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

uploadFiles

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

Parametreler

Dönüş

Promise<CommitOutput | undefined>

Tanımlandığı yer

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

uploadFilesWithProgress

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

İlerleme ile yüklemeler

Model, veri seti ve uzaylarda yükleme ilerleme olayları için XMLHttpRequest'un kullanılabilir olması gerekir. Model, veri seti ve uzaylarda özetleme (hashing) için ilerleme olaylarına sahip olmak için useWebWorkers değerini true olarak ayarlayın.

Parametreler

Dönüş

AsyncGenerator<CommitProgressEvent, CommitOutput | undefined>

Tanımlandığı yer

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

validateTensorEntry

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

Başlıktaki bir girdiyi doğrular: boyutlar MAX_TENSOR_DIM'in altında sonlu tam sayılardır, data_offsets makuldür ve — dosya boyutu biliniyorsa — bildirilen bayt aralığı dosyanın içine sığar. data_offsets, shape * dtype size yerine kontrol edilir çünkü ikisi meşru olarak farklılık gösterebilir (doldurma/padding); bu nedenle ofsetler, formatın bize verdiği tek kesin kaynaktır.

Parametreler

Dönüş

void

Tanımlandığı yer

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

whoAmI

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

Parametreler

Dönüş

Promise<WhoAmI & { auth: AuthInfo }>

Tanımlandığı yer

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