draft v2

README.md

@@ -16,16 +16,16 @@ base_model:
 Granite-3.1-8B-Instruct is a 8B parameter model finetuned from *Granite-3.1-8B-Base* using a combination of open source instruction datasets with permissive license and internally collected synthetic datasets. This model is developed using a diverse set of techniques with a structured chat format, including supervised finetuning, model alignment using reinforcement learning, and model merging.
 
 - **Developers:** Granite Team, IBM
-- **GitHub Repository:** [ibm-granite/granite-3.1-8b-instruct]()
+- **GitHub Repository:** [ibm-granite/granite-3.1-language-models](https://github.com/ibm-granite/granite-3.1-language-models)
 - **Website**: [Granite Docs](https://www.ibm.com/granite/docs/)
-- **Paper:** [Granite 3.1 Language Models]()
+- **Paper:** [Granite 3.1 Language Models (coming soon)](https://huggingface.co/collections/ibm-granite/granite-31-language-models-6751dbbf2f3389bec5c6f02d) 
 - **Release Date**: December 18th, 2024
 - **License:** [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)
 
 **Supported Languages:** 
 English, German, Spanish, French, Japanese, Portuguese, Arabic, Czech, Italian, Korean, Dutch, and Chinese. Users may finetune Granite 3.1 models for languages beyond these 12 languages.
 
-**Intended use:** 
+**Intended Use:** 
 The model is designed to respond to general instructions and can be used to build AI assistants for multiple domains, including business applications.
 
 *Capabilities*
@@ -88,20 +88,20 @@ Granite-3.1-8B-Instruct is based on a decoder-only dense transformer architectur
 | Number of KV heads        | 8        | **8**        | 8      | 8      |
 | MLP hidden size           | 8192     | **12800**    | 512    | 512    |
 | MLP activation            | SwiGLU   | **SwiGLU**   | SwiGLU | SwiGLU |
-| Number of Experts         | —        | **—**        | 32     | 40     |
+| Number of experts         | —        | **—**        | 32     | 40     |
 | MoE TopK                  | —        | **—**        | 8      | 8      |
 | Initialization std        | 0.1      | **0.1**      | 0.1    | 0.1    |
-| Sequence Length           | 4096     | **4096**     | 4096   | 4096   |
-| Position Embedding        | RoPE     | **RoPE**     | RoPE   | RoPE   |
+| Sequence length           | 128K     | **128K**     | 128K   | 128K   | 
+| Position embedding        | RoPE     | **RoPE**     | RoPE   | RoPE   |
 | # Parameters              | 2.5B     | **8.1B**     | 1.3B   | 3.3B   |
-| # Active Parameters       | 2.5B     | **8.1B**     | 400M   | 800M   |
+| # Active parameters       | 2.5B     | **8.1B**     | 400M   | 800M   |
 | # Training tokens         | 12T      | **12T**      | 10T    | 10T    |
 
 **Training Data:** 
 Overall, our SFT data is largely comprised of three key sources: (1) publicly available datasets with permissive license, (2) internal synthetic data targeting specific capabilities, and (3) very small amounts of human-curated data. A detailed attribution of datasets can be found in the [Granite Technical Report]() and [Accompanying Author List]().
 
 **Infrastructure:**
-We train Granite 3.1 Language Models using IBM's super computing cluster, Blue Vela, which is outfitted with NVIDIA H100 GPUs. This cluster provides a scalable and efficient infrastructure for training our models over thousands of GPUs while minimizing environmental impact by utilizing 100% renewable energy sources.
+We train Granite 3.1 Language Models using IBM's super computing cluster, Blue Vela, which is outfitted with NVIDIA H100 GPUs. This cluster provides a scalable and efficient infrastructure for training our models over thousands of GPUs.
 
 **Ethical Considerations and Limitations:** 
 Granite 3.1 Instruct Models are primarily finetuned using instruction-response pairs mostly in English, but also multilingual data covering eleven languages. Although this model can handle multilingual dialog use cases, its performance might not be similar to English tasks. In such case, introducing a small number of examples (few-shot) can help the model in generating more accurate outputs. While this model has been aligned by keeping safety in consideration, the model may in some cases produce inaccurate, biased, or unsafe responses to user prompts. So we urge the community to use this model with proper safety testing and tuning tailored for their specific tasks.