Update README.md

README.md

@@ -1,15 +1,84 @@
----
-datasets:
-- openbookqa
-- sciq
-- Open-Orca/OpenOrca
-- metaeval/ScienceQA_text_only
-- GAIR/lima
-language:
-- en
-pipeline_tag: text-generation
-tags:
-- upstage
-- llama
----
-This contains the weights for the LLaMA-30b model. This model is under a non-commercial license [see the LICENSE file](https://github.com/facebookresearch/llama/blob/main/LICENSE). You should only use this repository if you have been granted access to the model by filling out [this form](https://docs.google.com/forms/d/e/1FAIpQLSfqNECQnMkycAp2jP4Z9TFX0cGR4uf7b_fBxjY_OjhJILlKGA/viewform) but either lost your copy of the weights or got some trouble converting them to the Transformers format.
+# LLaMa-30b-instruct model card
+
+**Model Developers**
+- Upstage [[1]]
+
+**Backbone Model**
+- LLaMA [[2]]
+
+**Variations**
+- It has different model parameter sizes and sequence lengths: 30B/1024 [[3]], 30B/2048 [[4]], 65B/1024 [[5]].
+
+**Input**
+- Models solely process textual input.
+
+**Output**
+- Models solely generate textual output
+
+**License**
+- This model is under a Non-commercial Bespoke License and governed by the Meta license. You should only use this repository if you have been granted access to the model by filling out this form [[6]], but have either lost your copy of the weights or encountered issues converting them to the Transformers format.
+
+**Where to send comments**
+- Instructions on how to provide feedback or comments on a model can be found by opening an issue in the Hugging Face community's model repository [[7]].
+
+## Dataset Details
+
+**Used Datasets**
+- openbookqa [[8]]
+- sciq [[9]]
+- Open-Orca/OpenOrca [[10]]
+- metaeval/ScienceQA_text_only [[11]]
+- GAIR/lima [[12]]
+
+## Hardware and Software
+
+**Hardware**
+- We utilized an A100 for training our model.
+
+**Training Factors**
+- We fine-tuned this model using a combination of the DeepSpeed library [[13]] and the HuggingFace trainer [[14]].
+
+## Evaluation Results
+
+**Overview**
+- We conducted a performance evaluation based on the tasks being evaluated on the Open LLM Leaderboard [[15]]. We evaluated our model on four benchmark datasets, which include ARC-Challenge, HellaSwag, MMLU, and TruthfulQA. We used the lm-evaluation-harness repository, specifically commit b281b0921b636bc36ad05c0b0b0763bd6dd43463. We can reproduce the evaluation environments using the command below:
+
+- **Main Results**
+
+| Model                                         | Average | ARC   | HellaSwag | MMLU  | TruthfulQA |
+|-----------------------------------------------|---------|-------|-----------|-------|------------|
+| llama-30b-instruct-2048 (Ours)                | **64.7** | 58.3  | 82.5      | 61.4  | **56.5**    |
+| falcon-40b-instruct                           | 63.4    | **61.6** | **84.3**      | 55.4  | 52.5        |
+| llama-30b-instruct (Ours)                     | 63.2    | 56.7  | 84        | 59    | 53.1        |
+| llama-65b                                     | 62.1    | 57.6  | **84.3**      | **63.4**  | 43          |
+
+*Experimental results based on the Open LLM Leaderboard*
+
+## Ethical Issues
+
+**Ethical Considerations**
+- There were no ethical issues involved, as we did not include the benchmark test set or the training set in the model's training process.
+
+## Contact Us
+
+**Why Upstage LLM?**
+- Upstage's [[1]] LLM research has yielded remarkable results. Our 30B model size outperforms all models worldwide with less than 65B, establishing itself as the leading performer. Recognizing the immense potential for private LLM adoption within companies, we invite you to effortlessly implement a private LLM and fine-tune it with your own data. For a seamless and tailored solution, please don't hesitate to reach out to us [[16]].
+
+[1]: https://en.upstage.ai
+[2]: https://github.com/facebookresearch/llama/tree/llama_v1
+[3]: https://huggingface.co/upstage/llama-30b-instruct
+[4]: https://huggingface.co/upstage/llama-30b-instruct-2048
+[5]: https://huggingface.co/upstage/llama-65b-instruct
+[6]: https://docs.google.com/forms/d/e/1FAIpQLSfqNECQnMkycAp2jP4Z9TFX0cGR4uf7b_fBxjY_OjhJILlKGA/viewform
+[7]: https://huggingface.co/upstage/llama-30b-instruct-2048/discussions
+[8]: https://huggingface.co/datasets/openbookqa
+[9]: https://huggingface.co/datasets/sciq
+[10]: https://huggingface.co/datasets/Open-Orca/OpenOrca
+[11]: https://huggingface.co/datasets/metaeval/ScienceQA_text_only
+[12]: https://huggingface.co/datasets/GAIR/lima
+[13]: https://github.com/microsoft/DeepSpeed
+[14]: https://huggingface.co/docs/transformers/main_classes/trainer
+[15]: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard
+[16]: mailto:contact@upstage.ai
+
+