Create README.md

README.md

@@ -0,0 +1,73 @@
+---
+license: llama2
+datasets:
+- garage-bAInd/Open-Platypus
+pipeline_tag: text-generation
+language:
+- en
+---
+
+
+# mistral-7b-v0.1-platypus1k
+
+
+**mistral-7b-v0.1-platypus1k** is an instruction fine-tuned model based on the Mistral-7B transformer architecture.
+
+
+### Benchmark Metrics
+
+
+| Metric                | mistral-7b-v0.1-platypus1k | garage-bAInd/Platypus2-7B| meta-llama/Llama-2-7b-hf  (base) |
+|-----------------------|-------|-------|-------|
+| Avg.                  | - |**56.13** | 54.32 |
+| ARC (25-shot)         | - |**55.2**| 53.07 |
+| HellaSwag (10-shot)   | - |**78.84**| 78.59 |
+| MMLU (5-shot)         | - |**49.83**| 46.87 |
+| TruthfulQA (0-shot)   | - |40.64| 38.76 |
+
+
+We use state-of-the-art [Language Model Evaluation Harness](https://github.com/EleutherAI/lm-evaluation-harness) to run the benchmark tests above, using the same version as the HuggingFace LLM Leaderboard. Please see below for detailed instructions on reproducing benchmark results.
+
+### Model Details
+
+* **Trained by**: Luiz G A Alves
+* **Model type:**  **mistral-7b-v0.1-platypus1k** is an auto-regressive language model based on the Mistral-7B transformer architecture.
+* **Language(s)**: English
+
+### How to use:
+
+```python
+# Use a pipeline as a high-level helper
+>>> from transformers import pipeline
+>>> pipe = pipeline("text-generation", model="lgaalves/mistral-7b-v0.1-platypus1k")
+>>> question = "What is a large language model?"
+>>> answer = pipe(question)
+>>> print(answer[0]['generated_text'])
+
+```
+
+or, you can load the model direclty using:
+
+```python
+# Load model directly
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+tokenizer = AutoTokenizer.from_pretrained("lgaalves/mistral-7b-v0.1-platypus1k")
+model = AutoModelForCausalLM.from_pretrained("lgaalves/mistral-7b-v0.1-platypus1k")
+```
+
+### Training Dataset
+
+`lgaalves/mistral-7b-v0.1-platypus1k` trained using STEM and logic based dataset [`garage-bAInd/Open-Platypus`](https://huggingface.co/datasets/garage-bAInd/Open-Platypus).
+
+
+### Training Procedure
+
+`lgaalves/mistral-7b-v0.1-platypus1k` was instruction fine-tuned using LoRA on 1 Tesla V100-SXM2-16GB. 
+
+
+### Limitations and bias
+
+Llama 2 and fine-tuned variants are a new technology that carries risks with use. Testing conducted to date has been in English, and has not covered, nor could it cover all scenarios. For these reasons, as with all LLMs, Llama 2 and any fine-tuned varient's potential outputs cannot be predicted in advance, and the model may in some instances produce inaccurate, biased or other objectionable responses to user prompts. Therefore, before deploying any applications of Llama 2 variants, developers should perform safety testing and tuning tailored to their specific applications of the model.
+
+Please see the Responsible Use Guide available at https://ai.meta.com/llama/responsible-use-guide/