Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,132 @@
+
+---
+
+pipeline_tag: text-generation
+inference: false
+license: apache-2.0
+library_name: transformers
+tags:
+- language
+- granite-3.1
+base_model:
+- ibm-granite/granite-3.1-3b-a800m-base
+
+---
+
+[![QuantFactory Banner](https://lh7-rt.googleusercontent.com/docsz/AD_4nXeiuCm7c8lEwEJuRey9kiVZsRn2W-b4pWlu3-X534V3YmVuVc2ZL-NXg2RkzSOOS2JXGHutDuyyNAUtdJI65jGTo8jT9Y99tMi4H4MqL44Uc5QKG77B0d6-JfIkZHFaUA71-RtjyYZWVIhqsNZcx8-OMaA?key=xt3VSDoCbmTY7o-cwwOFwQ)](https://hf.co/QuantFactory)
+
+
+# QuantFactory/granite-3.1-3b-a800m-instruct-GGUF
+This is quantized version of [ibm-granite/granite-3.1-3b-a800m-instruct](https://huggingface.co/ibm-granite/granite-3.1-3b-a800m-instruct) created using llama.cpp
+
+# Original Model Card
+
+
+# Granite-3.1-3B-A800M-Instruct
+
+**Model Summary:**
+Granite-3.1-3B-A800M-Instruct is a 3B parameter long-context instruct model finetuned from Granite-3.1-3B-A800M-Base using a combination of open source instruction datasets with permissive license and internally collected synthetic datasets tailored for solving long context problems. 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-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:** 
+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
+* Long-context tasks including long document/meeting summarization, long document QA, etc.
+
+**Generation:** 
+This is a simple example of how to use Granite-3.1-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.1-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.1-3B-A800M-Instruct is based on a decoder-only dense transformer architecture. Core components of this architecture are: GQA and RoPE, MLP with SwiGLU, RMSNorm, and shared input/output embeddings.
+
+| 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:** 
+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 including long-context tasks, and (3) very small amounts of human-curated data. 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:** 
+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.
+
+<!-- ## Citation
+```
+@misc{granite-models,
+  author = {author 1, author2, ...},
+  title = {},
+  journal = {},
+  volume = {},
+  year = {2024},
+  url = {https://arxiv.org/abs/0000.00000},
+}
+``` -->