huggingface.js

项目介绍：huggingface.js

概述

huggingface.js 是一组用于与 Hugging Face API 交互的 JavaScript 库。这些库提供了包括类型支持的 TypeScript 类型，使开发者能够以简便高效的方式访问和操作 Hugging Face 平台上的机器学习模型、创建和管理模型仓库，以及使用推理功能处理语言和图像任务。

核心功能

与 Hugging Face Hub 交互

• @huggingface/hub：这个库让开发者可以通过程序化的方法在 Hugging Face 平台上创建或删除存储库，以及提交和下载文件。例如，可以使用这个库上传机器学习模型文件或管理项目文件。

使用推理 API

• @huggingface/inference：这个库主要用于通过推理 API 和专用推理端点与超过 100,000 个机器学习模型进行交互。开发者可以轻松地进行聊天完成、文本到图像生成、翻译等任务。

利用自然语言界面与模型交互

• @huggingface/agents：通过这个库，用户可以通过自然语言命令与 HF 模型交互，比如生成代码以绘制特定图像并读取描述。

数据处理和任务定义

• @huggingface/gguf 和 @huggingface/tasks：这些库分别用于解析远程文件和定义管道任务、模型库等核心概念。

现代支持与实用性

这些库使用了现代的浏览器特性，因此仅支持现代浏览器、Node.js 18 及以上版本、Bun 和 Deno。在安装和使用时，开发者无需依赖于 polyfills 和额外的依赖项。

安装指南

通过 NPM 安装

开发者可以根据需要通过 NPM 安装huggingface.js库组件：

npm install @huggingface/inference
npm install @huggingface/hub
npm install @huggingface/agents

使用 CDN 或静态托管

开发者也可以通过 CDN 使用 ES Modules 形式导入库：

<script type="module">
    import { HfInference } from 'https://cdn.jsdelivr.net/npm/@huggingface/inference@2.8.1/+esm';
    import { createRepo, commit, deleteRepo, listFiles } from "https://cdn.jsdelivr.net/npm/@huggingface/hub@0.21.0/+esm";
</script>

Deno 示例

在 Deno 环境中，可以通过以下方式导入库：

import { HfInference } from "https://esm.sh/@huggingface/inference";
import { createRepo, commit, deleteRepo, listFiles } from "https://esm.sh/@huggingface/hub";

代码示例

• @huggingface/inference 示例：例如，利用 Chat 完成 API 生成聊天对话，进行图片生成和图像描述。
• @huggingface/hub 示例：例如，创建新的模型存储库上传文件，或者删除文件操作。
• @huggingface/agents 示例：通过自然语言命令生成并运行代码以实现特定任务。

格式化与测试

项目使用 pnpm 进行格式化检查、静态代码分析以及单元测试。例如，通过以下命令进行代码检测：

pnpm -r format:check
pnpm -r lint:check
pnpm -r test

构建

项目构建将生成 ESM 和 CJS 格式的 JavaScript 文件，帮助开发者轻松集成到不同的项目中。

开放性

huggingface.js 库非常年轻，开发团队邀请用户反馈和报告问题，以共同改进和丰富功能。这样，社区可以持续地助力于项目的发展和完善。