diff --git a/README.md b/README.md index 051164258f..6ea6291249 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ ## Latest News -* [2023/07] Synced with [upstream](https://github.com/NVIDIA/Megatron-LM) over 1k commits, see [rebase folder for more details](https://github.com/microsoft/Megatron-DeepSpeed/tree/main/examples_deepspeed/rebase) in terms of features and updated performance. +* [2023/07] Synced with [upstream](https://github.com/NVIDIA/Megatron-LM) over 1k commits, see [rebase folder for more details](https://github.com/deepspeedai/Megatron-DeepSpeed/tree/main/examples_deepspeed/rebase) in terms of features and updated performance. ## Megatron-DeepSpeed DeepSpeed version of NVIDIA's Megatron-LM that adds additional support for several features such as MoE model training, Curriculum Learning, 3D Parallelism, and others. The ```examples_deepspeed/``` folder includes example scripts about the features supported by DeepSpeed. ### Recent sync with NVIDIA/Megatron-LM -In July 2023, we had a sync with the NVIDIA/Megatron-LM repo (where this repo is forked from) by git-merging 1100+ commits. Details can be found in the ```examples_deepspeed/rebase``` folder. Given the amount of merged commits, bugs can happen in the cases that we haven't tested, and your contribution (bug report, bug fix pull request) is highly welcomed. We also created a [backup branch](https://github.com/microsoft/Megatron-DeepSpeed/tree/before_rebase) which is the version before this sync. This backup branch is just for comparison tests and for temporary use when you need to debug the main branch. We do not plan to continue supporting the version before sync. +In July 2023, we had a sync with the NVIDIA/Megatron-LM repo (where this repo is forked from) by git-merging 1100+ commits. Details can be found in the ```examples_deepspeed/rebase``` folder. Given the amount of merged commits, bugs can happen in the cases that we haven't tested, and your contribution (bug report, bug fix pull request) is highly welcomed. We also created a [backup branch](https://github.com/deepspeedai/Megatron-DeepSpeed/tree/before_rebase) which is the version before this sync. This backup branch is just for comparison tests and for temporary use when you need to debug the main branch. We do not plan to continue supporting the version before sync. ### Run on Azure and AzureML To try out DeepSpeed on Azure, this fork of Megatron offers easy-to-use recipes and bash scripts. We strongly recommend to start with AzureML recipe in the ```examples_deepspeed/azureml``` folder. If you have a custom infrastructure (e.g. HPC clusters) or Azure VM based environment, please refer to the bash scripts in the ```examples_deepspeed/azure``` folder. diff --git a/examples_deepspeed/bert_with_pile/README.md b/examples_deepspeed/bert_with_pile/README.md index 2fa704ecf7..7b2e08d338 100644 --- a/examples_deepspeed/bert_with_pile/README.md +++ b/examples_deepspeed/bert_with_pile/README.md @@ -8,7 +8,7 @@ This ```bert_with_pile``` folder includes examples about BERT pre-training (usin As a reference performance number, our measurements show that our example is able to achieve a throughput up to 145 TFLOPs per GPU when pre-training a 1.3B BERT model (with ZeRO stage-1, without model parallelism, with 64 NVIDIA A100 GPUs, with batch size 4096 (64 per GPU), with activation checkpointing). -One thing to note is that this pre-training recipe is NOT a strict reproduction of the [original BERT paper](https://arxiv.org/abs/1810.04805): the Pile data is larger than the data used in original BERT (and the data used by Megatron paper); Megatron-LM introduces some changes to the BERT model (see details in [Megatron paper](https://arxiv.org/abs/1909.08053)); the training hyperparameters are also different. Overall these differences lead to longer training time but also better model quality than original BERT (see MNLI score below), and supporting large model scale by the combination of ZeRO and model parallelism. If you don't have enough computation budget, we recommend to reduce the total training iterations (```train_iters``` in the script) and potentially increase the learning rate at the same time. If you want to strictly reproduce original BERT, we recommend to use our [another BERT example](https://github.com/microsoft/DeepSpeedExamples/tree/master/bing_bert). +One thing to note is that this pre-training recipe is NOT a strict reproduction of the [original BERT paper](https://arxiv.org/abs/1810.04805): the Pile data is larger than the data used in original BERT (and the data used by Megatron paper); Megatron-LM introduces some changes to the BERT model (see details in [Megatron paper](https://arxiv.org/abs/1909.08053)); the training hyperparameters are also different. Overall these differences lead to longer training time but also better model quality than original BERT (see MNLI score below), and supporting large model scale by the combination of ZeRO and model parallelism. If you don't have enough computation budget, we recommend to reduce the total training iterations (```train_iters``` in the script) and potentially increase the learning rate at the same time. If you want to strictly reproduce original BERT, we recommend to use our [another BERT example](https://github.com/deepspeedai/DeepSpeedExamples/tree/master/bing_bert). ## BERT MNLI fine-tuning ```ds_finetune_bert_mnli.sh``` is the script for BERT MNLI fine-tuning, following the hyperparameters in the [Megatron paper](https://arxiv.org/abs/1909.08053). As a reference, table below present the scores using the model pre-trained based on the script above, comparing with the scores of original BERT and Megatron paper's BERT. Our BERT-Large's score is slightly lower than Megatron paper's, mainly due to the different data we used (Pile data is much diverse and larger than the data in Megatron paper, which potentially has negative effect on small million-scale models). diff --git a/examples_deepspeed/bert_with_pile/prepare_pile_data.py b/examples_deepspeed/bert_with_pile/prepare_pile_data.py index 953d5966dd..dd4571a7ca 100644 --- a/examples_deepspeed/bert_with_pile/prepare_pile_data.py +++ b/examples_deepspeed/bert_with_pile/prepare_pile_data.py @@ -102,7 +102,7 @@ def pile_merge(file_path): # usage during merge is about 600GB. If you don't have enough memory, # one solution is to directly use the 30 data chunks as multiple # datasets. See '--data-path' in - # github.com/microsoft/Megatron-DeepSpeed/blob/main/megatron/arguments.py + # https://github.com/deepspeedai/Megatron-DeepSpeed/blob/main/megatron/arguments.py pile_merge(file_path) else: if sys.argv[1] == "range": diff --git a/examples_deepspeed/data_efficiency/bert/pile_data_download_preprocess.py b/examples_deepspeed/data_efficiency/bert/pile_data_download_preprocess.py index 1eb34124b5..ee115a44c2 100644 --- a/examples_deepspeed/data_efficiency/bert/pile_data_download_preprocess.py +++ b/examples_deepspeed/data_efficiency/bert/pile_data_download_preprocess.py @@ -103,7 +103,7 @@ def pile_merge(file_path): # usage during merge is about 600GB. If you don't have enough memory, # one solution is to directly use the 30 data chunks as multiple # datasets. See '--data-path' in - # github.com/microsoft/Megatron-DeepSpeed/blob/main/megatron/arguments.py + # https://github.com/deepspeedai/Megatron-DeepSpeed/blob/main/megatron/arguments.py pile_merge(file_path) else: if sys.argv[1] == "range": diff --git a/examples_deepspeed/deepspeed4science/megatron_long_seq_support/README.md b/examples_deepspeed/deepspeed4science/megatron_long_seq_support/README.md index 540763fdd1..44c6c4833e 100644 --- a/examples_deepspeed/deepspeed4science/megatron_long_seq_support/README.md +++ b/examples_deepspeed/deepspeed4science/megatron_long_seq_support/README.md @@ -23,8 +23,8 @@ Resolved Issues: ```shell # clone source code -git clone https://github.com/microsoft/DeepSpeed.git -git clone https://github.com/microsoft/Megatron-DeepSpeed.git +git clone https://github.com/deepspeedai/DeepSpeed.git +git clone https://github.com/deepspeedai/Megatron-DeepSpeed.git git clone https://github.com/NVIDIA/apex # creat a new virtual environment diff --git a/examples_deepspeed/rebase/README.md b/examples_deepspeed/rebase/README.md index 004469bd44..83d34a6d2a 100644 --- a/examples_deepspeed/rebase/README.md +++ b/examples_deepspeed/rebase/README.md @@ -1,7 +1,7 @@ # July 2023 sync with NVIDIA/Megatron-LM This folder includes details about the recent sync with the NVIDIA/Megatron-LM repo (where this repo is forked from). It includes example scripts we used to test after the sync, together with this README documentation about what were tested. -We also created a [backup branch](https://github.com/microsoft/Megatron-DeepSpeed/tree/before_rebase) which is the version before this sync. This branch is just for comparison tests and for temporary use when debugging the main branch. We do not plan to continue supporting the version before sync. +We also created a [backup branch](https://github.com/deepspeedai/Megatron-DeepSpeed/tree/before_rebase) which is the version before this sync. This branch is just for comparison tests and for temporary use when debugging the main branch. We do not plan to continue supporting the version before sync. ## List of rebase efforts/achievements * Enabling Megatron-LM's sequence parallel. @@ -26,7 +26,7 @@ In addition, below is a performance/convergence comparison between before and af | Case | TFLOPs (per GPU) | Validation loss at step 200 | Training script | | ---- | ---------------- | --------------------------- | --------------- | -| Before sync, GPT-3 13B, 3D parallelism | 50 | 5.73 | [script (in the backup branch)](https://github.com/microsoft/Megatron-DeepSpeed/blob/before_rebase/examples/before_rebase_test/ds_pretrain_gpt_13B.sh) | +| Before sync, GPT-3 13B, 3D parallelism | 50 | 5.73 | [script (in the backup branch)](https://github.com/deepspeedai/Megatron-DeepSpeed/blob/before_rebase/examples/before_rebase_test/ds_pretrain_gpt_13B.sh) | | After sync, GPT-3 13B, 3D parallelism | 55.6 | 5.71 | [script](ds_pretrain_gpt_13B.sh) | At last, we provide a [toy example script](ds_pretrain_gpt_125M.sh) that users can try as the first test. @@ -44,4 +44,4 @@ We also tested and verified that the Rotary Positional Embedding (RoPE) introduc ## Notes/TODOs * After the sync, DeepSpeed still relies on the older activation checkpointing mechanism (see function ```_checkpointed_forward``` in ```Megatron-DeepSpeed/megatron/model/transformer.py```) since we didn't have time to integrate with the new version yet. Contribution is very welcomed. -* (Aug 2023 update) With the contribution from 3P users (https://github.com/microsoft/Megatron-DeepSpeed/pull/225), now it's also possible to use Megatron-LM's newer activation checkpointing mechanism. However, currently it's still not compatible with DeepSpeed, so you won't be able to combine it with any DeepSpeed technologies. We DeepSpeed team compared the [older mechanism](ds_pretrain_gpt_1.3B.sh) and [newer mechanism](ds_pretrain_gpt_1.3B_megatron_checkpointing.sh) on 1 DGX-2 node (16 V100), and found that the older mechanism has less memory saving (older max allocated 15241 MB, newer 12924 MB) and higher throughput (older 23.11 TFLOPs newer 17.26 TFLOPs). Thus currently we still recommend using the older mechanism both because of the similar checkpointing performance, and (more importantly) because only older mechnaism is compatible with DeepSpeed (and in this case you can combine with ZeRO to achieve more memeory saving). +* (Aug 2023 update) With the contribution from 3P users (https://github.com/deepspeedai/Megatron-DeepSpeed/pull/225), now it's also possible to use Megatron-LM's newer activation checkpointing mechanism. However, currently it's still not compatible with DeepSpeed, so you won't be able to combine it with any DeepSpeed technologies. We DeepSpeed team compared the [older mechanism](ds_pretrain_gpt_1.3B.sh) and [newer mechanism](ds_pretrain_gpt_1.3B_megatron_checkpointing.sh) on 1 DGX-2 node (16 V100), and found that the older mechanism has less memory saving (older max allocated 15241 MB, newer 12924 MB) and higher throughput (older 23.11 TFLOPs newer 17.26 TFLOPs). Thus currently we still recommend using the older mechanism both because of the similar checkpointing performance, and (more importantly) because only older mechnaism is compatible with DeepSpeed (and in this case you can combine with ZeRO to achieve more memeory saving). diff --git a/examples_deepspeed/universal_checkpointing/README.md b/examples_deepspeed/universal_checkpointing/README.md index 281d320e99..4a27a0ea03 100644 --- a/examples_deepspeed/universal_checkpointing/README.md +++ b/examples_deepspeed/universal_checkpointing/README.md @@ -73,9 +73,9 @@ bash examples_deepspeed/universal_checkpointing/megatron_gpt/run_universal_bf16. ``` This resumption script effects the loading of universal checkpoint rather than the ZeRO checkpoint in the folder by passing `--universal-checkpoint` command line flag to the main training script (i.e., `pretrain_gpt.py`). -Please see the corresponding [pull request](https://github.com/microsoft/Megatron-DeepSpeed/pull/276) for visualizations of matching loss values between original and universal checkpoint runs for bf16 and fp16 examples. +Please see the corresponding [pull request](https://github.com/deepspeedai/Megatron-DeepSpeed/pull/276) for visualizations of matching loss values between original and universal checkpoint runs for bf16 and fp16 examples. -Combining sequence parallelism with data parallelism is another good use case for universal checkpointing, see [sp pull request](https://github.com/microsoft/DeepSpeed/pull/4752) for example and visualization of matching loss values. +Combining sequence parallelism with data parallelism is another good use case for universal checkpointing, see [sp pull request](https://github.com/deepspeedai/DeepSpeed/pull/4752) for example and visualization of matching loss values. Notes: The model weights using the ```--no-pipeline-parallel``` parameter and the model weights not using the ```--no-pipeline-parallel``` parameter are currently not supported for mutual conversion.