# Adan

**Repository Path**: alexwell_base/Adan

## Basic Information

- **Project Name**: Adan
- **Description**: Adan optimizer
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-04-22
- **Last Updated**: 2023-04-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Adan: Adaptive Nesterov Momentum Algorithm for Faster Optimizing Deep Models

This is an official PyTorch implementation of **Adan**. See the paper [here](https://arxiv.org/abs/2208.06677). If you find our adan helpful or heuristic to your projects, please cite this paper and also star this repository. Thanks!

```tex
@article{xie2022adan,
  title={Adan: Adaptive Nesterov Momentum Algorithm for Faster Optimizing Deep Models},
  author={Xie, Xingyu and Zhou, Pan and Li, Huan and Lin, Zhouchen and Yan, Shuicheng},
  journal={arXiv preprint arXiv:2208.06677},
  year={2022}
}
```

## News

- :fire: :fire: :fire:FusedAdan with less memory footprint is released.
- Adan is supported in the lasted version of [`Timm`](https://github.com/rwightman/pytorch-image-models).
- Results on large language models, like **GPT2**, are released.
- Adan is chosen as the default optimizer in the text-to-3D [DreamFusion Project](https://github.com/ashawkey/stable-dreamfusion). See more results [here](./dreamfusion/).
- TF's implementation (third party) refers to [DenisVorotyntsev/Adan](https://github.com/DenisVorotyntsev/Adan).
- JAX's version (third party) is implemented and also supported in [Deepmind/optax](https://github.com/deepmind/optax).
- Adan is supported in the [MMClassification](https://github.com/open-mmlab/mmclassification/tree/dev-1.x) of the [OpenMMLab](https://openmmlab.com/) project. The user can find the log and example of using Adan to train ViT-B [here](https://github.com/open-mmlab/mmclassification/pull/1180). The results of the detection tasks are coming soon.

______________________________________________________________________

## Installation

```
python3 -m pip install git+https://github.com/sail-sg/Adan.git
```
FusedAdan is installed by default. If you want to use the original Adan, please install it by:
```
git clone https://github.com/sail-sg/Adan.git
cd Adan
python3 setup.py install --unfused
```

A brief comparison of peak memory and wall duration for the optimizer is as follows. The duration time is the total time of 200 `optimizer.step()`. We further compare Adam and FusedAdan in great detail on GPT-2. See more results [here](./fused_adan/README.md).

| Model      | Model Size (MB) | Adam Peak (MB) | Adan Peak (MB) | FusedAdan Peak (MB) | Adam Time (ms) | Adan Time (ms) | FusedAdan Time (ms) |
| :--------- | :-------------: | :------------: | :------------: | :-----------------: | :------------: | :------------: | :-----------------: |
| ResNet-50  |       25        |      7142      |      7195      |        7176         |      9.0       |      4.2       |         1.9         |
| ResNet-101 |       44        |     10055      |     10215      |        10160        |      17.5      |      7.0       |         3.4         |
| ViT-B      |       86        |      9755      |      9758      |        9758         |      8.9       |      12.3      |         4.3         |
| Swin-B     |       87        |     16118      |     16202      |        16173        |      17.9      |      12.8      |         4.9         |
| ConvNext-B |       88        |     17353      |     17389      |        17377        |      19.1      |      15.6      |         5.0         |
| Swin-L     |       196       |     24299      |     24316      |        24310        |      17.5      |      28.1      |        10.1         |
| ConvNext-L |       197       |     26025      |     26055      |        26044        |      18.6      |      31.1      |        10.2         |
| ViT-L      |       304       |     25652      |     25658      |        25656        |      18.0      |      43.2      |        15.1         |
| GPT-2      |       758       |     25096      |     25406      |        25100        |      49.9      |     107.7      |        37.4         |
| GPT-2      |      1313       |     34357      |     38595      |        34363        |      81.8      |     186.0      |        64.4         |

## Usage

For your convenience to use Adan, we briefly provide some intuitive instructions below, then provide some general experimental tips, and finally provide more details (e.g., specific commands and hyper-parameters) for each experiment in the paper.

#### 1) Two steps to use Adan

**Step 1.** add Adan-dependent hyper-parameters by adding the following hyper-parameters to the config:

```python
parser.add_argument('--max-grad-norm', type=float, default=0.0, help='if the l2 norm is large than this hyper-parameter, then we clip the gradient  (default: 0.0, no gradient clip)')
parser.add_argument('--weight-decay', type=float, default=0.02,  help='weight decay, similar one used in AdamW (default: 0.02)')
parser.add_argument('--opt-eps', default=None, type=float, metavar='EPSILON', help='optimizer epsilon to avoid the bad case where second-order moment is zero (default: None, use opt default 1e-8 in adan)')
parser.add_argument('--opt-betas', default=None, type=float, nargs='+', metavar='BETA', help='optimizer betas in Adan (default: None, use opt default [0.98, 0.92, 0.99] in Adan)')
parser.add_argument('--no-prox', action='store_true', default=False, help='whether perform weight decay like AdamW (default=False)')
```

`opt-betas`: To keep consistent with our usage habits, the $\beta$'s in the paper are actually the $(1-\beta)$'s in the code.

`foreach (bool)`: If `True`, Adan would use `torch._foreach` implementation. It is faster but uses slightly more memory.

`no-prox`: It determines the update rule of parameters with weight decay. By default, Adan updates the parameters in the way presented in Algorithm 1 in the paper:

$$\boldsymbol{\theta}\_{k+1} = ( 1+\lambda \eta)^{-1}\left[\boldsymbol{\theta}\_k - \boldsymbol{\eta}\_k \circ (\mathbf{m}\_k+(1-{\color{blue}\beta_2})\mathbf{v}_k)\right],$$_

But one also can update the parameter like Adamw:

$$\boldsymbol{\theta}\_{k+1} = ( 1-\lambda \eta)\boldsymbol{\theta}\_k - \boldsymbol{\eta}\_k \circ (\mathbf{m}\_k+(1-{\color{blue}\beta_2})\mathbf{v}\_k).$$
In all experiments, we set `no-prox=False` in our paper.

**Step 2.** create the Adan optimizer as follows. In this step, we can directly replace the vanilla optimizer by using the following command:

```python
from adan import Adan
optimizer = Adan(param, lr=args.lr, weight_decay=args.weight_decay, betas=args.opt_betas, eps = args.opt_eps, max_grad_norm=args.max_grad_norm, no_prox=args.no_prox)
```

#### 2) Tips for Experiments

- To make Adan simple, in all experiments except Table 12 in the paper, we do not use the restart strategy in Adan. But Table 12 shows that the restart strategy can further slightly improve the performance of Adan.
- Adan often allows one to use a large peak learning rate which often fails other optimizers, e.g., Adam and AdamW. For example, in all experiments except for the MAE pre-training and LSTM, the learning rate used by Adan is **5-10 times** larger than that in Adam/AdamW.
- Adan is relatively robust to `beta1`, `beta2,` and `beta3`, especially for `beta2`. If you want better performance, you can first tune `beta3` and then `beta1`.
- Interestingly, we found that `weight_decay = 0.02` is suitable for all experiments in our paper.
- Adan has a slightly higher GPU memory cost than Adam/AdamW on a single node. However, this problem can be solved using the [ZeroRedundancyOptimizer](https://pytorch.org/tutorials/recipes/zero_redundancy_optimizer.html), which shares optimizer states across distributed data-parallel processes to reduce per-process memory footprint. Specifically, when using the `ZeroRedundancyOptimizer` on more than two GPUs, **Adan and Adam consume almost the same amount of memory.**

#### 3) More extra detailed steps&results

Please refer to the following links for detailed steps. In these detailed steps, we even include the **docker images** for reproducibility.

- [Instruction](./CV/timm/) for **<u>ViTs</u>**, **<u>ResNets</u>**, and **<u>ConvNext</u>**.
- [Instruction](./CV/MAE/) for **<u>MAE</u>**.
- [Instruction](./NLP/BERT/) for **<u>BERT</u>**.
- [Instruction](./NLP/Transformer-XL/) for **<u>Transformer-XL</u>**.
- [Instruction](./gpt2/) for **<u>GPT2</u>**
- [Resutls](./dreamfusion/) for **<u> text-to-3D DreamFusion</u>**.

## Model Zoo

### Results on vision tasks

For your convenience to use Adan, we provide the configs and log files for the experiments on ImageNet-1k.

| Model         |  Epoch  | Training Setting | Acc. (%) |                               Config                                | Batch Size |                                    Download                                     |
| ------------- | :-----: | :--------------: | :------: | :-----------------------------------------------------------------: | :--------: | :-----------------------------------------------------------------------------: |
| ViT-S         |   150   |        I         |   80.1   |   [config](./CV/timm/exp_results/ViT/small/args_vit-s_150-I.yaml)   |    2048    |      [log](./CV/timm/exp_results/ViT/small/summary_vit-s_150-I.csv)/model       |
| ViT-S         |   150   |        II        |   79.6   |    [config](./CV/timm/exp_results/ViT/small/args_vit-s_150.yaml)    |    2048    |       [log](./CV/timm/exp_results/ViT/small/summary_vit-s_150.csv)/model        |
| ViT-S         |   300   |        I         |   81.1   |   [config](./CV/timm/exp_results/ViT/small/args_vit-s_300-I.yaml)   |    2048    |      [log](./CV/timm/exp_results/ViT/small/summary_vit-s_300-I.csv)/model       |
| ViT-S         |   300   |        II        |   80.7   |    [config](./CV/timm/exp_results/ViT/small/args_vit-s_300.yaml)    |    2048    |       [log](./CV/timm/exp_results/ViT/small/summary_vit-s_300.csv)/model        |
| ViT-B         |   150   |        II        |   81.7   |    [config](./CV/timm/exp_results/ViT/base/args_vit-B_150.yaml)     |    2048    |        [log](./CV/timm/exp_results/ViT/base/summary_vit-B_150.csv)/model        |
| ViT-B         |   300   |        II        |   82.6   |   [config](./CV/timm/exp_results/ViT/base/args_vit-B_300_T.yaml)    |    2048    |       [log](./CV/timm/exp_results/ViT/base/summary_vit-B_300_T.csv)/model       |
| ResNet-50     |   100   |        I         |   78.1   |  [config](./CV/timm/exp_results/ResNet/Res50/args_res50_100.yaml)   |    2048    |      [log](./CV/timm/exp_results/ResNet/Res50/summary_res50_100.csv)/model      |
| ResNet-50     |   200   |        I         |   79.7   |  [config](./CV/timm/exp_results/ResNet/Res50/args_res50_200.yaml)   |    2048    |      [log](./CV/timm/exp_results/ResNet/Res50/summary_res50_200.csv)/model      |
| ResNet-50     |   300   |        I         |   80.2   |  [config](./CV/timm/exp_results/ResNet/Res50/args_res50_300.yaml)   |    2048    |      [log](./CV/timm/exp_results/ResNet/Res50/summary_res50_300.csv)/model      |
| ResNet-101    |   100   |        I         |   80.0   | [config](./CV/timm/exp_results/ResNet/Res101/args_res101_100.yaml)  |    2048    |     [log](./CV/timm/exp_results/ResNet/Res101/summary_res101_100.csv)/model     |
| ResNet-101    |   200   |        I         |   81.6   | [config](./CV/timm/exp_results/ResNet/Res101/args_res101_200.yaml)  |    2048    |     [log](./CV/timm/exp_results/ResNet/Res101/summary_res101_200.csv)/model     |
| ResNet-101    |   300   |        I         |   81.9   | [config](./CV/timm/exp_results/ResNet/Res101/args_res101_300.yaml)  |    2048    |     [log](./CV/timm/exp_results/ResNet/Res101/summary_res101_300.csv)/model     |
| ConvNext-tiny |   150   |        II        |   81.7   | [config](./CV/timm/exp_results/ConvNext/small/args_cvnext_150.yaml) |    2048    |    [log](./CV/timm/exp_results/ConvNext/small/summary_cvnext_150.csv)//model    |
| ConvNext-tiny |   300   |        II        |   82.4   | [config](./CV/timm/exp_results/ConvNext/small/args_cvnext_300.yaml) |    2048    |    [log](./CV/timm/exp_results/ConvNext/small/summary_cvnext_300.csv)/model     |
| MAE-small     | 800+100 |       ---        |   83.8   |                    [config](./CV/MAE/README.md)                     | 4096/2048  | [log-pretrain](./CV/MAE/exp_results/MAE/base/log_base_pretrain.txt)/[log-finetune](./CV/MAE/exp_results/MAE/base/log_base_ft.txt)/model |
| MAE-Large     | 800+50  |       ---        |   85.9   |                    [config](./CV/MAE/README.md)                     | 4096/2048  | [log-pretrain](./CV/MAE/exp_results/MAE/large/log_large_pretrain.txt)/[log-finetune](./CV/MAE/exp_results/MAE/large/log_large_ft.txt)/model |

### Results on NLP tasks

#### BERT-base

We give the configs and log files of the BERT-base model pre-trained on the Bookcorpus and Wikipedia datasets and fine-tuned on GLUE tasks. Note that we provide the config, log file, and detailed [instructions](./NLP/BERT/README.md) for BERT-base in the folder `./NLP/BERT`.

| Pretraining |                         Config                         | Batch Size |                             Log                             | Model |
| ----------- | :----------------------------------------------------: | :--------: | :---------------------------------------------------------: | :---: |
| Adan        | [config](./NLP/BERT/config/pretraining/bert-adan.yaml) |    256     | [log](./NLP/BERT/exp_results/pretrain/hydra_train-adan.log) | model |

| Fine-tuning on GLUE-Task | Metric                       |  Result   |                         Config                         |
| ------------------------ | :--------------------------- | :-------: | :----------------------------------------------------: |
| CoLA                     | Matthew's corr.              |   64.6    | [config](./NLP/BERT/config/finetuning/cola-adan.yaml)  |
| SST-2                    | Accuracy                     |   93.2    | [config](./NLP/BERT/config/finetuning/sst_2-adan.yaml) |
| STS-B                    | Person corr.                 |   89.3    | [config](./NLP/BERT/config/finetuning/sts_b-adan.yaml) |
| QQP                      | Accuracy                     |   91.2    |  [config](./NLP/BERT/config/finetuning/qqp-adan.yaml)  |
| MNLI                     | Matched acc./Mismatched acc. | 85.7/85.6 | [config](./NLP/BERT/config/finetuning/mnli-adan.yaml)  |
| QNLI                     | Accuracy                     |   91.3    | [config](./NLP/BERT/config/finetuning/qnli-adan.yaml)  |
| RTE                      | Accuracy                     |   73.3    |  [config](./NLP/BERT/config/finetuning/rte-adan.yaml)  |

For fine-tuning on GLUE-Task, see the total batch size in their corresponding configure files.

#### Transformer-XL-base

We provide the config and log for Transformer-XL-base trained on the WikiText-103 dataset. The total batch size for this experiment is `60*4`.

|                     | Steps | Test PPL |                          Download                           |
| ------------------- | :---: | :------: | :---------------------------------------------------------: |
| Baseline (Adam)     | 200k  |   24.2   | [log&config](./NLP/Transformer-XL/exp_results/log-adam.txt) |
| Transformer-XL-base |  50k  |   26.2   | [log&config](./NLP/Transformer-XL/exp_results/log-50k.txt)  |
| Transformer-XL-base | 100k  |   24.2   | [log&config](./NLP/Transformer-XL/exp_results/log-100k.txt) |
| Transformer-XL-base | 200k  |   23.5   | [log&config](./NLP/Transformer-XL/exp_results/log-200k.txt) |

### Results on Large Language Models

#### GPT2-345m

We provide the config and log for GPT2-345m pre-trained on the dataset that comes from [BigCode](https://www.bigcode-project.org/) and evaluated on the [HumanEval](https://github.com/openai/human-eval) dataset by zero-shot learning. [HumanEval](https://github.com/openai/human-eval) is used to measure functional correctness for synthesizing programs from docstrings. It consists of 164 original programming problems, assessing language comprehension, algorithms, and simple mathematics, with some comparable to simple software interview questions. We set ` Temperature = 0.8` during evaluation.

|                  | Steps | pass@1 | pass@10 | pass@100 |                                  Download                                  |
| ---------------- | :---: | :----: | :-----: | :------: | :------------------------------------------------------------------------: |
| GPT2-345m (Adam) | 300k  | 0.0840 |  0.209  |  0.360   | [log&config](https://github.com/sail-sg/Adan/files/10362486/gpt2-adam.log) |
| GPT2-345m (Adan) | 150k  | 0.0843 |  0.221  |  0.377   | [log&config](https://github.com/sail-sg/Adan/files/10362485/gpt2-adan.log) |

<u>**Adan obtains comparable results with only half cost**</u>.

### Results on Diffusion Models

We show the results of the text-to-3D task supported by the [DreamFusion Project](https://github.com/ashawkey/stable-dreamfusion). More visualization results could be founded [here](./dreamfusion/).
Examples generated from text prompt `Sydney opera house, aerial view` with Adam and Adan:

https://user-images.githubusercontent.com/10042844/211014601-da430196-021d-4f6b-962b-8441feff5d02.mp4

https://user-images.githubusercontent.com/10042844/211014594-3b5c05e3-9018-4a39-b5db-d6f2fc111cce.mp4