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
- static
  - .apis
  - .env : TransformersEnvironment
- inner

env.apis

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

类型：env 的静态常量

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

类型：env 的静态常量

env~IS_BROWSER_ENV

我们是否在浏览器环境中运行

类型：env 的内部属性

env~IS_WEBWORKER_ENV

我们是否在 Web 工作者环境中运行

类型：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 进程 API 是否可用

类型：env 的内部属性

env~IS_NODE_ENV

是否在 Node.js 环境中运行

类型：env 的内部属性

env~IS_FS_AVAILABLE

文件系统 API 是否可用

类型：env 的内部属性

env~IS_PATH_AVAILABLE

路径 API 是否可用

类型：env 的内部属性

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

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

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

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

< > 在 GitHub 上更新