Huggingface.js documentation
Bibliotecas de JS de Hugging Face
// Programmatically interact with the Hub
await createRepo({
repo: { type: "model", name: "my-user/nlp-model" },
accessToken: HF_TOKEN
});
await uploadFile({
repo: "my-user/nlp-model",
accessToken: HF_TOKEN,
// Can work with native File in browsers
file: {
path: "pytorch_model.bin",
content: new Blob(...)
}
});
// Use all supported Inference Providers!
await inference.chatCompletion({
model: "meta-llama/Llama-3.1-8B-Instruct",
provider: "sambanova", // or together, fal-ai, replicate, cohere …
messages: [
{
role: "user",
content: "Hello, nice to meet you!",
},
],
max_tokens: 512,
temperature: 0.5,
});
await inference.textToImage({
model: "black-forest-labs/FLUX.1-dev",
provider: "replicate",
inputs: "a picture of a green bird",
});
// and much more…Bibliotecas de JS de Hugging Face
Esta es una colección de bibliotecas de JS para interactuar con la API de Hugging Face, con tipos de TS incluidos.
- @huggingface/hub: Interactúa con huggingface.co para crear o eliminar repositorios y enviar o descargar archivos
- @huggingface/inference: Utiliza todos los proveedores de inferencia (serverless) compatibles o cambia a Inference Endpoints (dedicados) para realizar llamadas a más de 100.000 modelos de Machine Learning
- @huggingface/mcp-client: un cliente de Model Context Protocol (MCP) y una pequeña biblioteca de Agentes, construida sobre InferenceClient.
- @huggingface/gguf: Un parser de GGUF que funciona con archivos alojados de forma remota.
- @huggingface/dduf: Paquete similar para DDUF (DDUF Diffusers Unified Format)
- @huggingface/lerobot: Un analizador para conjuntos de datos de robótica de LeRobot, que lee las estructuras v2.x y v3.0 mediante solicitudes HTTP con rangos.
- @huggingface/usd-web-viewer: un visor de OpenUSD para la web: compone archivos
.usd,.usda,.usdcy.usdzen WebAssembly y los renderiza con three.js. - @huggingface/tasks: Los archivos de definición y la fuente de verdad para las primitivas principales del Hub, como las tareas de pipeline, las bibliotecas de modelos, etc.
- @huggingface/jinja: una implementación minimalista en JS del motor de plantillas Jinja, para usarse en plantillas de chat de ML.
- @huggingface/space-header: Usa el Space
mini_headerfuera de Hugging Face - @huggingface/ollama-utils: Varias utilidades para mantener la compatibilidad de Ollama con los modelos del Hugging Face Hub.
- @huggingface/tiny-agents: una biblioteca pequeña y agnóstica de modelos para crear agentes de IA que pueden usar herramientas.
Utilizamos funciones modernas para evitar polyfills y dependencias, por lo que las bibliotecas solo funcionarán en navegadores modernos / Node.js >= 18 / Bun / Deno.
Las bibliotecas son aún muy jóvenes, ¡ayúdanos abriendo issues!
Instalación
Desde NPM
Para instalar mediante NPM, puede descargar las bibliotecas según sea necesario:
npm install @huggingface/hub npm install @huggingface/inference npm install @huggingface/mcp-client
Luego, importa las bibliotecas en tu código:
import { createRepo, commit, deleteRepo, listFiles } from "@huggingface/hub";
import { InferenceClient } from "@huggingface/inference";
import { McpClient } from "@huggingface/mcp-client";
import type { RepoId } from "@huggingface/hub";Desde CDN o alojamiento estático
Puedes ejecutar nuestros paquetes con JS puro, sin ningún empaquetador, utilizando un CDN o un alojamiento estático. Con módulos ES, es decir, <script type="module">, puedes importar las bibliotecas en tu código:
<script type="module">
import { InferenceClient } from 'https://cdn.jsdelivr.net/npm/@huggingface/inference@4.13.32/+esm';
import { createRepo, commit, deleteRepo, listFiles } from "https://cdn.jsdelivr.net/npm/@huggingface/hub@2.17.10/+esm";
</script>Deno
// esm.sh
import { InferenceClient } from "https://esm.sh/@huggingface/inference"
import { createRepo, commit, deleteRepo, listFiles } from "https://esm.sh/@huggingface/hub"
// or npm:
import { InferenceClient } from "npm:@huggingface/inference"
import { createRepo, commit, deleteRepo, listFiles } from "npm:@huggingface/hub"Ejemplos de uso
Obtén tu token de acceso de HF en la configuración de tu cuenta.
Ejemplos de @huggingface/inference
import { InferenceClient } from "@huggingface/inference";
const HF_TOKEN = "hf_...";
const client = new InferenceClient(HF_TOKEN);
// Chat completion API
const out = await client.chatCompletion({
model: "meta-llama/Llama-3.1-8B-Instruct",
messages: [{ role: "user", content: "Hello, nice to meet you!" }],
max_tokens: 512
});
console.log(out.choices[0].message);
// Streaming chat completion API
for await (const chunk of client.chatCompletionStream({
model: "meta-llama/Llama-3.1-8B-Instruct",
messages: [{ role: "user", content: "Hello, nice to meet you!" }],
max_tokens: 512
})) {
console.log(chunk.choices[0].delta.content);
}
/// Using a third-party provider:
await client.chatCompletion({
model: "meta-llama/Llama-3.1-8B-Instruct",
messages: [{ role: "user", content: "Hello, nice to meet you!" }],
max_tokens: 512,
provider: "sambanova", // or together, fal-ai, replicate, cohere …
})
await client.textToImage({
model: "black-forest-labs/FLUX.1-dev",
inputs: "a picture of a green bird",
provider: "fal-ai",
})
// You can also omit "model" to use the recommended model for the task
await client.translation({
inputs: "My name is Wolfgang and I live in Amsterdam",
parameters: {
src_lang: "en",
tgt_lang: "fr",
},
});
// pass multimodal files or URLs as inputs
await client.imageToText({
model: 'nlpconnect/vit-gpt2-image-captioning',
data: await (await fetch('https://picsum.photos/300/300')).blob(),
})
// Using your own dedicated inference endpoint: https://hf.co/docs/inference-endpoints/
const gpt2Client = client.endpoint('https://xyz.eu-west-1.aws.endpoints.huggingface.cloud/gpt2');
const { generated_text } = await gpt2Client.textGeneration({ inputs: 'The answer to the universe is' });
// Chat Completion
const llamaEndpoint = client.endpoint(
"https://huggingface.co/proxy/router.huggingface.co/hf-inference/models/meta-llama/Llama-3.1-8B-Instruct"
);
const out = await llamaEndpoint.chatCompletion({
model: "meta-llama/Llama-3.1-8B-Instruct",
messages: [{ role: "user", content: "Hello, nice to meet you!" }],
max_tokens: 512,
});
console.log(out.choices[0].message);ejemplos de @huggingface/hub
import { createRepo, uploadFile, deleteFiles } from "@huggingface/hub";
const HF_TOKEN = "hf_...";
await createRepo({
repo: "my-user/nlp-model", // or { type: "model", name: "my-user/nlp-test" },
accessToken: HF_TOKEN
});
await uploadFile({
repo: "my-user/nlp-model",
accessToken: HF_TOKEN,
// Can work with native File in browsers
file: {
path: "pytorch_model.bin",
content: new Blob(...)
}
});
await deleteFiles({
repo: { type: "space", name: "my-user/my-space" }, // or "spaces/my-user/my-space"
accessToken: HF_TOKEN,
paths: ["README.md", ".gitattributes"]
});Ejemplo de @huggingface/mcp-client
import { Agent } from '@huggingface/mcp-client';
const HF_TOKEN = "hf_...";
const agent = new Agent({
provider: "auto",
model: "Qwen/Qwen2.5-72B-Instruct",
apiKey: HF_TOKEN,
servers: [
{
// Playwright MCP
command: "npx",
args: ["@playwright/mcp@latest"],
},
],
});
await agent.loadTools();
for await (const chunk of agent.run("What are the top 5 trending models on Hugging Face?")) {
if ("choices" in chunk) {
const delta = chunk.choices[0]?.delta;
if (delta.content) {
console.log(delta.content);
}
}
}Por supuesto, hay más funciones, ¡consulta el README de cada biblioteca!
Formato y pruebas
sudo corepack enable pnpm install pnpm -r format:check pnpm -r lint:check pnpm -r test
Compilación
pnpm -r buildEsto generará archivos javascript ESM y CJS en packages/*/dist, por ejemplo packages/inference/dist/index.mjs.