Update README.md

README.md

@@ -1,93 +1,110 @@
 ---
+license: apache-2.0
 library_name: transformers
 tags:
-- SkillTree
+- SkillEnhanced
 - mistral
-license: apache-2.0
 ---
 
-# SkillTree Model Collection
-
-Applying a skill to your model with SkillTree is akin to unlocking a new ability in a video game's skill tree. Just as you would enhance your character's capabilities by selecting and activating specific skills, you can augment your model's abilities by integrating specialized skills. Follow these steps to imbue your model with new prowess, enhancing its performance and versatility in a straightforward and intuitive manner.  
-**Please note that SkillTree abilities may not function in all cases. To determine whether a specific skill is operational, refer to the Functionality Status.**
+# Model Card for SkillTree Enhanced Model
 
-## What is SkillTree?
+<!-- Provide a quick summary of what the model is/does. -->
 
-SkillTree represents a set of model weights derived from further pre-training or fine-tuning Large Language Models (LLMs) to extract specific capabilities, such as code generation or chatting abilities. These extracted "skills" can be combined with a specific LLM base model to enhance its capabilities. The concept is inspired by [ChatVector](https://arxiv.org/abs/2310.04799), aiming to modularize and transfer distinct skills across models.
+## Model Details
 
-## SkillTree Details
+This model has been enhanced using the SkillTree approach, which applies specific skills extracted from advanced training or fine-tuning processes to improve the model's capabilities in targeted areas.
 
+- **Base Model:** [tokyotech-llm/Swallow-MS-7b-v0.1](https://huggingface.co/tokyotech-llm/Swallow-MS-7b-v0.1)
+- **Skill Tree:** [HachiML/SkillTree-Chat-Wizard-Mistral-7B-v0.1](https://huggingface.co/HachiML/SkillTree-Chat-Wizard-Mistral-7B-v0.1)
+- **Language(s) (NLP):** Japanese
 - **Functionality Status:** **Functional** / Non-Functional / Not Verified
-- **Base Model:** [mistralai/Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1)
-- **Skill Model:** [ibm/merlinite-7b](https://huggingface.co/ibm/merlinite-7b)
-- **Enhanced Model(optional):** [HachiML/Swallow-MS-7b-v0.1-ChatSkill-LAB](https://huggingface.co/HachiML/Swallow-MS-7b-v0.1-ChatSkill-LAB)
-- **Skill type:** Chat
-
-## Uses
 
-### Limitation
+## Benchmark Score
 
-- **Model Architecture:** Mistral
-- **Model Size:** 7.24B
-- **Compatible Models[optional]:** 
+## Uses
 
-### How to Apply Skill (Example)
+This section should describe the intended use cases for the enhanced model. It might include scenarios such as code generation, conversational AI, text summarization, or any other specific tasks the model has been enhanced to perform better. Be sure to include any recommendations or limitations on the model's use.
 
-```python
+```Python
 # Import library
-from transformers import AutoTokenizer, AutoModelForCausalLM
 import torch
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+# Load model
+model_name = "HachiML/Swallow-MS-7b-v0.1-ChatSkill-LAB"
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = AutoModelForCausalLM.from_pretrained(model_name, torch_dtype=torch.bfloat16, device_map="auto")
+
+# Inference 1 (Instruction)
+prompt = "<s>USER: お気に入りの調味料は？ \nASSISTANT: "
+input_ids = tokenizer.encode(prompt, add_special_tokens=False, return_tensors="pt")
+tokens = model.generate(input_ids.to(device=model.device), max_new_tokens=128, temperature=0.99, top_p=0.95, do_sample=True)
+out = tokenizer.decode(tokens[0], skip_special_tokens=True)
+print(out)
+
+# Inference 2 (Chat)
+messages = [
+    {"role": "system", "content": "好奇心旺盛なユーザーとAIアシスタントとのチャットです。アシスタントはユーザーの質問に親切で詳しく丁寧に答えます。USER: Hi ASSISTANT: Hello.</s>"},
+    {"role": "user", "content": "お気に入りの調味料は？"},
+    {"role": "assistant", "content": "私は新鮮なレモン汁を絞るのが大好きなんだ。キッチンで何を料理するにしても、ちょうどいい量のピリッとした風味を加えてくれる！"},
+    {"role": "user", "content": "マヨネーズのレシピはありますか？"}
+]
+encodeds = tokenizer.apply_chat_template(messages, return_tensors="pt")
+model_inputs = encodeds.to(device=model.device)
+generated_ids = model.generate(model_inputs, max_new_tokens=512, do_sample=True)
+out = tokenizer.batch_decode(generated_ids)
+print(out[0])
+```
+
+## Response Examples
+
+Below are examples of responses from the model, demonstrating how the SkillTree enhancement has improved its performance.
+
+### Example 1:
+
+- **Input:**
+```
+USER: お気に入りの調味料は？ 
+ASSISTANT:
+```
+- **Output:**
+```
+調味料には、それぞれの味や風味、使い道のバリエーションを広げる魔法のような力があり、お気に入りの一本を持っている方も多いのではないでしょうか。私がお気に入りの調味料は、「ゲランドの塩」です。
+ゲランドの塩は、フラ���ス南西部のゲランド地方で生産される塩のことで、約2000年前から製造されているという伝統的な海塩です。塩田で太陽光線を利用し、濃縮・結晶させて
+```
+
+### Example 2:
+
+- **Input:**
+```
+<s> 好奇心旺盛なユーザーとAIアシスタントとのチャットです。アシスタントはユーザーの質問に親切で詳しく丁寧に答えます。USER: Hi ASSISTANT: Hello.</s> 
+USER: お気に入りの調味料は？
+ASSISTANT: 私は新鮮なレモン汁を絞るのが大好きなんだ。キッチンで何を料理するにしても、ちょうどいい量のピリッとした風味を加えてくれる！</s> 
+USER: マヨネーズのレシピはありますか？
+```
+- **Output:**
+```
+MAYONNE: マヨネは中東や北アフリカの伝統的なディップで、玉ねぎやニンニク、トマト、コリアンダーやチリペートなどの香味料と、唐辛子フレーク(ハラーパッサント・ペパクト)を油に漬け込んだものです。ホットソースとして知られるこの調味料は、タヒンやフムス、肉料理やサラダの味付けに使用されます。こちらに基本レシピがあるので、ご自宅で手作りのマヨネネをお楽しみ下さい。
+【マヨネネ(Mayonnaise)の基本成分】
+* 中型の玉ねぎ:1個(みじ�ミントーン=約1.2キロ)
+* ニンニク:4片
+* 完熟トマト:おおさじ2杯
+* コリアンダー:大さじ2と1/2(約30グラム)
+*  同量の水(トマトの水気と混ぜる用)
+* フレッシュコリアンダー(みじん切り):約15g
+*  ハラーペクト(赤唐辛フレーク):小さじ1弱(お好みで調節)
+*  クミン:小さじ1/2
+*  クローブグラウラス(月桃の実):5個
+*  シナモ(カシアの実):2本
+*  オールスパイス:小さじ1/2
+*  白ワインビネガー:100ミリリットル
+*  オリーブオイル:500ミリリットル
+*  塩:小さじ2(お好みで調節)
+*  黒胡椒(ホールブラックペッパー):10粒ほど
+*  ローレル(乾燥):小さじ1/2(おさえめ)
+【Mayonnaiseの作り方】
+1. 玉ねぎ、ニンニクはみじん切りにし、トマトはみじん切りまたはフードプロセッサーですりおろし、コリアンダーもみじん切りにしておきます。
+2. 大きめの鍋にオイル(分量らず)をしいてし、クミン、クローブ、シナモ、オールスパイスを入れて中火で熱し、スパイスの香りをオイルに移します。
+3. 香りが立ってきたら、みじん切りした玉ねぎとニンニクを入れて透きるまで炒め、塩ひとつまみを加えます
+```
 
-# Load the target model to be applied skill
-base_model_name = "tokyotech-llm/Swallow-MS-7b-v0.1"  # Japanese Base Model
-tokenizer = AutoTokenizer.from_pretrained(base_model_name)
-model = AutoModelForCausalLM.from_pretrained(
-    base_model_name,
-    torch_dtype=torch.bfloat16,
-    device_map="auto",
-)
-
-# Load SkillTree
-skill_tree = AutoModelForCausalLM.from_pretrained(
-    "HachiML/SkillTree-Chat-Wizard-Mistral-7B-v0.1",
-    torch_dtype=torch.bfloat16,
-    device_map="auto",
-)
-
-# Apply the skill to the target model
-def apply_skill(model, skill_tree):
-    # excluded object
-    skip_layers = ["model.embed_tokens.weight", "model.norm.weight", "lm_head.weight"]
-    # apply skill
-    for k, v in model.state_dict().items():
-        # layernorm is also excluded
-        if (k in skip_layers) or ("layernorm" in k):
-            continue
-        vector = skill_tree.state_dict()[k]
-        new_v = v + vector.to(v.device)
-        v.copy_(new_v)
-    return model
-
-model = apply_skill(model, skill_tree)
-
-# Add Special Token
-tokenizer.pad_token = "<unk>"
-
-# Add Chat Template
-tokenizer.chat_template = """
-{% for message in messages %}
-{% if message['role'] == 'system' %}
-{{ bos_token + message['content'].strip() }}
-{% elif message['role'] == 'user' %}
-{{ 'USER: ' + message['content'].strip() }}
-{% elif message['role'] == 'assistant' %}
-{{ 'ASSISTANT: ' + message['content'] + eos_token }}
-{% endif %}
-{% endfor %}
-"""
-
-# Push to hub
-model_name = "HachiML/Swallow-MS-7b-v0.1-ChatSkill-Wizard"
-tokenizer.save_pretrained(f"./models/{model_name}", repo_id=model_name, push_to_hub=True)
-model.save_pretrained(f"./models/{model_name}", repo_id=model_name, push_to_hub=True)
-```