Adding Model Card

README.md

@@ -1,5 +1,174 @@
 ---
 license: other
-license_name: stability
-license_link: LICENSE
+datasets:
+- tiiuae/falcon-refinedweb
+- bigcode/the-stack-github-issues
+- bigcode/commitpackft
+- bigcode/starcoderdata
+- EleutherAI/proof-pile-2
+- meta-math/MetaMathQA
+language:
+- en
+tags:
+- causal-lm
+- code
+metrics:
+- code_eval
+library_name: transformers
 ---
+# `stable-code-completion-1.0-3b`
+
+## Model Description
+
+`stable-code-completion-1.0-3b` is a 2.7B billion parameter decoder-only language model pre-trained on 1.3 trillion tokens of diverse textual and code datasets. `stable-code-completion-1.0-3b` is trained on nearly 20 programming languages (selected based on the 2023 StackOverflow Developer Survey) and demonstrates state-of-the-art performance (compared to models of similar size) on the MultiPL-E metrics across multiple programming languages tested using [BigCode's Evaluation Harness](https://github.com/bigcode-project/bigcode-evaluation-harness/tree/main).
+
+**Key Features**
+* Fill in Middle Capability (FIM)
+* Supports Long Context, trained with Sequences upto 16,384
+
+## Usage
+
+Get started generating text with `stable-code-completion-1.0-3b` by using the following code snippet:
+
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer
+tokenizer = AutoTokenizer.from_pretrained("stabilityai/stable-code-completion-1.0-3b", trust_remote_code=True)
+model = AutoModelForCausalLM.from_pretrained(
+  "stabilityai/stable-code-completion-1.0-3b",
+  trust_remote_code=True,
+  torch_dtype="auto",
+)
+
+device = "cpu"
+if torch.cuda.is_available():
+  device = "cuda"
+
+inputs = tokenizer("import torch\nimport torch.nn as nn", return_tensors="pt").to(device)
+tokens = model.generate(
+  **inputs,
+  max_new_tokens=48,
+  temperature=0.2,
+  do_sample=True,
+)
+print(tokenizer.decode(tokens[0], skip_special_tokens=True))
+```
+
+### Run with Fill in Middle (FIM) ⚡️
+
+<details>
+<summary> Click to expand </summary>
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+tokenizer = AutoTokenizer.from_pretrained("stabilityai/stable-code-completion-1.0-3b", trust_remote_code=True)
+model = AutoModelForCausalLM.from_pretrained(
+  "stabilityai/stable-code-completion-1.0-3b",
+  trust_remote_code=True,
+  torch_dtype="auto",
++ attn_implementation="flash_attention_2",
+)
+
+device = "cpu"
+if torch.cuda.is_available():
+  device = "cuda"
+
+inputs = tokenizer("<fim_prefix>def fib(n):<fim_suffix>    else:\n        return fib(n - 2) + fib(n - 1)<fim_middle>", return_tensors="pt").to("cuda")
+tokens = model.generate(
+  **inputs,
+  max_new_tokens=48,
+  temperature=0.2,
+  do_sample=True,
+)
+print(tokenizer.decode(tokens[0], skip_special_tokens=True))
+```
+
+</details>
+
+### Run with Flash Attention 2 ⚡️
+
+<details>
+<summary> Click to expand </summary>
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+tokenizer = AutoTokenizer.from_pretrained("stabilityai/stable-code-completion-1.0-3b", trust_remote_code=True)
+model = AutoModelForCausalLM.from_pretrained(
+  "stabilityai/stable-code-completion-1.0-3b",
+  trust_remote_code=True,
+  torch_dtype="auto",
++ attn_implementation="flash_attention_2",
+)
+
+device = "cpu"
+if torch.cuda.is_available():
+  device = "cuda"
+
+inputs = tokenizer("import torch\nimport torch.nn as nn", return_tensors="pt").to("cuda")
+tokens = model.generate(
+  **inputs,
+  max_new_tokens=48,
+  temperature=0.2,
+  do_sample=True,
+)
+print(tokenizer.decode(tokens[0], skip_special_tokens=True))
+```
+
+</details>
+
+
+## Model Details
+
+* **Developed by**: [Stability AI](https://stability.ai/)
+* **Model type**: `stable-code-completion-1.0-3b` models are auto-regressive language models based on the transformer decoder architecture.
+* **Language(s)**: English, Code
+* **Library**: [GPT-NeoX](https://github.com/EleutherAI/gpt-neox)
+* **License**: Other
+* **Contact**: For questions and comments about the model, please email `[email protected]`
+
+### Model Architecture
+
+The model is a decoder-only transformer similar to the LLaMA ([Touvron et al., 2023](https://arxiv.org/abs/2307.09288)) architecture with the following modifications:
+
+| Parameters     | Hidden Size | Layers | Heads | Sequence Length |
+|----------------|-------------|--------|-------|-----------------|
+| 2,796,431,360  | 2560        | 32     | 32    | 16384            |
+
+* **Position Embeddings**: Rotary Position Embeddings ([Su et al., 2021](https://arxiv.org/abs/2104.09864)) applied to the first 25% of head embedding dimensions for improved throughput following [Black et al. (2022)](https://arxiv.org/pdf/2204.06745.pdf).
+* **Tokenizer**: We use a modified version of the GPTNeoX Tokenizer.[`NeoX`](https://github.com/EleutherAI/gpt-neox). We add special tokens to train for Fill in the Middle (FIM) capabilities like `<FIM_PREFIX>` and `<FIM_SUFFIX>` along with other special tokens.
+
+## Training
+
+### Training Dataset
+
+The dataset is comprised of a filtered mixture of open-source large-scale datasets available on the [HuggingFace Hub](https://huggingface.co/datasets): Falcon RefinedWeb extract ([Penedo et al., 2023](https://huggingface.co/datasets/tiiuae/falcon-refinedweb)), along with [CommitPackFT](https://huggingface.co/datasets/bigcode/commitpackft) and [Github Issues](https://huggingface.co/datasets/bigcode/the-stack-github-issues) (BigCode., 2023), and StarCoder ([Li et al., 2023](https://arxiv.org/abs/2305.06161)). We further supplement our training with data from mathematical domains ([Azerbayev, Zhangir, et al., 2023](https://arxiv.org/abs/2310.10631) and, [Yu, Longhui, et al., 2023](https://arxiv.org/abs/2309.12284)). 
+
+### Training Procedure
+
+The model is pre-trained on the aforementioned datasets in `bfloat16` precision, optimized with AdamW.
+
+### Training Infrastructure
+
+* **Hardware**: `stable-code-completion-1.0-3b` was trained on the Stability AI cluster across 256 NVIDIA A100 40GB GPUs (AWS P4d instances).
+
+* **Software**: We use a fork of `gpt-neox` ([EleutherAI, 2021](https://github.com/EleutherAI/gpt-neox)), train under 2D parallelism (Data and Tensor Parallel) with ZeRO-1 ([Rajbhandari et al., 2019](https://arxiv.org/abs/1910.02054v3)), and rely on flash-attention as well as SwiGLU and Rotary Embedding kernels from FlashAttention-2 ([Dao et al., 2023](https://tridao.me/publications/flash2/flash2.pdf))
+
+## Use and Limitations
+
+### Intended Use
+
+The model is intended to be used as a foundational base model for application-specific fine-tuning. Developers must evaluate and fine-tune the model for safe performance in downstream applications.
+
+### Limitations and Bias
+​
+As a base model, this model may exhibit unreliable, unsafe, or other undesirable behaviors that must be corrected through evaluation and fine-tuning prior to deployment. The pre-training dataset may have contained offensive or inappropriate content, even after applying data cleansing filters, which can be reflected in the model-generated text. We recommend that users exercise caution when using these models in production systems. Do not use the models if they are unsuitable for your application, or for any applications that may cause deliberate or unintentional harm to others.
+
+## How to Cite
+
+```bibtex
+@misc{stable-code-completion-1.0-3b,
+      url={[https://huggingface.co/stabilityai/stablecode-3b](https://huggingface.co/stabilityai/stablecode-3b)},
+      title={Stable Code 3B},
+      author={Pinnaparaju, Nikhil and Adithyan, Reshinth and Phung, Duy and Tow, Jonathan and Baicoianu, James and  and Cooper, Nathan}
+}
+```