Update README.md

README.md

@@ -1,3 +1,84 @@
 ---
-license: apache-2.0
+license: llama2
+language:
+- en
+pipeline_tag: text-generation
+tags:
+- code
+- code llama
 ---
+
+# **rift-coder-v0-7b**
+
+![banner](https://pbs.twimg.com/profile_images/1669255916980686848/mTW-mxbC_400x400.jpg)
+
+## Table of Contents
+
+1. **<a href="https://huggingface.co/morph-labs/rift-coder-v0-7b#model-summary" target="_blank">Model Summary</a>**
+2. **<a href="https://huggingface.co/morph-labs/rift-coder-v0-7b#uses" target="_blank">Uses</a>**
+3. **<a href="https://huggingface.co/morph-labs/rift-coder-v0-7b#integrations" target="_blank">Integrations</a>**
+4. **<a href="https://huggingface.co/morph-labs/rift-coder-v0-7b#installation-and-getting-started" target="_blank">Installation and Getting Started</a>**
+5. **<a href="https://huggingface.co/morph-labs/rift-coder-v0-7b#training-data-sources-details-and-procedure" target="_blank">Training Data, Sources, Details & Procedure</a>**
+6. **<a href="https://huggingface.co/morph-labs/rift-coder-v0-7b#evaluation-and-metrics" target="_blank">Evaluation & Metrics</a>**
+7. **<a href="https://huggingface.co/morph-labs/rift-coder-v0-7b#contact" target="_blank">Contact</a>**
+8. **<a href="https://huggingface.co/morph-labs/rift-coder-v0-7b#ethical-considerations-and-limitations" target="_blank">Ethical Considerations & Limitations</a>**
+
+
+# **Model Summary**
+
+**rift-coder-v0-7b** is a finetune of **<a href="https://glaive.ai/" target="_blank">Glaive AI's</a>** model **<a href="https://huggingface.co/glaiveai/glaive-coder-7b" target="_blank">glaive-coder-7b</a>**. We conducted the fine-tuning on a representative collection of indexed repositories for Python and TypeScript.
+
+We use GGML to make rift-coder-v0-7b as accessible as possible on as much hardware as possible.
+
+This model is designed to excel at contextual code editing while maintaining the ability to run on your device. It works best in **<a href="https://www.morph.so" target="_blank">Morph Labs'</a>** VS Code extension, **<a href="https://marketplace./visualstudio.com/items?itemName=Morph.rift-vscode" target="_blank">Rift</a>**.
+
+- **Developed by:** **<a href="https://www.morph.so" target="_blank">Morph Labs</a>**
+- **Partnered with:** **<a href="https://huggingface.co/nomic-ai" target="_blank">Nomic AI</a>** & **<a href="https://huggingface.co/togethercomputer" target="_blank">Together AI</a>**
+- **Language(s) (NLP):** English. Fine-Tuned on Python & TypeScript.
+- **License:** **<a href="https://ai.meta.com/resources/models-and-libraries/llama-downloads/" target="_blank">Llama2</a>**
+- **Model Type:** Derivative of Fine-Tuned Model ultimately trained on **<a href="https://huggingface.co/codellama/CodeLlama-7b" target="_blank">CodeLlama-7b</a>**
+
+
+## Uses
+
+We suggest usage of the model when working with Python or TypeScript, as our fine-tuning occurred with those contexts in mind. The model may find utility in other domains.
+
+
+## Integrations
+
+We offer the ability to use rift-coder-v0-7b natively with the **<a href="https://marketplace.visualstudio.com/items?itemName=Morph.rift-vscode" target="_blank">Rift extension for VS Code</a>**, our extension for enabling an AI-native language server. We designed **Rift** (**<a href="https://github.com/morph-labs/rift" target="_blank">GitHub link</a>**) to be open-source, private, secure, and on-device. **Rift-Coder-7B** helps make that possible.
+
+
+## Installation and Getting Started
+
+<Jesse/Eric/Roger input>
+
+
+## Training Data, Sources, Details and Procedure
+
+<Jesse/Eric/Roger input>
+
+<!-- This should ideally link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
+
+- **Repository:** [More Information Needed]
+- **Paper [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed]
+<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+
+
+## Evaluation and Metrics
+
+<Jesse/Eric/Roger input>
+<!-- This section describes the evaluation protocols and provides the results. -->
+
+
+## Contact
+
+<we should insert contact email or something similar -- feedback form from Morph site perhaps? Also happy to put mine (Bentley) or (Jesse) @ morph.so>
+
+
+## Ethical Considerations and Limitations
+
+rift-coder-v0-7b, as with all Large Language Models, carries inherent risks with use. Testing has been solely conducted in English, and our testing has not been fully comprehensive nor could be fully comprehensive of all use scenarios. The model may be prone to producing inaccurate, unsatisfactory, or otherwise undesirable outputs, and thus we encourage all developers to test and tune to their specific use case prior to deployment.
+
+We encourage you to check out **[Meta's Responsible Use Guide for Llama 2](https://ai.meta.com/llama/responsible-user-guide)**.