Skip to content

Commit

Permalink
[BUG] Fix AdapterPlus config (#775)
Browse files Browse the repository at this point in the history
This pr fixes the configuration parameters set in the
`AdapterPlusConfig`

edit: This pr also incorporates some updates as described inside the
comments in #764

1) Added some more information regarding training configurations inside
the `AdapterPlusConfig` and its corresponding notebook
2) Added more info regarding layer norms inside the documentation
  • Loading branch information
julian-fong authored Jan 6, 2025
1 parent f0ca962 commit d6054cb
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 3 deletions.
5 changes: 5 additions & 0 deletions docs/methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ _Papers:_
* [Adapters Strike Back](https://arxiv.org/pdf/2406.06820) (Steitz and Roth., 2024)
* [AdapterHub: A Framework for Adapting Transformers](https://arxiv.org/pdf/2007.07779.pdf) (Pfeiffer et al., 2020)

```{eval-rst}
.. note::
The two parameters ``original_ln_before`` and ``original_ln_after`` inside bottleneck adapters control both the addition of the residual input and the application of the pretrained layer norm. If the original model does not apply a layer norm function at a specific position of the forward function (e.g after the FFN layer), the two bottleneck parameters of the adapter set at that same position will only control the application of the residual input.
```

## Language Adapters - Invertible Adapters

_Configuration class_: [`SeqBnInvConfig`](adapters.SeqBnInvConfig), [`DoubleSeqBnInvConfig`](adapters.DoubleSeqBnInvConfig)
Expand Down
15 changes: 13 additions & 2 deletions notebooks/ViT_AdapterPlus_FineTuning.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,18 @@
"source": [
"### Loading the `ViT` model and the `AdapterPlusConfig`\n",
"\n",
"Here we load the `vit-base-patch16-224-in21k` model similar to the one used in the `AdapterConfig` paper. We will load the model using the `adapters` `AutoAdapterModel` and add the corresponding `AdapterPlusConfig`. To read more about the config, you can check out the docs page [here](https://docs.adapterhub.ml/methods#bottleneck-adapters) under `AdapterPlusConfig`"
"Here we load the `vit-base-patch16-224-in21k` model similar to the one used in the `AdapterConfig` paper. We will load the model using the `adapters` `AutoAdapterModel` and add the corresponding `AdapterPlusConfig`. To read more about the config, you can check out the docs page [here](https://docs.adapterhub.ml/methods#bottleneck-adapters) under `AdapterPlusConfig`.\n",
"\n",
"#### Important Note\n",
"\n",
"Please note that some configurations of the adapters parameters `original_ln_after`, `original_ln_before`, and \n",
"`residual_before_ln` may result in performance issues when training. \n",
"\n",
"In the general case:\n",
"\n",
"1) At least one of `original_ln_before` or `original_ln_after` should be set to `True` in order to ensure that the original residual\n",
" connection from pre-training is preserved. \n",
"2) If `original_ln_after` is set to `False`, `residual_before_ln` must also be set to `False` to ensure convergence during training."
]
},
{
Expand All @@ -218,7 +229,7 @@
"from adapters import AdapterPlusConfig\n",
"\n",
"model = ViTAdapterModel.from_pretrained(model_name_or_path)\n",
"config = AdapterPlusConfig(original_ln_after=True)\n",
"config = AdapterPlusConfig()\n",
"\n",
"model.add_adapter(\"adapterplus_config\", config)\n",
"model.add_image_classification_head(\"adapterplus_config\", num_labels=num_classes)\n",
Expand Down
11 changes: 10 additions & 1 deletion src/adapters/configuration/adapter_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -374,10 +374,19 @@ class ParBnConfig(BnConfig):
class AdapterPlusConfig(BnConfig):
"""
The AdapterPlus config architecture proposed by Jan-Martin O, Steitz and Stefan Roth. See https://arxiv.org/pdf/2406.06820
Please note that some configurations of the adapters parameters `original_ln_after`, `original_ln_before`, and
`residual_before_ln` may result in performance issues when training.
In the general case:
1) At least one of `original_ln_before` or `original_ln_after` should be set to True in order to ensure that the original residual
connection from pre-training is preserved.
2) If `original_ln_after` is set to `False`, `residual_before_ln` must also be set to `False` to ensure convergence during training.
"""

original_ln_after: bool = False
residual_before_ln: bool = True
original_ln_before: bool = True
residual_before_ln: bool = False
stochastic_depth: float = 0.1
init_weights: str = "houlsby"
scaling: Union[float, str] = "channel"
Expand Down

0 comments on commit d6054cb

Please sign in to comment.