Update README.md

README.md

@@ -1,3 +1,134 @@
 ---
 license: apache-2.0
+language:
+- en
+datasets:
+- snorkelai/snorkel-curated-instruction-tuning
+inference:
+  parameters:
+    temperature: 0.7
+    top_p: 0.7
+    top_k: 50
+    max_new_tokens: 512
+pipeline_tag: text-generation
 ---
+
+# RedPajama-7B-Chat-Curated
+
+The model is created by fine-tuning the RedPajama Base model on [snorkelai/snorkel-curated-instruction-tuning](https://huggingface.co/datasets/snorkelai/snorkel-curated-instruction-tuning) to enhance chatting ability further with high-quality instruction-response pairs.
+
+For a more comprehensive understanding of our methodology, please visit our blog - [How we built a better GenAI with programmatic data development](snorkel.ai/how-we-built-a-better-genai-with-programmatic-data-development).
+
+  - Chat-Curated Version: [snorkelai/RedPajama-7B-Chat-Curated](https://huggingface.co/snorkelai/RedPajama-7B-Chat-Curated)
+  - Instruction Tuning Dataset: [snorkelai/snorkel-curated-instruction-tuning](https://huggingface.co/datasets/snorkelai/snorkel-curated-instruction-tuning)
+  - Base Model: [RedPajama-INCITE-7B-Base](https://huggingface.co/togethercomputer/RedPajama-INCITE-7B-Base)
+
+## Model Details
+- **Developed by**: Snorkel AI.
+- **Model type**: Language Model
+- **Language(s)**: English
+- **License**: Apache 2.0
+- **Model Description**: A 6.9B parameter pretrained language model.
+
+# Quick Start
+
+Please note that the model requires `transformers` version >= 4.25.1.
+
+To prompt the chat model, use the following format:
+```
+<human>: [Chat]
+<bot>:
+```
+
+## GPU Inference
+
+This requires a GPU with 16GB memory.
+
+```python
+import torch
+import transformers
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+MIN_TRANSFORMERS_VERSION = '4.25.1'
+
+# check transformers version
+assert transformers.__version__ >= MIN_TRANSFORMERS_VERSION, f'Please upgrade transformers to version {MIN_TRANSFORMERS_VERSION} or higher.'
+
+# init
+tokenizer = AutoTokenizer.from_pretrained("snorkelai/RedPajama-7B-Chat-Curated")
+model = AutoModelForCausalLM.from_pretrained("snorkelai/RedPajama-7B-Chat-Curated", torch_dtype=torch.float16)
+model = model.to('cuda:0')
+# infer
+prompt = "<human>: Who is Alan Turing?\n<bot>:"
+inputs = tokenizer(prompt, return_tensors='pt').to(model.device)
+input_length = inputs.input_ids.shape[1]
+outputs = model.generate(
+    **inputs, max_new_tokens=128, do_sample=True, temperature=0.7, top_p=0.7, top_k=50, return_dict_in_generate=True
+)
+token = outputs.sequences[0, input_length:]
+output_str = tokenizer.decode(token)
+print(output_str)
+"""
+Alan Mathison Turing (23 June 1912  7 June 1954) was an English computer scientist, mathematician, logician, cryptanalyst, philosopher, mathematician, and theoretical biologist.
+"""
+```
+
+To do GPU Inference in Int8 or CPU inference, please refer to the `togethercomputer/RedPajama-INCITE-7B-Chat` documentation.
+
+# Uses
+
+## Direct Use 
+
+Excluded uses are described below.
+
+### Misuse, Malicious Use, and Out-of-Scope Use
+
+It is the responsibility of the end user to ensure that the model is used in a responsible and ethical manner.
+
+#### Out-of-Scope Use
+
+`RedPajama-7B-Chat-Curated` is a language model and may not perform well for other use cases outside of its intended scope. 
+For example, it may not be suitable for use in safety-critical applications or for making decisions that have a significant impact on individuals or society. 
+It is important to consider the limitations of the model and to only use it for its intended purpose.
+
+#### Misuse and Malicious Use
+
+`RedPajama-7B-Chat-Curated` is designed for language modeling.
+Misuse of the model, such as using it to engage in illegal or unethical activities, is strictly prohibited and goes against the principles of the project.
+
+Using the model to generate content that is cruel to individuals is a misuse of this model. This includes, but is not limited to:
+
+- Generating fake news, misinformation, or propaganda
+- Promoting hate speech, discrimination, or violence against individuals or groups
+- Impersonating individuals or organizations without their consent
+- Engaging in cyberbullying or harassment
+- Defamatory content
+- Spamming or scamming
+- Sharing confidential or sensitive information without proper authorization
+- Violating the terms of use of the model or the data used to train it
+- Creating automated bots for malicious purposes such as spreading malware, phishing scams, or spamming
+
+## Limitations
+
+`RedPajama-7B-Chat-Curated`, like other language models, has limitations that should be taken into consideration. 
+For example, the model may not always provide accurate or relevant answers, particularly for questions that are complex, ambiguous, or outside of its training data. 
+We therefore welcome contributions from individuals and organizations, and encourage collaboration towards creating a more robust and inclusive chatbot.
+
+## Training
+
+**Training Data**
+
+  Please refer to [snorkelai/snorkel-curated-instruction-tuning](https://huggingface.co/datasets/snorkelai/snorkel-curated-instruction-tuning)
+
+**Training Procedure**
+
+- **Hardware:** 8 A100
+- **Optimizer:** Adam
+- **Gradient Accumulations**: 1
+- **Num of Tokens:** 3.8M tokens
+- **Learning rate:** 1e-5
+- **Batch size:** 64
+
+## Community
+
+Join us on [Snorkel AI Slack](snorkel.ai/slack)