Transformers.js 文档
环境
并获得增强的文档体验
开始使用
env
用于配置 Transformers.js 的模块。
示例： 禁用远程模型。
import { env } from '@huggingface/transformers';
env.allowRemoteModels = false;示例： 设置本地模型路径。
import { env } from '@huggingface/transformers';
env.localModelPath = '/path/to/local/models/';示例： 设置缓存目录。
import { env } from '@huggingface/transformers';
env.cacheDir = '/path/to/cache/directory/';- 环境
- 静态
- 内部
env.apis
一个只读对象，包含有关当前环境中可用的 API 的信息。
类型：env 的静态常量
env.env : TransformersEnvironment
类型：env 的静态常量
env~IS_BROWSER_ENV
我们是否在浏览器环境（而非 Web Worker）中运行
类型：env 的内部属性
env~IS_WEBWORKER_ENV
我们是否在 Web Worker 环境中运行
类型：env 的内部属性
env~IS_WEB_CACHE_AVAILABLE
Cache API 是否可用
类型：env 的内部属性
env~IS_WEBGPU_AVAILABLE
WebGPU API 是否可用
类型：env 的内部属性
env~IS_WEBNN_AVAILABLE
WebNN API 是否可用
类型：env 的内部属性
env~IS_PROCESS_AVAILABLE
Node.js process API 是否可用
类型：env 的内部属性
env~IS_NODE_ENV
我们是否在 Node.js 环境中运行
类型：env 的内部属性
env~IS_FS_AVAILABLE
文件系统 API 是否可用
类型：env 的内部属性
env~IS_PATH_AVAILABLE
path API 是否可用
类型：env 的内部属性
env~TransformersEnvironment : Object
全局变量，对用户可见，用于控制执行。这为用户提供了一种配置 Transformers.js 的简单方法。
类型：env 的内部类型定义
属性
| 名称 | 类型 | 描述 |
|---|---|---|
| version | 字符串 | 此版本的 Transformers.js。 |
| backends | * | 公开不同后端的环境变量，允许用户在需要时设置这些变量。 |
| allowRemoteModels | 布尔值 | 是否允许加载远程文件，默认为 |
| remoteHost | 字符串 | 用于加载模型的 Host URL。默认为 Hugging Face Hub。 |
| remotePathTemplate | 字符串 | 路径模板，用于填充并附加到 |
| allowLocalModels | 布尔值 | 是否允许加载本地文件，如果在浏览器中运行，则默认为 |
| localModelPath | 字符串 | 用于加载本地模型的路径。默认为 |
| useFS | 布尔值 | 是否使用文件系统加载文件。默认情况下，如果可用，则为 |
| useBrowserCache | 布尔值 | 是否使用 Cache API 缓存模型。默认情况下，如果可用，则为 |
| useFSCache | 布尔值 | 是否使用文件系统缓存文件。默认情况下，如果可用，则为 |
| cacheDir | 字符串 | 用于使用文件系统缓存文件的目录。默认情况下，为 |
| useCustomCache | 布尔值 | 是否使用自定义缓存系统（由 |
| customCache | 对象 | 要使用的自定义缓存。默认为 |
< > 在 GitHub 上更新