Updating to more formal model card. (#6)

- Updating to more formal model card. (2b299a537fa87ab5e7acc530abec4ad88409c372)


Co-authored-by: Margaret Mitchell <[email protected]>

README.md

@@ -14,40 +14,85 @@ datasets:
 ![pull_figure](https://huggingface.co/datasets/trl-internal-testing/example-images/resolve/main/images/stack-llama.png)
 
 # Llama-se-rl-peft
-Adapter weights of an RL fine-tuned model based on LLaMA (see Meta's LLaMA release for the original LLaMA model). 
+Adapter weights of a Reinforcement Learning fine-tuned model based on the LLaMA model (see [Meta's LLaMA release](https://ai.facebook.com/blog/large-language-model-llama-meta-ai) for the original LLaMA model). 
+The model is designed to generate human-like responses to questions in Stack Exchange domains of programming, mathematics, physics, and more.
 For more info check out the [blog post](https://huggingface.co/blog/stackllama) and [github example](https://github.com/lvwerra/trl/tree/main/examples/stack_llama/scripts).
-The reward model used to train this model can be found [here](https://huggingface.co/trl-lib/llama-7b-se-rm-peft).
 
-## Model Description
-**Llama-se-rl** is a Llama-based model that has been first fine-tuned on the Stack Exchange dataset and then RL fine-tuned using a Stack Exchange Reward Model. 
-This dataset consists of questions and answers from various domains in Stack Exchange, such as programming, mathematics, physics, and more. 
-The model is designed to generate human-like responses to questions in these domains.
-The model has been training to respond to prompts with the following template:
+## Model Details
 
-```
-Question: <Query> 
+### Model Description
+**Developed by:** Hugging Face
 
-Answer: <Response>
-```
+**Model type:** An auto-regressive language model based on the transformer architecture, and fine-tuned with [Stack Exchange datasets](https://huggingface.co/datasets/lvwerra/stack-exchange-paired). 
+
+**Languages:** Predominantly English, with additional data from languages with the following ISO codes: 
+
+| bg | ca | cs | da | de | es | fr | hr | hu | it | nl | pl | pt | ro | ru | sl | sr | sv | uk |
+| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | 
+
+
+**License:** [bigscience-openrail-m](https://drive.google.com/file/d/16NqKiAkzyZ55NClubCIFup8pT2jnyVIo/view?usp=sharing)
 
-## Intended Uses & Limitations
-The **Llama-se-rl** model was trained for long form QA using [Stack Exchange](https://stackexchange.com) data wich is released under a [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/), and covers topics such as programming, mathematics, and physics.
-It is intended to demonstrate a Large Language Model's ability to follow a target behavior (in this case, generating answers to a question that would have been rated more highly on SE).
-It is not intended to replace human expertise, and answers should be validated through the use of external sources.
-Further research is also needed to attribute model generations to sources in the training data, especially in cases where the model may copy answers from the training data *verbatim*.  
+**Finetuned from:** [LLaMA](https://github.com/facebookresearch/llama/blob/main/MODEL_CARD.md)
 
-## Limitations and Bias
-The **Llama-se-rl** model inherits limitations and biases from the Llama model and also those contained in the Stack Exchange dataset.
-In particular, per the [latest developer survey for Stack Overflow](https://survey.stackoverflow.co/2022/),
+### Model Sources
+**Repository:**  [https://huggingface.co/trl-lib/llama-7b-se-rl-peft/tree/main](https://huggingface.co/trl-lib/llama-7b-se-rl-peft/tree/main)
+
+**Base Model Repository:** [https://github.com/facebookresearch/llama](https://github.com/facebookresearch/llama)
+
+**Demo:** [https://huggingface.co/spaces/trl-lib/stack-llama](https://huggingface.co/spaces/trl-lib/stack-llama)
+
+## Uses
+
+### Direct Use
+- Long-form question-answering on topics of programming, mathematics, and physics
+- Demonstrating a Large Language Model's ability to follow target behavior of generating answers to a question that would be highly rated on [Stack Exchange](https://stackexchange.com).
+
+### Out of Scope Use
+- Replacing human expertise
+
+
+## Bias, Risks, and Limitations
+- Inherits bias, risks, and limitations from the LLaMA model, as described in the [LLaMA Model Card Bias Evaluation](https://github.com/facebookresearch/llama/blob/main/MODEL_CARD.md#quantitative-analysis) and [Ethical Considerations](https://github.com/facebookresearch/llama/blob/main/MODEL_CARD.md#ethical-considerations). 
+- Retains biases present in the Stack Exchange dataset. Per the [latest developer survey for Stack Overflow](https://survey.stackoverflow.co/2022/),
 which constitutes a significant part of the StackExchange data,
 most users who answered the survey identified themselves as [White or European, men, between 25 and 34 years old, and based in the US (with a significant part of responders from India).](https://survey.stackoverflow.co/2022/#developer-profile-demographics)
-While this demographic information likely varies by topic, disparities between the data contributors and the direct and indirect users of the technology should inform developers in assessing what constitutes an appropriate use case.
+- May generate answers that are incorrect or misleading.
+- May copy answers from the training data verbatim.
+
 
-Additionally, the model may generate answers that are incorrect or misleading due to the inherent limitations of the Llama architecture.
+### Recommendations
+- Answers should be validated through the use of external sources.
+- Disparities between the data contributors and the direct and indirect users of the technology should inform developers in assessing what constitutes an appropriate use case.
+- Further research is needed to attribute model generations to sources in the training data, especially in cases where the model copies answers from the training data.  
 
-## BibTeX entry and citation info
+## Training Details
 
-```bibtex
+### Training Data
+Original datasets are described in [the LLaMA Model Card](https://github.com/facebookresearch/llama/blob/main/MODEL_CARD.md#training-dataset).
+Fine-tuning datasets for this model are based on [Stack Exchange Paired](https://huggingface.co/datasets/lvwerra/stack-exchange-paired), which consists of questions and answers from various domains in Stack Exchange, such as programming, mathematics, physics, and more. Specifically:
+
+**Traditional Fine-tuning:** [https://huggingface.co/datasets/lvwerra/stack-exchange-paired/tree/main/data/finetune](https://huggingface.co/datasets/lvwerra/stack-exchange-paired/tree/main/data/finetune)
+
+**RL Fine-tuning:** [https://huggingface.co/datasets/lvwerra/stack-exchange-paired/tree/main/data/rl](https://huggingface.co/datasets/lvwerra/stack-exchange-paired/tree/main/data/rl)
+
+**Reward Model:** [https://huggingface.co/trl-lib/llama-7b-se-rm-peft](https://huggingface.co/trl-lib/llama-7b-se-rm-peft)
+
+### Training Procedure
+The model was first fine-tuned on the Stack Exchange question and answer pairs and then RL fine-tuned using a Stack Exchange Reward Model. 
+It is trained to respond to prompts with the following template:
+
+```
+Question: <Query> 
+
+Answer: <Response>
+```
+
+
+## Citation
+
+**BibTeX:**
+```
 @misc {beeching2023stackllama,
 	author       = { Edward Beeching and
                      Younes Belkada and
@@ -63,4 +108,7 @@ Additionally, the model may generate answers that are incorrect or misleading du
 	doi          = { 10.57967/hf/0513 },
 	publisher    = { Hugging Face Blog }
 }
-```
+```
+
+## Model Card Authors
+[Nathan Lambert](https://huggingface.co/natolambert), [Leandro von Werra](https://huggingface.co/lvwerra), [Edward Beeching](https://huggingface.co/edbeeching), [Kashif Rasul](https://huggingface.co/kashif), [Younes Belkada](https://huggingface.co/ybelkada), [Margaret Mitchell](https://huggingface.co/meg)