Update README.md

README.md

@@ -1,3 +1,107 @@
----
-license: apache-2.0
----
+---
+pipeline_tag: text-generation
+inference: false
+license: apache-2.0
+library_name: transformers
+tags:
+- language
+- granite-3.1
+---
+
+# Granite-3.1-3B-A800M-Base
+
+**Model Summary:**
+Granite-3.1-3B-A800M-Base extends the context length of Granite-3.0-3B-A800M-Base from 4K to 128K using a progressive training strategy by increasing the supported context length in increments while adjusting RoPE theta until the model has successfully adapted to desired length of 128K. This long-context pre-training stage was performed using approximately 500B tokens.
+
+- **Developers:** Granite Team, IBM
+- **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 (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:** 
+Prominent use cases of LLMs in text-to-text generation include summarization, text classification, extraction, question-answering, and more. All Granite Base models are able to handle these tasks as they were trained on a large amount of data from various domains. Moreover, they can serve as baseline to create specialized models for specific application scenarios.
+
+**Generation:** 
+This is a simple example of how to use Granite-3.1-3B-A800M-Base model.
+
+Install the following libraries:
+
+```shell
+pip install torch torchvision torchaudio
+pip install accelerate
+pip install transformers
+```
+Then, copy the code snippet below to run the example.
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+device = "auto"
+model_path = "ibm-granite/Granite-3.1-3B-A800M-base"
+tokenizer = AutoTokenizer.from_pretrained(model_path)
+# drop device_map if running on CPU
+model = AutoModelForCausalLM.from_pretrained(model_path, device_map=device)
+model.eval()
+# change input text as desired
+input_text = "Where is the Thomas J. Watson Research Center located?"
+# tokenize the text
+input_tokens = tokenizer(input_text, return_tensors="pt").to(device)
+# generate output tokens
+output = model.generate(**input_tokens,
+                        max_length=4000)
+# decode output tokens into text
+output = tokenizer.batch_decode(output)
+# print output
+print(output)
+```
+
+**Model Architecture:** 
+Granite-3.1-3B-A800M-Base is based on a decoder-only sparse Mixture of Experts (MoE) transformer architecture. Core components of this architecture are: Fine-grained Experts, Dropless Token Routing, and Load Balancing Loss.
+
+| Model                        | 2B Dense | 8B Dense | 1B MoE       | 3B MoE   |
+| :--------                    | :--------| :--------| :--------    | :--------|
+| Embedding size               | 2048     | 4096     | **1024**     | 1536     |
+| Number of layers             | 40       | 40       | **24**       | 32       |
+| Attention head size          | 64       | 128      | **64**       | 64       |
+| Number of attention heads    | 32       | 32       | **16**       | 24       |
+| 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       |
+| MoE TopK                     | —        | —        | **8**        | 8        |
+| Initialization std           | 0.1      | 0.1      | **0.1**      | 0.1      |
+| 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     |
+| # Training tokens            | 12T      | 12T      | **10T**      | 10T      |
+
+**Training Data:** 
+This model is trained on a mix of open source and proprietary data following a two-stage training strategy.
+* Stage 1 data: The data for stage 1 is sourced from diverse domains, such as: web, code, academic sources, books, and math data.
+* Stage 2 data: The data for stage 2 comprises a curated mix of high-quality data from the same domains, plus multilingual and instruction data. The goal of this second training phase is to enhance the model’s performance on specific tasks.
+* Stage 3 data: The data for stage 3 consists of original stage-2 pretraining data with additional synthetic long-context data in form of QA/summary pairs where the answer contains a recitation of the related paragraph before the answer.
+ 
+A detailed attribution of datasets can be found in the [Granite 3.0 Technical Report](https://github.com/ibm-granite/granite-3.0-language-models/blob/main/paper.pdf), [Granite 3.1 Technical Report (coming soon)](https://huggingface.co/collections/ibm-granite/granite-31-language-models-6751dbbf2f3389bec5c6f02d), and [Accompanying Author List](https://github.com/ibm-granite/granite-3.0-language-models/blob/main/author-ack.pdf).
+
+**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.
+
+**Ethical Considerations and Limitations:**
+The use of Large Language Models involves risks and ethical considerations people must be aware of, including but not limited to: bias and fairness, misinformation, and autonomous decision-making. Granite-3.1-3B-A800M-Base model is not the exception in this regard. Even though this model is suited for multiple generative AI tasks, it has not undergone any safety alignment, there it may produce problematic outputs. Additionally, it remains uncertain whether smaller models might exhibit increased susceptibility to hallucination in generation scenarios by copying text verbatim from the training dataset due to their reduced sizes and memorization capacities. This aspect is currently an active area of research, and we anticipate more rigorous exploration, comprehension, and mitigations in this domain. Regarding ethics, a latent risk associated with all Large Language Models is their malicious utilization. We urge the community to use Granite-3.1-3B-A800M-Base model with ethical intentions and in a responsible way. 
+
+<!-- ## Citation
+```
+@misc{granite-models,
+  author = {author 1, author2, ...},
+  title = {},
+  journal = {},
+  volume = {},
+  year = {2024},
+  url = {https://arxiv.org/abs/0000.00000},
+}
+``` -->