@huggingface/hub

Classes

• HubApiError
• InvalidApiResponseFormatError
• JsonStreamParseError
• SafetensorParseError
• __internal_XetBlob

Interfaces

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

Aliases de Tipo

AccessToken

Ƭ AccessToken: string

Na verdade hf_${string}, mas, por conveniência, usando o tipo string

Definido em

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

AccessTokenRole

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

Definido em

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

AuthType

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

Definido em

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

CommitOperation

Ƭ CommitOperation: CommitDeletedEntry | CommitFile | CommitEditFile | CommitCopyFile

Definido em

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>

Definido em

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" }

Definido em

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

ContentSource

Ƭ ContentSource: Blob | URL

Definido em

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

Dtype

Ƭ Dtype: "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"

Definido em

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

JsonStreamEvent

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

Parser JSON incremental (estilo SAX), minimal e sem dependências.

JSON.parse requer que o documento inteiro esteja na memória duas vezes (a string de origem + a árvore de objetos resultante), o que o torna inviável para documentos grandes cujo conteúdo relevante é minúsculo — por exemplo, um model.safetensors.index.json de um MoE grande, onde o weight_map de 60 MB existe apenas para nos informar os ~100 nomes de arquivos de shards distintos.

Este parser, em vez disso, emite um fluxo de eventos plano conforme os bytes chegam, permitindo que o consumidor mantenha apenas o que lhe interessa e deixe que todo o resto seja coletado pelo coletor de lixo. O uso de memória é limitado pelo tamanho do maior token individual (string / número), e não pelo tamanho do documento.

A implementação é uma máquina de estados retomável: qualquer token pode ser dividido entre fronteiras de blocos (incluindo sequências UTF-8 de múltiplos bytes e escapes \uXXXX).

Rigor: a gramática aceita é a RFC 8259 (a mesma de JSON.parse), exceto por algumas verificações que custariam muito para pouco benefício aqui — em particular, as formas numéricas são validadas por Number() em vez da máquina de estados, de modo que alguns inputs rejeitados por JSON.parse são aceitos. Tudo que JSON.parse aceita é aceito, com valores idênticos.

Example

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

Definido em

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

ModelAdditionalField

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

Definido em

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

PipelineType

Ƭ PipelineType: keyof typeof PIPELINE_DATA

Definido em

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

RangeEditCache

Ƭ RangeEditCache: Map<string, RangeEditCacheEntry>

Estado em memória de um arquivo previamente escrito por meio do caminho de edição por intervalo, indexado por seu hash xet. Permite que um append subsequente (ou uma edição do último termo do arquivo) pule completamente as chamadas de API de reconstrução e file-chunk-hashes: o estado parcial do merkle e os hashes de verificação já são conhecidos.

Passe a mesma instância de RangeEditCache para chamadas sucessivas de commit que adicionam ao mesmo arquivo para evitar chamar as APIs de metadados do CAS a cada adição.

Definido em

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

RepoDesignation

Ƭ RepoDesignation: RepoId | RepoFullName

Definido em

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

RepoFullName

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

Definido em

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

RepoType

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

Definido em

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

ResolveModelAdditionalFields

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

Parâmetros de tipo

Definido em

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

SafetensorsFileHeader

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

Definido em

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 }

Definido em

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

SafetensorsShardedHeaders

Ƭ SafetensorsShardedHeaders: Record<FileName, SafetensorsFileHeader>

Definido em

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"

Definido em

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

SpaceSdk

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

Definido em

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"

Definido em

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

TensorName

Ƭ TensorName: string

Definido em

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

WhoAmI

Ƭ WhoAmI: WhoAmIApp | WhoAmIOrg | WhoAmIUser

Definido em

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

Variáveis

DATASET _ EXPANDABLE _ KEYS

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

Definido em

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

DATASET _ EXPAND _ KEYS

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

Definido em

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

REVISÃO PADRÃO

• Const DEFAULT_REVISION: "main"

Definido em

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

DIFFUSERS _ SAFETENSORS _ ARQUIVO

• Const DIFFUSERS_SAFETENSORS_FILE: "diffusion_pytorch_model.safetensors"

Definido em

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

DIFFUSERS _ SAFETENSORS _ INDEX _ ARQUIVO

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

Definido em

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

DIFFUSERS _ PESOS _ SUBPASTAS

• Const DIFFUSERS_WEIGHTS_SUBFOLDERS: somente leitura ["transformer", "unet"]

Definido em

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

HUB _ URL

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

URL base do Hugging Face Hub.

Definido em

packages/hub/src/consts.ts:4

CAMPO _ DERIVADO _ DO _ MODELO _ PARA _ CHAVE _ DA _ API

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

Definido em

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

MODEL _ EXPANDABLE _ KEYS

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

Definido em

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

MODEL _ EXPAND _ KEYS

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

Definido em

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

REGEX _ COMMIT _ HASH

• Const REGEX_COMMIT_HASH: RegExp

Definido em

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

REPO _ ID _ SEPARATOR

• Const REPO_ID_SEPARATOR: string = "--"

Definido em

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

RE _ SAFETENSORS _ FILE

• Const RE_SAFETENSORS_FILE: RegExp

Definido em

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

RE _ SAFETENSORS _ INDEX _ FILE

• Const RE_SAFETENSORS_INDEX_FILE: RegExp

Definido em

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

RE _ SAFETENSORS _ SHARD _ FILE

• Const RE_SAFETENSORS_SHARD_FILE: RegExp

Definido em

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

SAFETENSORS _ ARQUIVO

• Const SAFETENSORS_FILE: "model.safetensors"

Definido em

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

ARQUIVO _ INDEX _ SAFETENSORS

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

Definido em

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

SPACE _ EXPANDABLE _ KEYS

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

Definido em

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

SPACE _ EXPAND _ KEYS

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

Definido em

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

Funções

_ _ interno _ sha256

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

Parâmetros

Retorna

AsyncGenerator<number, string>

sha em hexadecimal

Yields

progresso (0-1)

Definido em

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

assertSafeShardFilename

▸ assertSafeShardFilename(filename): void

Os nomes de arquivo de weight_map vêm de um arquivo do repositório, portanto são controlados pelo atacante: eles devem permanecer como caminhos relativos dentro do próprio diretório do índice.

Uma verificação literal de includes("..") não é suficiente, porque a URL em que o nome do arquivo termina é analisada pelo parser de URL do WHATWG após a verificação, e esse parser decodifica em porcentagem os segmentos de ponto: %2e%2e (ou .%2e, %2E%2E, …) é um segmento .. para ele, de modo que ele escapa do repositório — e, com uma credencial anexada, a solicitação chega autorizada à URL de resolve de outro repositório.

Portanto, decodifique antes de validar (repetidamente, para capturar %252e%252e) e rejeite qualquer coisa que não seja um caminho relativo simples.

Parâmetros

Retorna

void

Definido em

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

cancelJob

▸ cancelJob(params): Promise<ApiJob>

Cancelar um job.

Parâmetros

Retorna

Promise<ApiJob>

Definido em

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

checkRepoAccess

▸ checkRepoAccess(params): Promise<void>

Verifique se temos acesso de leitura a um repositório.

Lance um erro HubApiError se não tivermos acesso. HubApiError.statusCode será 401, 403 ou 404.

Parâmetros

Retorna

Promise<void>

Definido em

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

commit

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

Parâmetros

Retorna

Promise<CommitOutput | undefined>

undefined para uploads de bucket, CommitOutput caso contrário

Definido em

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

commitIter

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

Função interna por enquanto, usada pelo commit.

Pode ser exposto posteriormente para oferecer informações detalhadas sobre o progresso

CommitOutput não está presente para commits de bucket

Parâmetros

Retorna

AsyncGenerator<CommitProgressEvent, CommitOutput | undefined>

Definido em

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

commitIterBucket

▸ commitIterBucket(params): AsyncGenerator<CommitProgressEvent>

Parâmetros

Retorna

AsyncGenerator<CommitProgressEvent>

Definido em

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

computeNumOfParamsByDtypeSingleFile

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

Soma os parâmetros por dtype para o cabeçalho de um arquivo, aplicando os fatores de empacotamento de quantização e ignorando os tensores de controle.

Parâmetros

Retorna

Partial<Record<Dtype, number>>

Definido em

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

copyFile

▸ copyFile(params): Promise<undefined>

Copie um arquivo individual de um repositório/bucket de origem para o bucket de destino.

A cópia é feita no servidor (sem transferência de dados) quando o arquivo de origem é baseado em xet. Para arquivos de repositório pequenos que não são baseados em xet (por exemplo, config.json), o arquivo é baixado e reenviado para o bucket de destino no mesmo commit.

Arquivos de ponteiro LFS que não foram migrados para xet são rejeitados antecipadamente (caso contrário, seria necessário baixar o blob LFS completo).

Parâmetros

Retorna

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

Definido em

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

copyFileIter

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

Variante de iterador assíncrono de copyFile que produz CopyProgressEvents durante o download de arquivos de origem não-xet (arquivos com suporte xet são copiados no lado do servidor e não emitem eventos). Consulte copyFile para as semânticas.

Parâmetros

Retorna

AsyncGenerator<CopyProgressEvent, undefined>

Example

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

Definido em

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

copyFiles

▸ copyFiles(params): Promise<undefined>

Copie vários arquivos (possivelmente de repositórios/buckets de origem diferentes) para o bucket de destino em um único commit.

Para arquivos de origem com suporte a xet, a cópia é executada no servidor, sem transferência de dados. Para arquivos de origem sem suporte a xet (geralmente arquivos de repositório pequenos armazenados no git), o arquivo é baixado e reenviado como parte do mesmo commit.

Arquivos de ponteiro LFS que não foram migrados para xet são rejeitados antecipadamente.

Parâmetros

Retorna

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

Definido em

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

copyFilesIter

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

Variante de iterador assíncrono de copyFiles que produz CopyProgressEvents durante o download de arquivos de origem não-xet (arquivos com suporte xet são copiados no lado do servidor e não emitem eventos). Consulte copyFiles para as semânticas.

Parâmetros

Retorna

AsyncGenerator<CopyProgressEvent, undefined>

Definido em

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

copyFolder

▸ copyFolder(params): Promise<undefined>

Copie uma pasta (recursivamente) de um repositório/bucket de origem para o bucket de destino em um único commit.

Os caminhos por arquivo são resolvidos em relação a CopySource.path; a própria pasta de origem não é preservada no destino, a menos que CopyDestination.path a mantenha.

Parâmetros

Retorna

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

Definido em

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

copyFolderIter

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

Variante de iterador assíncrono de copyFolder que produz CopyProgressEvents durante o download de arquivos de origem não-xet (arquivos com suporte xet são copiados no lado do servidor e não emitem eventos). Consulte copyFolder para as semânticas.

Parâmetros

Retorna

AsyncGenerator<CopyProgressEvent, undefined>

Definido em

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

countCommits

▸ countCommits(params): Promise<number>

Parâmetros

Retorna

Promise<number>

Definido em

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

createBranch

▸ createBranch(params): Promise<void>

Parâmetros

Retorna

Promise<void>

Definido em

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

createCollection

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

Parâmetros

Retorna

Promise<{ slug: string }>

Definido em

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

createRepo

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

Parâmetros

Retorna

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

Definido em

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

createScheduledJob

▸ createScheduledJob(params): Promise<ApiScheduledJob>

Crie um job agendado.

Parâmetros

Retorna

Promise<ApiScheduledJob>

Definido em

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

datasetInfo

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

Parâmetros de tipo

Parâmetros

Retorna

Promise<DatasetEntry & Pick<ApiDatasetInfo, T>>

Definido em

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

deleteBranch

▸ deleteBranch(params): Promise<void>

Parâmetros

Retorna

Promise<void>

Definido em

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

deleteCollection

▸ deleteCollection(params): Promise<void>

Parâmetros

Retorna

Promise<void>

Definido em

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

deleteFile

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

Parâmetros

Retorna

Promise<CommitOutput | undefined>

Definido em

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

deleteFiles

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

Parâmetros

Retorna

Promise<CommitOutput | undefined>

Definido em

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

deleteRepo

▸ deleteRepo(params): Promise<void>

Parâmetros

Retorna

Promise<void>

Definido em

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

deleteScheduledJob

▸ deleteScheduledJob(params): Promise<void>

Excluir um agendamento de trabalho.

Parâmetros

Retorna

Promise<void>

Definido em

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

downloadFile

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

Parâmetros

Retorna

Promise<Blob | null>

null quando o arquivo não existe

Definido em

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

downloadFileToCacheDir

▸ downloadFileToCacheDir(params): Promise<string>

Baixe um arquivo específico, caso ele ainda não esteja presente no cache local.

Parâmetros

Retorna

Promise<string>

o link simbólico para o objeto blob

Definido em

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

duplicateJob

▸ duplicateJob(params): Promise<ApiJob>

Duplicar um job (reexecutar com a mesma especificação).

Parâmetros

Retorna

Promise<ApiJob>

Definido em

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

encodeShardFilename

▸ encodeShardFilename(filename): string

Defesa em profundidade: a URL de download é construída por interpolação de strings, portanto, codifique cada segmento de caminho do nome do arquivo (já validado) em vez de confiar que ele é seguro para URLs.

Parâmetros

Retorna

string

Definido em

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

fileDownloadInfo

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

Parâmetros

Retorna

Promise<FileDownloadInfoOutput | null>

null quando o arquivo não existe

Definido em

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

fileExists

▸ fileExists(params): Promise<boolean>

Parâmetros

Retorna

Promise<boolean>

Definido em

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

getBlobStat

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

Parâmetros

Retorna

Promise<Stats>

Definido em

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

getHFHubCachePath

▸ getHFHubCachePath(): string

Retorna

string

Definido em

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

getJob

▸ getJob(params): Promise<ApiJob>

Obtenha um trabalho específico pelo ID.

Parâmetros

Retorna

Promise<ApiJob>

Definido em

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

getQuantizationMultiplier

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

Obtém o multiplicador de parâmetros para um tensor quantizado com base no método de quantização.

Pode ser fracionário — veja packingFactor.

Parâmetros

Retorna

number

Definido em

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

getRepoFolderName

▸ getRepoFolderName(«destructured»): string

Parâmetros

Retorna

string

Definido em

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

getScheduledJob

▸ getScheduledJob(params): Promise<ApiScheduledJob>

Obtenha um trabalho agendado específico pelo ID.

Parâmetros

Retorna

Promise<ApiScheduledJob>

Definido em

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

globMatch

▸ globMatch(pattern, str): boolean

Correspondência de glob sem RegExp: divide o padrão em * e verifica que cada segmento literal aparece em ordem dentro de str. Evita o uso de RegExp por completo (sem risco de ReDoS, sem SyntaxError de padrões controlados por um atacante em config.json).

Parâmetros

Retorna

boolean

Definido em

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

isQuantizedTensor

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

Determina se um tensor está quantizado com base na configuração de quantização e no nome do tensor.

O transformers do Python usa correspondência de substrings simples para modules_to_not_convert, portanto nomes simples como "lm_head" devem corresponder a "model.lm_head.weight". Quando o padrão contém um *, recorremos à correspondência glob adequada para maior flexibilidade.

Parâmetros

Retorna

boolean

Definido em

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

listCollections

▸ listCollections(params?): AsyncGenerator<ApiCollectionInfo>

Parâmetros

Retorna

AsyncGenerator<ApiCollectionInfo>

Definido em

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

listCommits

▸ listCommits(params): AsyncGenerator<CommitData>

Parâmetros

Retorna

AsyncGenerator<CommitData>

Definido em

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

listDatasets

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

Parâmetros de tipo

Parâmetros

Retorna

AsyncGenerator<DatasetEntry & Pick<ApiDatasetInfo, T>>

Definido em

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

listFiles

▸ listFiles(params): AsyncGenerator<ListFileEntry>

Liste os arquivos em uma pasta. Para listar TODOS os arquivos no diretório, chame-o com params.recursive definido como true.

Parâmetros

Retorna

AsyncGenerator<ListFileEntry>

Definido em

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

listJobHardware

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

Obtenha a lista de hardware disponível para os jobs. Este endpoint é público e não requer autenticação, mas a autenticação é opcional.

Parâmetros

Retorna

Promise<ApiJobHardware[]>

Definido em

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

listJobs

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

Liste os trabalhos de um namespace (usuário ou organização).

Parâmetros

Retorna

Promise<ApiJob[]>

Definido em

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

listModels

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

Parâmetros de tipo

Parâmetros

Retorna

AsyncGenerator<ModelEntry & ResolveModelAdditionalFields<T>>

Definido em

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

listScheduledJobs

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

Liste os trabalhos agendados para um namespace.

Parâmetros

Retorna

Promise<ApiScheduledJob[]>

Definido em

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

listSpaces

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

Parâmetros de tipo

Parâmetros

Retorna

AsyncGenerator<SpaceEntry & Pick<ApiSpaceInfo, T>>

Definido em

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

matchesCompressedTensorsTarget

▸ matchesCompressedTensorsTarget(target, moduleName): boolean

Corresponde a um nome de módulo a um alvo do compressed-tensors.

Os alvos são nomes exatos de módulos, nomes de classes (por exemplo, "Linear", que não podemos resolver a partir dos nomes de tensores e, portanto, ignoramos) ou expressões regulares do Python prefixadas com re:. Para evitar a avaliação de RegExp controlado por um invasor a partir do config.json (ReDoS, SyntaxError — veja globMatch), traduzimos o subconjunto comum de expressões regulares (.* curinga, âncoras ^/$, escapes \.) para globMatch e tratamos alvos que usam qualquer outra sintaxe de expressão regular como não correspondentes.

Parâmetros

Retorna

boolean

Definido em

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

modelInfo

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

Parâmetros de tipo

Parâmetros

Retorna

Promise<ModelEntry & ResolveModelAdditionalFields<T>>

Definido em

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

oauthHandleRedirect

▸ oauthHandleRedirect(opts?): Promise<OAuthResult>

Para chamar depois que o provedor de OAuth redireciona de volta para o aplicativo.

Há também uma função auxiliar oauthHandleRedirectIfPresent, que chamará oauthHandleRedirect se a URL contiver um código oauth nos parâmetros de consulta e retornará false caso contrário.

Parâmetros

Retorna

Promise<OAuthResult>

Definido em

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

oauthHandleRedirectIfPresent

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

Para chamar depois que o provedor de OAuth redireciona de volta para o aplicativo.

Retorna false se a URL não contiver um código oauth nos parâmetros de consulta; caso contrário, chama oauthHandleRedirect.

Dependendo do seu aplicativo, você pode querer chamar oauthHandleRedirect diretamente em vez disso.

Parâmetros

Retorna

Promise<OAuthResult | false>

Definido em

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

oauthLoginUrl

▸ oauthLoginUrl(opts?): Promise<string>

Use “Sign in with Hub” para autenticar um usuário e obter as informações do usuário oauth / token de acesso.

Retorna uma URL para redirecionamento. Após o usuário ser redirecionado de volta para o seu aplicativo, chame oauthHandleRedirect para obter as informações do usuário oauth / token de acesso.

Quando chamado de dentro de um Space estático com OAuth habilitado, ele carregará a configuração do space; caso contrário, você precisa especificar pelo menos o ID do cliente do seu aplicativo OAuth.

Parâmetros

Retorna

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

(Em teoria, esta função poderia ser usada para autenticar um usuário em qualquer provedor OAuth que suporte PKCE e OpenID Connect, alterando hubUrl, mas atualmente ela é testada apenas com o Hugging Face Hub.)

Definido em

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

parseRepoType

▸ parseRepoType(type): RepoType

Parâmetros

Retorna

RepoType

Definido em

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

parseSafetensorsMetadata

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

Analise model.safetensors.index.json ou model.safetensors de um modelo hospedado no Hugging Face usando solicitações de intervalo inteligentes para extrair seus metadados.

Parâmetros

Retorna

Promise<SetRequired<SafetensorsParseFromRepo, "parameterCount">>

Definido em

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

▸ parseSafetensorsMetadata(params): Promise<SafetensorsParseFromRepo>

Parâmetros

Retorna

Promise<SafetensorsParseFromRepo>

Definido em

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

parseSafetensorsShardFilename

▸ parseSafetensorsShardFilename(filename): SafetensorsShardFileInfo | null

Parâmetros

Retorna

SafetensorsShardFileInfo | null

Definido em

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

parseTotalParameters

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

Lê o atalho total_parameters dos metadados do cabeçalho/índice. É auto-declarado e o Hub o exibe literalmente, ignorando a validação do cabeçalho acima — portanto, limite-o pela contagem calculada quando houver uma (uma operação sem efeito para arquivos bem formados, onde os dois valores coincidem).

Parâmetros

Retorna

number | undefined

Definido em

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

pathsInfo

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

Parâmetros

Retorna

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

Definido em

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

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

Parâmetros

Retorna

Promise<PathInfo[]>

Definido em

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

relativeUnderFolder

▸ relativeUnderFolder(filePath, folderPath): string

Calcula o caminho de filePath relativo a folderPath. Usado para mapear caminhos de origem sob uma pasta que está sendo copiada para caminhos de destino sob o novo prefixo.

Parâmetros

Retorna

string

Definido em

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

repoExists

▸ repoExists(params): Promise<boolean>

Parâmetros

Retorna

Promise<boolean>

Definido em

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

resumeScheduledJob

▸ resumeScheduledJob(params): Promise<void>

Retomar um trabalho agendado.

Parâmetros

Retorna

Promise<void>

Definido em

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

runJob

▸ runJob(params): Promise<ApiJob>

Execute um novo job.

Parâmetros

Retorna

Promise<ApiJob>

Definido em

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

runScheduledJob

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

Dispara a execução imediata de um trabalho agendado. Retorna o trabalho que foi disparado, ou null se outra instância já estiver em execução.

Parâmetros

Retorna

Promise<ApiJob | null>

Definido em

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

scanCacheDir

▸ scanCacheDir(cacheDir?): Promise<HFCacheInfo>

Parâmetros

Retorna

Promise<HFCacheInfo>

Definido em

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

scanCachedRepo

▸ scanCachedRepo(repoPath): Promise<CachedRepoInfo>

Parâmetros

Retorna

Promise<CachedRepoInfo>

Definido em

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

scanRefsDir

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

Parâmetros

Retorna

Promise<void>

Definido em

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

scanSnapshotDir

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

Parâmetros

Retorna

Promise<void>

Definido em

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

snapshotDownload

▸ snapshotDownload(params): Promise<string>

Baixa um repositório inteiro na revisão especificada no diretório de cache getHFHubCachePath. Você pode listar todos os repositórios em cache usando scanCachedRepo

Parâmetros

Retorna

Promise<string>

Remarks

Ele usa internamente downloadFileToCacheDir.

Definido em

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

spaceInfo

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

Parâmetros de tipo

Parâmetros

Retorna

Promise<SpaceEntry & Pick<ApiSpaceInfo, T>>

Definido em

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

streamJobEvents

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

Transmita eventos de trabalho usando Server-Sent Events (SSE). Retorna um iterável assíncrono de blocos de eventos.

Parâmetros

Retorna

AsyncGenerator<string, void, unknown>

Definido em

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

streamJobLogs

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

Transmita os logs do trabalho em streaming usando Server-Sent Events (SSE). Retorna um iterável assíncrono de fragmentos de log.

Parâmetros

Retorna

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

Definido em

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

streamJobMetrics

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

Transmita as métricas do trabalho do fluxo usando Server-Sent Events (SSE). Retorna um iterável assíncrono de blocos de métricas.

Parâmetros

Retorna

AsyncGenerator<string, void, unknown>

Definido em

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

streamJson

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

Parâmetros

Retorna

AsyncGenerator<JsonStreamEvent, void, undefined>

Definido em

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

suspendScheduledJob

▸ suspendScheduledJob(params): Promise<void>

Suspender (pausar) um agendamento de trabalho.

Parâmetros

Retorna

Promise<void>

Definido em

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

uploadFile

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

Parâmetros

Retorna

Promise<CommitOutput | undefined>

Definido em

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

uploadFiles

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

Parâmetros

Retorna

Promise<CommitOutput | undefined>

Definido em

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

uploadFilesWithProgress

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

Uploads com progresso

É necessário que o XMLHttpRequest esteja disponível para eventos de progresso em uploads de modelos, conjuntos de dados e espaços. Defina useWebWorkers como true para ter eventos de progresso para o hashing de modelos, conjuntos de dados e espaços.

Parâmetros

Retorna

AsyncGenerator<CommitProgressEvent, CommitOutput | undefined>

Definido em

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

validateTensorEntry

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

Valida uma entrada de tensor de um cabeçalho: as dimensões são inteiros finitos menores que MAX_TENSOR_DIM, data_offsets são válidos e — quando o tamanho do arquivo é conhecido — a extensão de bytes declarada cabe no arquivo. data_offsets é verificado em vez de shape * dtype size porque os dois podem divergir legítimamente (padding), portanto os offsets são a única fonte de verdade que o formato nos fornece.

Parâmetros

Retorna

void

Definido em

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

whoAmI

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

Parâmetros

Retorna

Promise<WhoAmI & { auth: AuthInfo }>

Definido em

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