Update README.md

README.md

@@ -1,5 +1,78 @@
-元モデル：neoAI-pj-absol/llmjpv2.0-full-checkpoint2000
+# **Model Description**
 
-data:hh-rlhf(kunishou)
+**Llama 3 neoAI 8B Chat v0.1**は，[Meta-Llama-3-8B-Instruct](https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct)をベースとして日本語能力を強化するために事後学習を行なったモデルです．
 
-parameter:lr5e-7,beta0.1,epoch20
+詳細はブログ記事を参照してください．
+
+# Usage
+
+## Huggingface
+
+```python
+import transformers
+import torch
+
+model_id = "neoai-inc/Llama-3-neoAI-8B-Chat-v0.1"
+
+pipeline = transformers.pipeline(
+    "text-generation",
+    model=model_id,
+    model_kwargs={"torch_dtype": torch.bfloat16},
+    device_map="auto",
+)
+
+messages = [
+    {"role": "system", "content": "あなたは誠実で優秀な日本人のアシスタントです。"},
+    {"role": "user", "content": "日本で一番高い山は？"},
+]
+
+terminators = [
+    pipeline.tokenizer.eos_token_id,
+    pipeline.tokenizer.convert_tokens_to_ids("<|eot_id|>")
+]
+
+outputs = pipeline(
+    messages,
+    max_new_tokens=256,
+    eos_token_id=terminators,
+    do_sample=True,
+    temperature=0.6,
+    top_p=0.9,
+)
+print(outputs[0]["generated_text"][-1])
+
+```
+
+# Evaluation
+
+- [suzume](https://huggingface.co/Rakuten/RakutenAI-7B-instruct): Mt-bechのスコア図とか載せてる
+- [rakuten](https://huggingface.co/Rakuten/RakutenAI-7B-instruct): スコアの表を載せている
+
+# License
+
+Llama 3 is licensed under the Meta LLAMA 3 Community License, Copyright (c) Meta Platforms, Inc. All Rights Reserved.
+
+# Developed by
+
+neoAIロゴ
+
+# Developers
+
+以下アルファベット順
+
+- Gouki Minegishi
+- Koki Itai
+- Koshiro Terasawa
+- Masaki Otsuki
+- Ryo Yagi
+
+# How to Cite
+
+```python
+@misc{neoAI-Llama3-8B-Chat-v0.1, 
+      title={Llama-3-neoAI-8B-Chat-v0.1}, 
+      url={https://huggingface.co/neoai-inc/Llama-3-neoAI-8B-Chat-v0.1}, 
+      author={Gouki Minegishi and Koki Itai and Koshiro Terasawa and Masaki Otsuki and Ryo Yagi},
+      year={2024},
+}
+```