@huggingface/hub

Clases

• HubApiError
• InvalidApiResponseFormatError
• JsonStreamParseError
• SafetensorParseError
• __internal_XetBlob

Interfaces

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

Alias de tipos

AccessToken

Ƭ AccessToken: string

En realidad hf_${string}, pero por comodidad, usando el tipo de datos string

Definido en

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

AccessTokenRole

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

Definido en

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

AuthType

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

Definido en

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

CommitOperation

Ƭ CommitOperation: CommitDeletedEntry | CommitFile | CommitEditFile | CommitCopyFile

Definido en

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 en

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 en

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

ContentSource

Ƭ ContentSource: Blob | URL

Definido en

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

Dtype

Ƭ Tipo de datos: "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 en

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 }

Analizador JSON incremental, minimalista y sin dependencias (estilo SAX).

JSON.parse requiere tener el documento completo en memoria dos veces (la cadena de origen + el árbol de objetos resultante), lo que lo hace inutilizable para documentos grandes cuyo contenido interesante es mínimo, por ejemplo, un model.safetensors.index.json de un MoE grande, donde los 60 MB de weight_map solo existen para indicarnos los ~100 nombres de archivo de fragmentos distintos.

Este parser emite en su lugar un flujo de eventos plano a medida que llegan los bytes, de modo que el consumidor puede conservar solo lo que le interesa y dejar que el resto sea recolectado por el recolector de basura. El uso de memoria está acotado por el tamaño del token individual más grande (cadena / número), no por el tamaño del documento.

La implementación es una máquina de estados reanudable: cualquier token puede dividirse en los límites de los fragmentos (incluidas las secuencias UTF-8 de varios bytes y las secuencias de escape \uXXXX).

Estrictez: la gramática aceptada es la RFC 8259 (la misma que JSON.parse), menos algunas comprobaciones que aquí costarían mucho por poco beneficio; en particular, las formas de los números se validan con Number() en lugar de con la máquina de estados, por lo que se aceptan algunos de los inputs que JSON.parse rechaza. Todo lo que JSON.parse acepta se acepta, con valores idénticos.

Example

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

Definido en

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

ModelAdditionalField

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

Definido en

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

PipelineType

Ƭ PipelineType: keyof typeof PIPELINE_DATA

Definido en

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

RangeEditCache

Ƭ RangeEditCache: Map<string, RangeEditCacheEntry>

Estado en memoria de un archivo previamente escrito a través de la ruta de edición por rangos, indexado por su hash xet. Permite que una adición posterior (o una edición del último término del archivo) omita por completo las llamadas a la API de reconstrucción y file-chunk-hashes: el estado merkle parcial y los hashes de verificación ya son conocidos.

Pase la misma instancia de RangeEditCache a las llamadas sucesivas de commit que agregan al mismo archivo para evitar llamar a las APIs de metadatos de CAS en cada agregación.

Definido en

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

RepoDesignation

Ƭ RepoDesignation: RepoId | RepoFullName

Definido en

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

RepoFullName

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

Definido en

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

RepoType

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

Definido en

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 en

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

SafetensorsFileHeader

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

Definido en

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 en

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

SafetensorsShardedHeaders

Ƭ SafetensorsShardedHeaders: Record<FileName, SafetensorsFileHeader>

Definido en

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 en

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

SpaceSdk

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

Definido en

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 en

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

TensorName

Ƭ TensorName: string

Definido en

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

WhoAmI

Ƭ WhoAmI: WhoAmIApp | WhoAmIOrg | WhoAmIUser

Definido en

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

Variables

DATASET _ EXPANDABLE _ KEYS

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

Definido en

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

DATASET _ EXPAND _ KEYS

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

Definido en

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

REVISIÓN _ POR DEFECTO

• Const DEFAULT_REVISION: "main"

Definido en

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

DIFFUSERS _ SAFETENSORS _ ARCHIVO

• Const DIFFUSERS_SAFETENSORS_FILE: "diffusion_pytorch_model.safetensors"

Definido en

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

DIFFUSERS _ SAFETENSORS _ INDEX _ ARCHIVO

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

Definido en

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

DIFFUSERS _ PESOS _ SUBCARPETAS

• Const DIFFUSERS_WEIGHTS_SUBFOLDERS: solo lectura ["transformer", "unet"]

Definido en

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

HUB _ URL

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

URL base del Hugging Face Hub.

Definido en

packages/hub/src/consts.ts:4

CAMPO _ DERIVADO _ DEL _ MODELO _ A _ CLAVE _ DE _ API

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

Definido en

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

MODEL _ EXPANDABLE _ KEYS

• Const MODEL_EXPANDABLE_KEYS: solo lectura ["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 en

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

MODEL _ EXPAND _ KEYS

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

Definido en

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

REGEX _ COMMIT _ HASH

• Const REGEX_COMMIT_HASH: RegExp

Definido en

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

REPO _ ID _ SEPARATOR

• Const REPO_ID_SEPARATOR: string = "--"

Definido en

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

RE _ SAFETENSORS _ FILE

• Const RE_SAFETENSORS_FILE: RegExp

Definido en

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

RE _ SAFETENSORS _ INDEX _ FILE

• Const RE_SAFETENSORS_INDEX_FILE: RegExp

Definido en

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

RE _ SAFETENSORS _ SHARD _ FILE

• Const RE_SAFETENSORS_SHARD_FILE: RegExp

Definido en

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

SAFETENSORS _ ARCHIVO

• Const SAFETENSORS_FILE: "model.safetensors"

Definido en

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

SAFETENSORS _ INDEX _ ARCHIVO

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

Definido en

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

SPACE _ EXPANDABLE _ KEYS

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

Definido en

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

SPACE _ EXPAND _ KEYS

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

Definido en

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

Funciones

_ _ interno _ sha256

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

Parámetros

Devuelve

AsyncGenerator<number, string>

sha codificado en hexadecimal

Yields

progreso (0-1)

Definido en

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

assertSafeShardFilename

▸ assertSafeShardFilename(filename): void

Los nombres de archivo de weight_map provienen de un archivo del repositorio, por lo que están controlados por el atacante: deben permanecer como rutas relativas dentro del propio directorio del índice.

Una comprobación literal de includes("..") no es suficiente, porque la URL en la que termina el nombre de archivo se analiza por el analizador de URL de WHATWG después de la comprobación, y ese analizador decodifica en porcentaje los segmentos de punto: %2e%2e (o .%2e, %2E%2E, …) es un segmento .. para él, por lo que escapa del repositorio — y con una credencial adjunta, la solicitud llega autorizada a la URL de resolve de otro repositorio.

Por lo tanto, decodifica antes de validar (repetidamente, para detectar %252e%252e) y rechaza cualquier cosa que no sea una ruta relativa simple.

Parámetros

Devuelve

void

Definido en

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

cancelJob

▸ cancelJob(params): Promise<ApiJob>

Cancelar un trabajo.

Parámetros

Devuelve

Promise<ApiJob>

Definido en

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

checkRepoAccess

▸ checkRepoAccess(params): Promise<void>

Comprueba si tenemos acceso de lectura a un repositorio.

Lanza un error HubApiError si no tenemos acceso. HubApiError.statusCode será 401, 403 o 404.

Parámetros

Devuelve

Promise<void>

Definido en

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

commit

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

Parámetros

Devuelve

Promise<CommitOutput | undefined>

undefined para subidas de cubo, CommitOutput en caso contrario

Definido en

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

commitIter

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

Función interna por ahora, utilizada por commit.

Puede exponerse más adelante para ofrecer información detallada sobre el progreso

CommitOutput no está presente para los commits de bucket

Parámetros

Devuelve

AsyncGenerator<CommitProgressEvent, CommitOutput | undefined>

Definido en

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

commitIterBucket

▸ commitIterBucket(params): AsyncGenerator<CommitProgressEvent>

Parámetros

Devuelve

AsyncGenerator<CommitProgressEvent>

Definido en

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

computeNumOfParamsByDtypeSingleFile

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

Suma los parámetros por dtype para la cabecera de un archivo, aplicando los factores de empaquetado de cuantización y omitiendo los tensores de registro.

Parámetros

Devuelve

Partial<Record<Dtype, number>>

Definido en

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

copyFile

▸ copyFile(params): Promise<undefined>

Copiar un archivo individual de un repositorio/bucket de origen al bucket de destino.

La copia se realiza en el servidor (sin transferencia de datos) cuando el archivo de origen está respaldado por xet. Para archivos de repositorios pequeños que no son de xet (p. ej. config.json), el archivo se descarga y se vuelve a subir al bucket de destino en el mismo commit.

Los archivos puntero de LFS que no se han migrado a xet se rechazan de antemano (de lo contrario, requerirían la descarga del blob completo de LFS).

Parámetros

Devuelve

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 en

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

copyFileIter

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

Variante de iterador asíncrono de copyFile que emite CopyProgressEvents mientras descarga archivos de origen no-xet (los archivos respaldados por xet se copian en el servidor y no emiten eventos). Consulte copyFile para conocer la semántica.

Parámetros

Devuelve

AsyncGenerator<CopyProgressEvent, undefined>

Example

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

Definido en

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

copyFiles

▸ copyFiles(params): Promise<undefined>

Copiar varios archivos (posiblemente de repositorios o cubos de origen diferentes) al cubo de destino en un solo commit.

Para los archivos de origen respaldados por xet, la copia se realiza en el servidor sin transferencia de datos. Para los archivos de origen no xet (generalmente archivos pequeños del repositorio almacenados en git), el archivo se descarga y se vuelve a subir como parte del mismo commit.

Los archivos de puntero LFS que no se han migrado a xet se rechazan de antemano.

Parámetros

Devuelve

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 en

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

copyFilesIter

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

Variante de iterador asíncrono de copyFiles que emite CopyProgressEvents mientras descarga archivos de origen no-xet (los archivos respaldados por xet se copian en el servidor y no emiten eventos). Consulte copyFiles para conocer la semántica.

Parámetros

Devuelve

AsyncGenerator<CopyProgressEvent, undefined>

Definido en

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

copyFolder

▸ copyFolder(params): Promise<undefined>

Copiar una carpeta (de forma recursiva) desde un repositorio/bucket de origen al bucket de destino en un solo commit.

Las rutas por archivo se resuelven de forma relativa a CopySource.path; la carpeta de origen en sí no se conserva en el destino a menos que CopyDestination.path la mantenga.

Parámetros

Devuelve

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 en

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

copyFolderIter

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

Variante de iterador asíncrono de copyFolder que emite CopyProgressEvents mientras descarga archivos de origen no-xet (los archivos respaldados por xet se copian en el servidor y no emiten eventos). Consulte copyFolder para conocer la semántica.

Parámetros

Devuelve

AsyncGenerator<CopyProgressEvent, undefined>

Definido en

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

countCommits

▸ countCommits(params): Promise<number>

Parámetros

Devuelve

Promise<number>

Definido en

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

createBranch

▸ createBranch(params): Promise<void>

Parámetros

Devuelve

Promise<void>

Definido en

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

createCollection

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

Parámetros

Devuelve

Promise<{ slug: string }>

Definido en

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

createRepo

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

Parámetros

Devuelve

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

Definido en

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

createScheduledJob

▸ createScheduledJob(params): Promise<ApiScheduledJob>

Crea un trabajo programado.

Parámetros

Devuelve

Promise<ApiScheduledJob>

Definido en

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

Devuelve

Promise<DatasetEntry & Pick<ApiDatasetInfo, T>>

Definido en

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

deleteBranch

▸ deleteBranch(params): Promise<void>

Parámetros

Devuelve

Promise<void>

Definido en

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

deleteCollection

▸ deleteCollection(params): Promise<void>

Parámetros

Devuelve

Promise<void>

Definido en

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

deleteFile

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

Parámetros

Devuelve

Promise<CommitOutput | undefined>

Definido en

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

deleteFiles

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

Parámetros

Devuelve

Promise<CommitOutput | undefined>

Definido en

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

deleteRepo

▸ deleteRepo(params): Promise<void>

Parámetros

Devuelve

Promise<void>

Definido en

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

deleteScheduledJob

▸ deleteScheduledJob(params): Promise<void>

Eliminar un trabajo programado.

Parámetros

Devuelve

Promise<void>

Definido en

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

downloadFile

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

Parámetros

Devuelve

Promise<Blob | null>

null cuando el archivo no existe

Definido en

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

downloadFileToCacheDir

▸ downloadFileToCacheDir(params): Promise<string>

Descarga un archivo dado si no está presente en la caché local.

Parámetros

Devuelve

Promise<string>

el enlace simbólico al objeto de blob

Definido en

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

duplicateJob

▸ duplicateJob(params): Promise<ApiJob>

Duplicar un trabajo (volver a ejecutarlo con la misma especificación).

Parámetros

Devuelve

Promise<ApiJob>

Definido en

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

encodeShardFilename

▸ encodeShardFilename(filename): string

Defensa en profundidad: la URL de descarga se construye mediante interpolación de cadenas, por lo que codifique cada segmento de ruta del nombre de archivo (ya validado) en lugar de confiar en que sea seguro para URLs.

Parámetros

Devuelve

string

Definido en

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

fileDownloadInfo

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

Parámetros

Devuelve

Promise<FileDownloadInfoOutput | null>

null cuando el archivo no existe

Definido en

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

fileExists

▸ fileExists(params): Promise<boolean>

Parámetros

Devuelve

Promise<boolean>

Definido en

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

getBlobStat

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

Parámetros

Devuelve

Promise<Stats>

Definido en

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

getHFHubCachePath

▸ getHFHubCachePath(): string

Devuelve

string

Definido en

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

getJob

▸ getJob(params): Promise<ApiJob>

Obtén un trabajo específico por ID.

Parámetros

Devuelve

Promise<ApiJob>

Definido en

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

getQuantizationMultiplier

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

Obtiene el multiplicador de parámetros para un tensor cuantizado en función del método de cuantización.

Puede ser fraccional; consulte packingFactor.

Parámetros

Devuelve

number

Definido en

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

getRepoFolderName

▸ getRepoFolderName(«destructured»): string

Parámetros

Devuelve

string

Definido en

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

getScheduledJob

▸ getScheduledJob(params): Promise<ApiScheduledJob>

Obtén un trabajo programado específico por ID.

Parámetros

Devuelve

Promise<ApiScheduledJob>

Definido en

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

globMatch

▸ globMatch(pattern, str): boolean

Coincidencia de glob sin RegExp: divide el patrón en * y comprueba que cada segmento literal aparezca en orden dentro de str. Evita por completo el uso de RegExp (sin riesgo de ReDoS, sin SyntaxError por patrones controlados por un atacante en config.json).

Parámetros

Devuelve

boolean

Definido en

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

isQuantizedTensor

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

Determina si un tensor está cuantizado en función de la configuración de cuantización y el nombre del tensor.

Python’s transformers uses plain substring matching for modules_to_not_convert, so bare names like "lm_head" must match "model.lm_head.weight". When the pattern contains a * we fall back to proper glob matching for flexibility.

Parámetros

Devuelve

boolean

Definido en

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

listCollections

▸ listCollections(params?): AsyncGenerator<ApiCollectionInfo>

Parámetros

Devuelve

AsyncGenerator<ApiCollectionInfo>

Definido en

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

listCommits

▸ listCommits(params): AsyncGenerator<CommitData>

Parámetros

Devuelve

AsyncGenerator<CommitData>

Definido en

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

listDatasets

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

Parámetros de tipo

Parámetros

Devuelve

AsyncGenerator<DatasetEntry & Pick<ApiDatasetInfo, T>>

Definido en

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

listFiles

▸ listFiles(params): AsyncGenerator<ListFileEntry>

Liste los archivos de una carpeta. Para listar TODOS los archivos del directorio, llámelo con params.recursive establecido en true.

Parámetros

Devuelve

AsyncGenerator<ListFileEntry>

Definido en

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

listJobHardware

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

Obtén la lista de hardware disponible para los trabajos. Este punto de acceso es público y no requiere autenticación, pero la autenticación es opcional.

Parámetros

Devuelve

Promise<ApiJobHardware[]>

Definido en

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

listJobs

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

Listar trabajos para un espacio de nombres (usuario u organización).

Parámetros

Devuelve

Promise<ApiJob[]>

Definido en

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

listModels

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

Parámetros de tipo

Parámetros

Devuelve

AsyncGenerator<ModelEntry & ResolveModelAdditionalFields<T>>

Definido en

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

listScheduledJobs

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

Listar los trabajos programados para un espacio de nombres.

Parámetros

Devuelve

Promise<ApiScheduledJob[]>

Definido en

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

Devuelve

AsyncGenerator<SpaceEntry & Pick<ApiSpaceInfo, T>>

Definido en

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

matchesCompressedTensorsTarget

▸ matchesCompressedTensorsTarget(target, moduleName): boolean

Coincide un nombre de módulo con un destino de compressed-tensors.

Los objetivos son nombres exactos de módulos, nombres de clases (p. ej. "Linear", que no podemos resolver a partir de los nombres de tensores y por lo tanto ignoramos) o expresiones regulares de Python con el prefijo re:. Para evitar evaluar RegExp controlados por un atacante desde config.json (ReDoS, SyntaxError — ver globMatch), traducimos el subconjunto común de expresiones regulares (.* comodín, anclas ^/$, escapes \.) a globMatch y tratamos los objetivos que utilizan cualquier otra sintaxis de expresiones regulares como no coincidentes.

Parámetros

Devuelve

boolean

Definido en

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

modelInfo

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

Parámetros de tipo

Parámetros

Devuelve

Promise<ModelEntry & ResolveModelAdditionalFields<T>>

Definido en

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

oauthHandleRedirect

▸ oauthHandleRedirect(opts?): Promise<OAuthResult>

Para llamar después de que el proveedor de OAuth redirija de vuelta a la aplicación.

También existe una función auxiliar oauthHandleRedirectIfPresent, que llamará a oauthHandleRedirect si la URL contiene un código de oauth en los parámetros de consulta y devolverá false en caso contrario.

Parámetros

Devuelve

Promise<OAuthResult>

Definido en

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

oauthHandleRedirectIfPresent

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

Para llamar después de que el proveedor de OAuth redirija de vuelta a la aplicación.

Devuelve false si la URL no contiene un código de oauth en los parámetros de consulta; de lo contrario, llama a oauthHandleRedirect.

Según tu aplicación, es posible que prefieras llamar directamente a oauthHandleRedirect.

Parámetros

Devuelve

Promise<OAuthResult | false>

Definido en

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

oauthLoginUrl

▸ oauthLoginUrl(opts?): Promise<string>

Use “Sign in with Hub” para autenticar a un usuario y obtener la información del usuario de oauth / el token de acceso.

Devuelve una URL de redirección. Después de que el usuario sea redirigido de vuelta a su aplicación, llame a oauthHandleRedirect para obtener la información del usuario de oauth / el token de acceso.

Cuando se llama desde dentro de un Space estático con OAuth habilitado, cargará la configuración desde el space; de lo contrario, es necesario especificar al menos el ID de cliente de tu aplicación OAuth.

Parámetros

Devuelve

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

(En teoría, esta función podría usarse para autenticar a un usuario con cualquier proveedor de OAuth que admita PKCE y OpenID Connect cambiando hubUrl, pero actualmente solo se ha probado con Hugging Face Hub.)

Definido en

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

parseRepoType

▸ parseRepoType(type): RepoType

Parámetros

Devuelve

RepoType

Definido en

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

parseSafetensorsMetadata

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

Analiza model.safetensors.index.json o model.safetensors de un modelo alojado en Hugging Face usando solicitudes de rango inteligentes para extraer su metadatos.

Parámetros

Devuelve

Promise<SetRequired<SafetensorsParseFromRepo, "parameterCount">>

Definido en

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

▸ parseSafetensorsMetadata(params): Promise<SafetensorsParseFromRepo>

Parámetros

Devuelve

Promise<SafetensorsParseFromRepo>

Definido en

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

parseSafetensorsShardFilename

▸ parseSafetensorsShardFilename(filename): SafetensorsShardFileInfo | null

Parámetros

Devuelve

SafetensorsShardFileInfo | null

Definido en

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

parseTotalParameters

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

Lee el atajo total_parameters de los metadatos de la cabecera/índice. Es autoinformado y el Hub lo muestra tal cual, omitiendo la validación de cabecera anterior; por lo tanto, se limita al número calculado cuando este está disponible (una operación sin efecto para archivos bien formados, donde ambos coinciden).

Parámetros

Devuelve

number | undefined

Definido en

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

pathsInfo

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

Parámetros

Devuelve

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

Definido en

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

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

Parámetros

Devuelve

Promise<PathInfo[]>

Definido en

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

relativeUnderFolder

▸ relativeUnderFolder(filePath, folderPath): string

Calcula la ruta de filePath relativa a folderPath. Se utiliza para mapear las rutas de origen bajo una carpeta que se está copiando a las rutas de destino bajo el nuevo prefijo.

Parámetros

Devuelve

string

Definido en

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

repoExists

▸ repoExists(params): Promise<boolean>

Parámetros

Devuelve

Promise<boolean>

Definido en

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

resumeScheduledJob

▸ resumeScheduledJob(params): Promise<void>

Reanudar un trabajo programado.

Parámetros

Devuelve

Promise<void>

Definido en

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

runJob

▸ runJob(params): Promise<ApiJob>

Ejecuta un nuevo trabajo.

Parámetros

Devuelve

Promise<ApiJob>

Definido en

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

runScheduledJob

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

Disparar un trabajo programado para que se ejecute de inmediato. Devuelve el trabajo que se disparó, o null si otra instancia ya está en ejecución.

Parámetros

Devuelve

Promise<ApiJob | null>

Definido en

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

scanCacheDir

▸ scanCacheDir(cacheDir?): Promise<HFCacheInfo>

Parámetros

Devuelve

Promise<HFCacheInfo>

Definido en

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

scanCachedRepo

▸ scanCachedRepo(repoPath): Promise<CachedRepoInfo>

Parámetros

Devuelve

Promise<CachedRepoInfo>

Definido en

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

scanRefsDir

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

Parámetros

Devuelve

Promise<void>

Definido en

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

scanSnapshotDir

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

Parámetros

Devuelve

Promise<void>

Definido en

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

snapshotDownload

▸ snapshotDownload(params): Promise<string>

Descarga un repositorio completo en la revisión indicada en el directorio de caché getHFHubCachePath. Puedes listar todos los repositorios en caché usando scanCachedRepo

Parámetros

Devuelve

Promise<string>

Remarks

Utiliza internamente downloadFileToCacheDir.

Definido en

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

spaceInfo

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

Parámetros de tipo

Parámetros

Devuelve

Promise<SpaceEntry & Pick<ApiSpaceInfo, T>>

Definido en

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

streamJobEvents

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

Transmite eventos de trabajos mediante Server-Sent Events (SSE). Devuelve un iterable asíncrono de fragmentos de eventos.

Parámetros

Devuelve

AsyncGenerator<string, void, unknown>

Definido en

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

streamJobLogs

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

Transmite los registros del trabajo mediante Server-Sent Events (SSE). Devuelve un iterable asíncrono de fragmentos de registro.

Parámetros

Devuelve

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

Definido en

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

streamJobMetrics

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

Transmite las métricas del trabajo mediante Server-Sent Events (SSE). Devuelve un iterable asíncrono de fragmentos de métricas.

Parámetros

Devuelve

AsyncGenerator<string, void, unknown>

Definido en

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

streamJson

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

Parámetros

Devuelve

AsyncGenerator<JsonStreamEvent, void, undefined>

Definido en

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

suspendScheduledJob

▸ suspendScheduledJob(params): Promise<void>

Suspender (pausar) un trabajo programado.

Parámetros

Devuelve

Promise<void>

Definido en

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

uploadFile

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

Parámetros

Devuelve

Promise<CommitOutput | undefined>

Definido en

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

uploadFiles

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

Parámetros

Devuelve

Promise<CommitOutput | undefined>

Definido en

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

uploadFilesWithProgress

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

Subidas con progreso

Se requiere que XMLHttpRequest esté disponible para los eventos de progreso de las cargas en modelos, conjuntos de datos y espacios. Establezca useWebWorkers en true para tener eventos de progreso para el hash de modelos, conjuntos de datos y espacios.

Parámetros

Devuelve

AsyncGenerator<CommitProgressEvent, CommitOutput | undefined>

Definido en

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

validateTensorEntry

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

Valida una entrada de tensor de un encabezado: las dimensiones son enteros finitos menores que MAX_TENSOR_DIM, data_offsets son coherentes y, cuando se conoce el tamaño del archivo, el rango de bytes declarado cabe en el archivo. Se comprueba data_offsets en lugar de shape * dtype size porque ambos pueden diferir legítimamente (relleno), por lo que las offsets son la única fuente de verdad que nos da el formato.

Parámetros

Devuelve

void

Definido en

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

whoAmI

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

Parámetros

Devuelve

Promise<WhoAmI & { auth: AuthInfo }>

Definido en

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