transformers.js/pr_1516/en/api/env.md

env

Module used to configure Transformers.js.

Example: Disable remote models.

import { env } from '@huggingface/transformers';
env.allowRemoteModels = false;

Example: Set local model path.

import { env } from '@huggingface/transformers';
env.localModelPath = '/path/to/local/models/';

Example: Set cache directory.

import { env } from '@huggingface/transformers';
env.cacheDir = '/path/to/cache/directory/';

• env
  • static
    • .apis
    • .env : TransformersEnvironment
  • inner
    • ~IS_BROWSER_ENV
    • ~IS_WEBWORKER_ENV
    • ~IS_WEB_CACHE_AVAILABLE
    • ~IS_WEBGPU_AVAILABLE
    • ~IS_WEBNN_AVAILABLE
    • ~IS_SAFARI
    • ~IS_PROCESS_AVAILABLE
    • ~IS_NODE_ENV
    • ~IS_FS_AVAILABLE
    • ~IS_PATH_AVAILABLE
    • ~isSafari() ⇒ boolean
    • ~TransformersEnvironment : Object

---

env.apis

A read-only object containing information about the APIs available in the current environment.

Kind: static constant of env

---

env.env : TransformersEnvironment

Kind: static constant of env

---

env~IS_BROWSER_ENV

Whether we are running in a browser environment (and not a web worker)

Kind: inner property of env

---

env~IS_WEBWORKER_ENV

Whether we are running in a web worker environment

Kind: inner property of env

---

env~IS_WEB_CACHE_AVAILABLE

Whether the Cache API is available

Kind: inner property of env

---

env~IS_WEBGPU_AVAILABLE

Whether the WebGPU API is available

Kind: inner property of env

---

env~IS_WEBNN_AVAILABLE

Whether the WebNN API is available

Kind: inner property of env

---

env~IS_SAFARI

Whether we are running in a Safari browser

Kind: inner property of env

---

env~IS_PROCESS_AVAILABLE

Whether the Node.js process API is available

Kind: inner property of env

---

env~IS_NODE_ENV

Whether we are running in a Node.js-like environment (node, deno, bun)

Kind: inner property of env

---

env~IS_FS_AVAILABLE

Whether the filesystem API is available

Kind: inner property of env

---

env~IS_PATH_AVAILABLE

Whether the path API is available

Kind: inner property of env

---

env~isSafari() ⇒ boolean

Check if the current environment is Safari browser. Works in both browser and web worker contexts.

Kind: inner method of env
Returns: boolean - Whether the current environment is Safari.

---

env~TransformersEnvironment : Object

Global variable given visible to users to control execution. This provides users a simple way to configure Transformers.js.

Kind: inner typedef of env
Properties

  NameTypeDescription




versionstringThis version of Transformers.js.


backendsObjectExpose environment variables of different backends,

allowing users to set these variables if they want to.

allowRemoteModelsbooleanWhether to allow loading of remote files, defaults to true.

If set to false, it will have the same effect as setting local_files_only=true when loading pipelines, models, tokenizers, processors, etc.

remoteHoststringHost URL to load models from. Defaults to the Hugging Face Hub.


remotePathTemplatestringPath template to fill in and append to remoteHost when loading models.


allowLocalModelsbooleanWhether to allow loading of local files, defaults to false if running in-browser, and true otherwise.

If set to false, it will skip the local file check and try to load the model from the remote host.

localModelPathstringPath to load local models from. Defaults to /models/.


useFSbooleanWhether to use the file system to load files. By default, it is true if available.


useBrowserCachebooleanWhether to use Cache API to cache models. By default, it is true if available.


useFSCachebooleanWhether to use the file system to cache files. By default, it is true if available.


cacheDirstring | nullThe directory to use for caching files with the file system. By default, it is ./.cache.


useCustomCachebooleanWhether to use a custom cache system (defined by customCache), defaults to false.


customCacheCacheInterface | nullThe custom cache to use. Defaults to null. Note: this must be an object which

implements the match and put functions of the Web Cache API. For more information, see https://developer.mozilla.org/en-US/docs/Web/API/Cache.

useWasmCachebooleanWhether to pre-load and cache WASM binaries for ONNX Runtime. Defaults to true when cache is available.

This can improve performance by avoiding repeated downloads of WASM files. Note: Only the WASM binary is cached. The MJS loader file still requires network access unless you use a Service Worker.

cacheKeystringThe cache key to use for storing models and WASM binaries. Defaults to 'transformers-cache'.

  

---