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/';
A read-only object containing information about the APIs available in the current environment.
Kind: static constant of env
Kind: static constant of env
Whether we are running in a browser environment
Kind: inner property of env
Whether we are running in a web worker environment
Kind: inner property of env
Whether the Cache API is available
Kind: inner property of env
Whether the WebGPU API is available
Kind: inner property of env
Whether the WebNN API is available
Kind: inner property of env
Whether the Node.js process API is available
Kind: inner property of env
Whether we are running in a Node.js environment
Kind: inner property of env
Whether the filesystem API is available
Kind: inner property of env
Whether the path API is available
Kind: inner property of env
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
Name | Type | Description |
---|---|---|
version | string | This version of Transformers.js. |
backends | * | Expose environment variables of different backends, allowing users to set these variables if they want to. |
allowRemoteModels | boolean | Whether to allow loading of remote files, defaults to |
remoteHost | string | Host URL to load models from. Defaults to the Hugging Face Hub. |
remotePathTemplate | string | Path template to fill in and append to |
allowLocalModels | boolean | Whether to allow loading of local files, defaults to |
localModelPath | string | Path to load local models from. Defaults to |
useFS | boolean | Whether to use the file system to load files. By default, it is |
useBrowserCache | boolean | Whether to use Cache API to cache models. By default, it is |
useFSCache | boolean | Whether to use the file system to cache files. By default, it is |
cacheDir | string | The directory to use for caching files with the file system. By default, it is |
useCustomCache | boolean | Whether to use a custom cache system (defined by |
customCache | Object | The custom cache to use. Defaults to |