transformers safetensors granitemoe text-generation language granite-3.0 conversational arxiv:0000.00000 base_model:ibm-granite/granite-3.0-3b-a800m-base base_model:finetune:ibm-granite/granite-3.0-3b-a800m-base license:apache-2.0 model-index autotrain_compatible region:us
---
base_model:
- ibm-granite/granite-3.0-3b-a800m-base
library_name: transformers
license: apache-2.0
pipeline_tag: text-generation
tags:
- language
- granite-3.0
inference: false
new_version: ibm-granite/granite-3.1-3b-a800m-instruct
model-index:
- name: granite-3.0-2b-instruct
  results:
  - task:
      type: text-generation
    dataset:
      name: IFEval
      type: instruction-following
    metrics:
    - type: pass@1
      value: 42.49
      name: pass@1
    - type: pass@1
      value: 7.02
      name: pass@1
  - task:
      type: text-generation
    dataset:
      name: AGI-Eval
      type: human-exams
    metrics:
    - type: pass@1
      value: 25.7
      name: pass@1
    - type: pass@1
      value: 50.16
      name: pass@1
    - type: pass@1
      value: 20.51
      name: pass@1
  - task:
      type: text-generation
    dataset:
      name: OBQA
      type: commonsense
    metrics:
    - type: pass@1
      value: 40.8
      name: pass@1
    - type: pass@1
      value: 59.95
      name: pass@1
    - type: pass@1
      value: 71.86
      name: pass@1
    - type: pass@1
      value: 67.01
      name: pass@1
    - type: pass@1
      value: 48
      name: pass@1
  - task:
      type: text-generation
    dataset:
      name: BoolQ
      type: reading-comprehension
    metrics:
    - type: pass@1
      value: 78.65
      name: pass@1
    - type: pass@1
      value: 6.71
      name: pass@1
  - task:
      type: text-generation
    dataset:
      name: ARC-C
      type: reasoning
    metrics:
    - type: pass@1
      value: 50.94
      name: pass@1
    - type: pass@1
      value: 26.85
      name: pass@1
    - type: pass@1
      value: 37.7
      name: pass@1
  - task:
      type: text-generation
    dataset:
      name: HumanEvalSynthesis
      type: code
    metrics:
    - type: pass@1
      value: 39.63
      name: pass@1
    - type: pass@1
      value: 40.85
      name: pass@1
    - type: pass@1
      value: 35.98
      name: pass@1
    - type: pass@1
      value: 27.4
      name: pass@1
  - task:
      type: text-generation
    dataset:
      name: GSM8K
      type: math
    metrics:
    - type: pass@1
      value: 47.54
      name: pass@1
    - type: pass@1
      value: 19.86
      name: pass@1
  - task:
      type: text-generation
    dataset:
      name: PAWS-X (7 langs)
      type: multilingual
    metrics:
    - type: pass@1
      value: 50.23
      name: pass@1
    - type: pass@1
      value: 28.87
      name: pass@1
---

<!-- ![image/png](https://cdn-uploads.huggingface.co/production/uploads/62cd5057674cdb524450093d/1hzxoPwqkBJXshKVVe6_9.png) -->
<!-- ![image/png](granite-3_0-language-models_Group_1.png) -->

# Granite-3.0-3B-A800M-Instruct

**Model Summary:**
Granite-3.0-3B-A800M-Instruct is a 3B parameter model finetuned from *Granite-3.0-3B-A800M-Base-4K* 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.0-language-models](https://github.com/ibm-granite/granite-3.0-language-models)
- **Website**: [Granite Docs](https://www.ibm.com/granite/docs/)
- **Paper:** [Granite 3.0 Language Models](https://github.com/ibm-granite/granite-3.0-language-models/blob/main/paper.pdf)
- **Release Date**: October 21st, 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.0 models for languages beyond these 12 languages.

**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*
* Summarization
* Text classification
* Text extraction
* Question-answering
* Retrieval Augmented Generation (RAG)
* Code related tasks
* Function-calling tasks
* Multilingual dialog use cases

**Generation:**
This is a simple example of how to use Granite-3.0-3B-A800M-Instruct model.

Install the following libraries:

```shell
pip install torch torchvision torchaudio
pip install accelerate
pip install transformers
```
Then, copy the snippet from the section that is relevant for your use case.

```python
import torch
from transformers import AutoModelForCausalLM, AutoTokenizer

device = "auto"
model_path = "ibm-granite/granite-3.0-3b-a800m-instruct"
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
chat = [
    { "role": "user", "content": "Please list one IBM Research laboratory located in the United States. You should only output its name and location." },
]
chat = tokenizer.apply_chat_template(chat, tokenize=False, add_generation_prompt=True)
# tokenize the text
input_tokens = tokenizer(chat, return_tensors="pt").to(device)
# generate output tokens
output = model.generate(**input_tokens, 
                        max_new_tokens=100)
# decode output tokens into text
output = tokenizer.batch_decode(output)
# print output
print(output)
```

**Model Architecture:** 
Granite-3.0-3B-A800M-Instruct 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              | 4096     | 4096     | 4096     | **4096**     |
| 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:** 
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](https://github.com/ibm-granite/granite-3.0-language-models/blob/main/paper.pdf) and [Accompanying Author List](https://github.com/ibm-granite/granite-3.0-language-models/blob/main/author-ack.pdf).

**Infrastructure:**
We train Granite 3.0 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.

**Ethical Considerations and Limitations:** 
Granite 3.0 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.

**Resources**
- ⭐️ Learn about the latest updates with Granite: https://www.ibm.com/granite
- 📄 Get started with tutorials, best practices, and prompt engineering advice: https://www.ibm.com/granite/docs/
- 💡 Learn about the latest Granite learning resources: https://ibm.biz/granite-learning-resources

<!-- ## Citation
```
@misc{granite-models,
  author = {author 1, author2, ...},
  title = {},
  journal = {},
  volume = {},
  year = {2024},
  url = {https://arxiv.org/abs/0000.00000},
}
``` -->