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://developer.mozilla.org/en-US/docs/Web/API/Cache。如果您願意，也可以從 `match` 函式返回一個 `Promise<string>`，以便使用檔案路徑而不是 `Promise<Response>`。

< > 在 GitHub 上更新