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

# env

Module used to configure Transformers.js.

**Example:** Disable remote models.
```javascript
import { env } from '@huggingface/transformers';
env.allowRemoteModels = false;
```

**Example:** Set local model path.
```javascript
import { env } from '@huggingface/transformers';
env.localModelPath = '/path/to/local/models/';
```

**Example:** Set cache directory.
```javascript
import { env } from '@huggingface/transformers';
env.cacheDir = '/path/to/cache/directory/';
```

* [env](#module_env)
    * _static_
        * [`.apis`](#module_env.apis)
        * [`.env`](#module_env.env) : TransformersEnvironment
    * _inner_
        * [`~IS_BROWSER_ENV`](#module_env..IS_BROWSER_ENV)
        * [`~IS_WEBWORKER_ENV`](#module_env..IS_WEBWORKER_ENV)
        * [`~IS_WEB_CACHE_AVAILABLE`](#module_env..IS_WEB_CACHE_AVAILABLE)
        * [`~IS_WEBGPU_AVAILABLE`](#module_env..IS_WEBGPU_AVAILABLE)
        * [`~IS_WEBNN_AVAILABLE`](#module_env..IS_WEBNN_AVAILABLE)
        * [`~IS_PROCESS_AVAILABLE`](#module_env..IS_PROCESS_AVAILABLE)
        * [`~IS_NODE_ENV`](#module_env..IS_NODE_ENV)
        * [`~IS_FS_AVAILABLE`](#module_env..IS_FS_AVAILABLE)
        * [`~IS_PATH_AVAILABLE`](#module_env..IS_PATH_AVAILABLE)
        * [`~TransformersEnvironment`](#module_env..TransformersEnvironment) : Object

* * *

## `env.apis`

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

**Kind**: static constant of [env](#module_env)  

* * *

## `env.env` : TransformersEnvironment

**Kind**: static constant of [env](#module_env)  

* * *

## `env~IS_BROWSER_ENV`

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

**Kind**: inner property of [env](#module_env)  

* * *

## `env~IS_WEBWORKER_ENV`

Whether we are running in a web worker environment

**Kind**: inner property of [env](#module_env)  

* * *

## `env~IS_WEB_CACHE_AVAILABLE`

Whether the Cache API is available

**Kind**: inner property of [env](#module_env)  

* * *

## `env~IS_WEBGPU_AVAILABLE`

Whether the WebGPU API is available

**Kind**: inner property of [env](#module_env)  

* * *

## `env~IS_WEBNN_AVAILABLE`

Whether the WebNN API is available

**Kind**: inner property of [env](#module_env)  

* * *

## `env~IS_PROCESS_AVAILABLE`

Whether the Node.js process API is available

**Kind**: inner property of [env](#module_env)  

* * *

## `env~IS_NODE_ENV`

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

**Kind**: inner property of [env](#module_env)  

* * *

## `env~IS_FS_AVAILABLE`

Whether the filesystem API is available

**Kind**: inner property of [env](#module_env)  

* * *

## `env~IS_PATH_AVAILABLE`

Whether the path API is available

**Kind**: inner property of [env](#module_env)  

* * *

## `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](#module_env)  
**Properties**

  
    
      NameTypeDescription
    
  
  

    versionstringThis version of Transformers.js.

    
    backends*Expose 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.

    
    cacheDirstringThe 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.

    
    customCacheObjectThe 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.
If you wish, you may also return a Promise<string> from the match function if you'd like to use a file path instead of Promise<Response>.

      

* * *