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
  - .env : TransformersEnvironment
- 内部

env.apis

一个只读对象，包含当前环境中可用 API 的信息。

类别: env 的静态常量

env.env : <code> TransformersEnvironment </code>

类别: 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 环境中运行（node、deno、bun）

类别: env 的内部属性

env~IS_FS_AVAILABLE

文件系统 API 是否可用

类别: env 的内部属性

env~IS_PATH_AVAILABLE

path API 是否可用

类别: env 的内部属性

env~TransformersEnvironment : <code> Object </code>

提供给用户以控制执行的全局变量。这为用户提供了一种简单的方法来配置 Transformers.js。

类别: env 的内部类型定义
属性

名称	类型	描述
版本	`字符串`	Transformers.js 的版本。
后端	`*`	公开不同后端的环境变量，允许用户根据需要设置这些变量。
allowRemoteModels	`布尔值`	是否允许加载远程文件，默认为 `true`。如果设置为 `false`，其效果与在加载 pipelines、模型、分词器、处理器等时设置 `local_files_only=true` 相同。
remoteHost	`字符串`	加载模型的远程主机 URL。默认为 Hugging Face Hub。
remotePathTemplate	`字符串`	在加载模型时用于填充并附加到 `remoteHost` 的路径模板。
allowLocalModels	`布尔值`	是否允许加载本地文件，如果在浏览器中运行，则默认为 `false`，否则为 `true`。如果设置为 `false`，将跳过本地文件检查，并尝试从远程主机加载模型。
localModelPath	`字符串`	加载本地模型的路径。默认为 `/models/`。
useFS	`布尔值`	是否使用文件系统来加载文件。默认情况下，如果可用，则为 `true`。
useBrowserCache	`布尔值`	是否使用 Cache API 来缓存模型。默认情况下，如果可用，则为 `true`。
useFSCache	`布尔值`	是否使用文件系统来缓存文件。默认情况下，如果可用，则为 `true`。
cacheDir	`字符串`	用于通过文件系统缓存文件的目录。默认为 `./.cache`。
useCustomCache	`布尔值`	是否使用自定义缓存系统（由 `customCache` 定义），默认为 `false`。
customCache	`对象`	要使用的自定义缓存。默认为 `null`。注意：这必须是一个实现了 Web Cache API 的 `match` 和 `put` 函数的对象。更多信息，请参阅 https://mdn.org.cn/en-US/docs/Web/API/Cache。如果您愿意，也可以从 `match` 函数返回一个 `Promise<string>`，以便使用文件路径而不是 `Promise<Response>`。

< > 在 GitHub 上更新