Update README of the model

README.md

@@ -1 +1,49 @@
-To be written, for now please see: [README.md](https://github.com/bigscience-workshop/bigscience/tree/master/train/tr11-176B-ml)
+# BigScience Large Language Model Training
+Training a multilingual 176 billion parameters model in the open
+![BigScience Logo](https://assets.website-files.com/6139f3cdcbbff3a68486761d/613cd8997b270da063e230c5_Tekengebied%201-p-500.png)
+
+[BigScience](https://bigscience.huggingface.co) is a open and collaborative workshop around the study and creation of very large language models gathering more than 1000 researchers around the worlds. You can find more information on the main website at https://bigscience.huggingface.co.
+
+The training of BigScience’s main model started on **March 11, 2022 11:42am PST** and will last 3-4 months on the 416 A100 GPUs of the Jean Zay public supercomputer
+
+You can follow the training at [https://twitter.com/BigScienceLLM](https://twitter.com/BigScienceLLM)
+
+## More information on the model, dataset, hardware, environmental consideration:
+
+### **The model**
+
+- 176B parameters decoder-only architecture (GPT-like)
+- 70 layers - 112 attention heads per layers - hidden dimensionality of 14336 - 2048 tokens sequence length
+- ALiBi positional embeddings - GeLU activation function
+- **More information**:
+    - Blog post summarizing how the architecture, size, shape, and pre-training duration where selected: [https://bigscience.huggingface.co/blog/what-language-model-to-train-if-you-have-two-million-gpu-hours](https://bigscience.huggingface.co/blog/what-language-model-to-train-if-you-have-two-million-gpu-hours)
+    - More details on the architecture/optimizer: [https://github.com/bigscience-workshop/bigscience/tree/master/train/tr11-176B-ml](https://github.com/bigscience-workshop/bigscience/tree/master/train/tr11-176B-ml)
+
+### **The dataset**
+ 
+- Multilingual: 46 languages: Full list is here: [https://bigscience.huggingface.co/blog/building-a-tb-scale-multilingual-dataset-for-language-modeling](https://bigscience.huggingface.co/blog/building-a-tb-scale-multilingual-dataset-for-language-modeling)
+- 341.6 billion tokens (1.5 TB of text data)
+- Tokenizer vocabulary: 250 680 tokens
+- More information:
+    - Blog post detailing the design choices during the dataset creation: [https://bigscience.huggingface.co/blog/building-a-tb-scale-multilingual-dataset-for-language-modeling](https://bigscience.huggingface.co/blog/building-a-tb-scale-multilingual-dataset-for-language-modeling)
+
+### **The engineering side**
+
+- number of GPU used for the training: 384 A100 GPU with 80 Gb of memory each
+- one copy of the model takes 48 GPUs (using 60 GB of memory on each GPU)
+- checkpoint size: only the bf16 weights are 329GB, the full checkpoint with optimizer states is 2.3TB
+- training throughput: about 150 TFLOPs
+- estimated training time: 3-4 months depending on throughput and unexpected events
+- **More information**:
+    - Blog post on the hardware/engineering side: [https://bigscience.huggingface.co/blog/which-hardware-to-train-a-176b-parameters-model](https://bigscience.huggingface.co/blog/which-hardware-to-train-a-176b-parameters-model)
+    - Details on the distributed setup used for the training: [https://github.com/bigscience-workshop/bigscience/tree/master/train/tr11-176B-ml](https://github.com/bigscience-workshop/bigscience/tree/master/train/tr11-176B-ml)
+    - Tensorboard updated during the training: [https://huggingface.co/bigscience/tr11-176B-ml-logs/tensorboard#scalars&tagFilter=loss](https://huggingface.co/bigscience/tr11-176B-ml-logs/tensorboard#scalars&tagFilter=loss)
+    - Details on the obstacles overcome during the preparation on the engineering side (instabilities, optimization of training throughput, so many technical tricks and questions): [https://github.com/bigscience-workshop/bigscience/blob/master/train/tr11-176B-ml/chronicles.md](https://github.com/bigscience-workshop/bigscience/blob/master/train/tr11-176B-ml/chronicles.md)
+
+### **Environmental considerations**
+
+- [Jean Zay](http://www.idris.fr/eng/jean-zay/jean-zay-presentation-eng.html), the supercomputer we are using for model training, is mostly powered by nuclear energy, which is a low carbon energy source.
+- Significant efforts were made to make sure that the computing infrastructure is as efficient as possible — the heat generated by the hardware even gets used for heating buildings on campus!
+- **More information**:
+    - We are currently working on making a precise estimate of the carbon emitted during all of the steps of model training, including intermediate experiments as well as inference.
+    - More soon!