Update README.md

README.md

@@ -1,84 +1,101 @@
 ---
 tags:
-- text-generation
+    - text-generation
 license: cc-by-nc-sa-4.0
 language:
-- ko
+    - ko
 base_model: mistralai/Mistral-7B-Instruct-v0.2
 pipeline_tag: text-generation
+datasets:
+    - beomi/KoAlpaca-v1.1a
 ---
 
 # **DataVortexM-7B-Instruct-v0.1**
-<img src="https://imgur.com/lpXTyPe.png" alt="DataVortex" style="height: 8em;">
 
-## **License**
-
-[cc-by-nc-sa-4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)
+<img src="./DataVortex.png" alt="DataVortex" style="height: 8em;">
 
 ## **Model Details**
 
 ### **Base Model**
-[mistralai/Mistral-7B-Instruct-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2)  
+
+[mistralai/Mistral-7B-Instruct-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2)
 
 ### **Trained On**
-H100 80GB 4ea
+
+-   **OS**: Ubuntu 20.04
+-   **GPU**: H100 80GB x4
+-   **transformers**: v4.36.2
+
+### **Dataset**
+
+-   [beomi/KoAlpaca-v1.1a](https://huggingface.co/datasets/beomi/KoAlpaca-v1.1a) - 21k rows
 
 ### **Instruction format**
 
 It follows **Alpaca** format.
 
+E.g.
+
+```python
+text = """\
+### System:
+당신은 사람들이 정보를 찾을 수 있도록 도와주는 인공지능 비서입니다.
+
+### User:
+대한민국의 수도는 어디야?
+
+### Assistant:
+대한민국의 수도는 서울입니다.
+
+### User:
+서울 인구는 총 몇 명이야?
+"""
+```
+
 ## **Model Benchmark**
 
 ### **Ko-LLM-Leaderboard**
 
--   **Average**: 39.81
--   **Ko-ARC**: 34.13
--   **Ko-HellaSwag**: 42.35
--   **Ko-MMLU**: 38.73
--   **Ko-TruthfulQA**: 45.46
--   **Ko-CommonGen V2**: 38.37
+| Model                            | Average   | Ko-ARC    | Ko-HellaSwag | Ko-MMLU   | Ko-TruthfulQA | Ko-CommonGen V2 |
+| -------------------------------- | --------- | --------- | ------------ | --------- | ------------- | --------------- |
+| **DataVortexM-7B-Instruct-v0.1** | **39.81** | **34.13** | **42.35**    | **38.73** | **45.46**     | **38.37**       |
 
-# **Implementation Code**
+## **Implementation Code**
 
-Since, chat_template already contains insturction format above.
+This model contains the chat_template instruction format.  
 You can use the code below.
 
 ```python
 from transformers import AutoModelForCausalLM, AutoTokenizer
 
-device = "cuda"
+device = "cuda" # the device to load the model onto
 
-model = AutoModelForCausalLM.from_pretrained("Edentns/DataVortexM-7B-Instruct-v0.1", device_map=device)
-tokenizer = AutoTokenizer.from_pretrained("Edentns/DataVortexM-7B-Instruct-v0.1")
+model = AutoModelForCausalLM.from_pretrained("DataVortexM-7B-Instruct-v0.1")
+tokenizer = AutoTokenizer.from_pretrained("DataVortexM-7B-Instruct-v0.1")
 
 messages = [
-    { "role": "user", "content": "대한민국의 수도는 어디야?" }
+    {"role": "system", "content": "당신은 사람들이 정보를 찾을 수 있도록 도와주는 인공지능 비서입니다."},
+    {"role": "user", "content": "대한민국의 수도는 어디야?"},
+    {"role": "assistant", "content": "대한민국의 수도는 서울입니다."},
+    {"role": "user", "content": "서울 인구는 총 몇 명이야?"}
 ]
 
-encoded = tokenizer.apply_chat_template(
-    messages,
-    add_generation_prompt=True,
-    return_tensors="pt",
-    return_token_type_ids=False
-).to(device)
-
-decoded = model.generate(
-    input_ids=encoded,
-    temperature=0.2,
-    top_p=0.9,
-    repetition_penalty=1.2,
-    do_sample=True,
-    max_length=4096,
-    eos_token_id=tokenizer.eos_token_id,
-    pad_token_id=tokenizer.eos_token_id
-)
-decoded = decoded[0][encoded.shape[1]:decoded[0].shape[-1]]
-decoded_text = tokenizer.decode(decoded, skip_special_tokens=True)
-print(decoded_text)
+encodeds = tokenizer.apply_chat_template(messages, return_tensors="pt")
+
+model_inputs = encodeds.to(device)
+model.to(device)
+
+generated_ids = model.generate(model_inputs, max_new_tokens=1000, do_sample=True)
+decoded = tokenizer.batch_decode(generated_ids)
+print(decoded[0])
 ```
 
+## **License**
+
+The model is licensed under the [cc-by-nc-sa-4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) license, which allows others to copy, modify, and share the work non-commercially, as long as they give appropriate credit and distribute any derivative works under the same license.
+
 <div align="center">
     <a href="https://edentns.com/">
-        <img src="https://imgur.com/MVVlYqG.png" alt="Logo" style="height: 3em;">
+        <img src="./Logo.png" alt="Logo" style="height: 3em;">
     </a>
 </div>