> For the complete documentation index, see [llms.txt](https://boinc-ai.gitbook.io/transformers.js/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boinc-ai.gitbook.io/transformers.js/api-reference/configs.md).

# Configs

## configs

Helper module for using model configs. For more information, see the corresponding [Python documentation](https://huggingface.co/docs/transformers/main/en/model_doc/auto#transformers.AutoConfig).

**Example:** Load an `AutoConfig`.

Copied

```
import { AutoConfig } from '@xenova/transformers';
let config = await AutoConfig.from_pretrained('bert-base-uncased');
console.log(config);
// PretrainedConfig {
//   "model_type": "bert",
//   "is_encoder_decoder": false,
//   "architectures": [
//       "BertForMaskedLM"
//   ],
//   "vocab_size": 30522
//   "num_attention_heads": 12,
//   "num_hidden_layers": 12,
//   "hidden_size": 768,
//   "max_position_embeddings": 512,
//   ...
// }
```

* [configs](https://huggingface.co/docs/transformers.js/api/configs#module_configs)
  * *static*
    * [.PretrainedConfig](https://huggingface.co/docs/transformers.js/api/configs#module_configs.PretrainedConfig)
      * [`new PretrainedConfig(configJSON)`](https://huggingface.co/docs/transformers.js/api/configs#new_module_configs.PretrainedConfig_new)
      * [`.from_pretrained(pretrained_model_name_or_path, options)`](https://huggingface.co/docs/transformers.js/api/configs#module_configs.PretrainedConfig.from_pretrained) ⇒ `Promise.<PretrainedConfig>`
    * [.AutoConfig](https://huggingface.co/docs/transformers.js/api/configs#module_configs.AutoConfig)
      * [`.from_pretrained()`](https://huggingface.co/docs/transformers.js/api/configs#module_configs.AutoConfig.from_pretrained) : `PretrainedConfig.from_pretrained`
  * *inner*
    * [`~loadConfig(pretrained_model_name_or_path, options)`](https://huggingface.co/docs/transformers.js/api/configs#module_configs..loadConfig) ⇒ `Promise.<Array>`
    * [`~PretrainedOptions`](https://huggingface.co/docs/transformers.js/api/configs#module_configs..PretrainedOptions) : `*`

***

### configs.PretrainedConfig

Base class for all configuration classes. For more information, see the corresponding [Python documentation](https://huggingface.co/docs/transformers/main/en/main_classes/configuration#transformers.PretrainedConfig).

**Kind**: static class of [`configs`](https://huggingface.co/docs/transformers.js/api/configs#module_configs)

* [.PretrainedConfig](https://huggingface.co/docs/transformers.js/api/configs#module_configs.PretrainedConfig)
  * [`new PretrainedConfig(configJSON)`](https://huggingface.co/docs/transformers.js/api/configs#new_module_configs.PretrainedConfig_new)
  * [`.from_pretrained(pretrained_model_name_or_path, options)`](https://huggingface.co/docs/transformers.js/api/configs#module_configs.PretrainedConfig.from_pretrained) ⇒ `Promise.<PretrainedConfig>`

***

#### new PretrainedConfig(configJSON)

Create a new PreTrainedTokenizer instance.

| Param      | Type     | Description             |
| ---------- | -------- | ----------------------- |
| configJSON | `Object` | The JSON of the config. |

***

#### PretrainedConfig.from\_pretrained(pretrained\_model\_name\_or\_path, options) ⇒ \<code> Promise. < PretrainedConfig > \</code>

Loads a pre-trained config from the given `pretrained_model_name_or_path`.

**Kind**: static method of [`PretrainedConfig`](https://huggingface.co/docs/transformers.js/api/configs#module_configs.PretrainedConfig)\
**Returns**: `Promise.<PretrainedConfig>` - A new instance of the `PretrainedConfig` class.\
**Throws**:

* `Error` Throws an error if the config.json is not found in the \`pretrained\_model\_name\_or\_path\`.

| Param                             | Type                | Description                                |
| --------------------------------- | ------------------- | ------------------------------------------ |
| pretrained\_model\_name\_or\_path | `string`            | The path to the pre-trained config.        |
| options                           | `PretrainedOptions` | Additional options for loading the config. |

***

### configs.AutoConfig

Helper class which is used to instantiate pretrained configs with the `from_pretrained` function.

**Kind**: static class of [`configs`](https://huggingface.co/docs/transformers.js/api/configs#module_configs)

***

#### AutoConfig.from\_pretrained() : \<code> PretrainedConfig.from\_pretrained \</code>

**Kind**: static method of [`AutoConfig`](https://huggingface.co/docs/transformers.js/api/configs#module_configs.AutoConfig)

***

### configs\~loadConfig(pretrained\_model\_name\_or\_path, options) ⇒ \<code> Promise. < Array > \</code>

Loads a config from the specified path.

**Kind**: inner method of [`configs`](https://huggingface.co/docs/transformers.js/api/configs#module_configs)\
**Returns**: `Promise.<Array>` - A promise that resolves with information about the loaded config.

| Param                             | Type                | Description                                |
| --------------------------------- | ------------------- | ------------------------------------------ |
| pretrained\_model\_name\_or\_path | `string`            | The path to the config directory.          |
| options                           | `PretrainedOptions` | Additional options for loading the config. |

***

### configs\~PretrainedOptions : \<code> \* \</code>

**Kind**: inner typedef of [`configs`](https://huggingface.co/docs/transformers.js/api/configs#module_configs)