Update README.md

README.md

@@ -1,47 +1,78 @@
 ---
-license: Apache License 2.0
-
-#model-type:
-##如 gpt、phi、llama、chatglm、baichuan 等
-#- gpt
-
-#domain:
-##如 nlp、cv、audio、multi-modal
-#- nlp
-
-#language:
-##语言代码列表 https://help.aliyun.com/document_detail/215387.html?spm=a2c4g.11186623.0.0.9f8d7467kni6Aa
-#- cn 
-
-#metrics:
-##如 CIDEr、Blue、ROUGE 等
-#- CIDEr
-
-#tags:
-##各种自定义，包括 pretrained、fine-tuned、instruction-tuned、RL-tuned 等训练方法和其他
-#- pretrained
-
-#tools:
-##如 vllm、fastchat、llamacpp、AdaSeq 等
-#- vllm
+language:
+- ru
+datasets:
+- IlyaGusev/ru_turbo_saiga
+- IlyaGusev/ru_sharegpt_cleaned
+- IlyaGusev/oasst1_ru_main_branch
+- IlyaGusev/gpt_roleplay_realm
+- lksy/ru_instruct_gpt4
+license: other
+license_name: llama3
+license_link: https://llama.meta.com/llama3/license/
+base_model: IlyaGusev/saiga_llama3_8b
+pipeline_tag: text-generation
+tags:
+- llama
+- conversational
 ---
-### 当前模型的贡献者未提供更加详细的模型介绍。模型文件和权重，可浏览“模型文件”页面获取。
-#### 您可以通过如下git clone命令，或者ModelScope SDK来下载模型
 
-SDK下载
-```bash
-#安装ModelScope
-pip install modelscope
+# Saiga-Llama3 8B-GGUF
+
+- This is quantized version of [IlyaGusev/saiga_llama3_8b](https://huggingface.co/IlyaGusev/saiga_llama3_8b) created using llama.cpp
+
+# Model Description
+
+Based on [Llama-3 8B Instruct](https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct).
+
+
+ChatML prompt format:
 ```
-```python
-#SDK模型下载
-from modelscope import snapshot_download
-model_dir = snapshot_download('QuantFactory/saiga_llama3_8b-GGUF')
-```
-Git下载
-```
-#Git模型下载
-git clone https://www.modelscope.cn/QuantFactory/saiga_llama3_8b-GGUF.git
+<|im_start|>system
+Ты — Сайга, русскоязычный автоматический ассистент. Ты разговариваешь с людьми и помогаешь им.<|im_end|>
+<|im_start|>user
+Как дела?<|im_end|>
+<|im_start|>assistant
+Отлично, а у тебя?<|im_end|>
+<|im_start|>user
+Шикарно. Как пройти в библиотеку?<|im_end|>
+<|im_start|>assistant
 ```
 
-<p style="color: lightgrey;">如果您是本模型的贡献者，我们邀请您根据<a href="https://modelscope.cn/docs/ModelScope%E6%A8%A1%E5%9E%8B%E6%8E%A5%E5%85%A5%E6%B5%81%E7%A8%8B%E6%A6%82%E8%A7%88" style="color: lightgrey; text-decoration: underline;">模型贡献文档</a>，及时完善模型卡片内容。</p>
+Examples:
+```
+User: Почему трава зеленая? 
+Saiga: Зеленый цвет травы обусловлен наличием хлорофилла, пигмента, который поглощает свет и передает энергию для фотосинтеза. Хлорофилл содержится в клетках листьев растений и играет ключевую роль в процессе фотосинтеза, когда растения используют солнечный свет для превращения воды и углекислого газа в органические вещества, такие как глюкоза и олигоэфиры.
+Хлорофилл состоит из двух основных форм: хлорофилла а и хлорофилла б. Хлорофилл а поглощает свет с длиной волны около 430 нанометров (нм), что соответствует синему или голубому свету, а хлорофилл б поглощает свет с длиной волны около 660 нм, что соответствует красному свету. Когда свет поглощается хлорофиллом, он передается в молекулы воды и углекислого газа, которые используются для фотосинтеза.
+Таким образом, хлорофилл является основным компонентом, ответственным за зеленый цвет листьев растений, так как он поглощает свет и передает его энергию для фотосинтеза.
+```
+
+```
+User: Сочини длинный рассказ, обязательно упоминая следующие объекты. Дано: Таня, мяч
+Saiga: Однажды в солнечную погоду на поле для игры в футбол приехала группа друзей, чтобы провести время вместе. В числе их был и Таня, которая была страстной футбольной фанаткой и всегда радовал своих друзей своим энтузиазмом и умением забивать мячи.
+В этот день, как обычно, друзья решили провести соревнование между собой, чтобы определить кто из них является лучшим футболистом. Таня была очень уверена в своих силах и готовилась к этому матчу с особой серьёзностью.
+Когда все друзья собрались на поле, они увидели, что перед ними стоял огромный мяч, который должен был стать предметом состязания. Мяч был огромным и тяжелым, и его размеры были необычайно большими по сравнению с обычными мячами, которые используются в футболе.
+Таня была первая, кто решил начать игру. Она подошла к мячу и начала его удерживать, стараясь выдержать его вес и силу. Но мяч оказался настолько тяжелым, что Таня не смогла удержать его и он упал на землю.
+Друзья посмеялись над ее неудачей, но Таня не отчаивалась и продолжила пытаться удержать мяч. Она стала использовать все свои силы и умения, чтобы выдержать его вес и силу. Наконец, после долгих усилий, она смогла удержать мяч и начала его бросать в сторону.
+Мяч летел высоко вверх, и друзья смотрели, как он пролетает над полем. Но мяч неожиданно повернул и стал лететь обратно к Тане. Она успела поймать его и продолжила играть, используя все свои навыки и умения.
+```
+
+v2:
+- dataset code revision d0d123dd221e10bb2a3383bcb1c6e4efe1b4a28a
+- wandb [link](https://wandb.ai/ilyagusev/huggingface/runs/r6u5juyk)
+- 5 datasets: ru_turbo_saiga, ru_sharegpt_cleaned, oasst1_ru_main_branch, gpt_roleplay_realm, ru_instruct_gpt4
+- Datasets merging script: [create_short_chat_set.py](https://github.com/IlyaGusev/rulm/blob/d0d123dd221e10bb2a3383bcb1c6e4efe1b4a28a/self_instruct/src/data_processing/create_short_chat_set.py)
+
+
+# Evaluation
+
+* Dataset: https://github.com/IlyaGusev/rulm/blob/master/self_instruct/data/tasks.jsonl
+* Framework: https://github.com/tatsu-lab/alpaca_eval
+* Evaluator: alpaca_eval_cot_gpt4_turbo_fn
+
+| model | length_controlled_winrate |  win_rate | standard_error  | avg_length |
+|-----|-----|-----|-----|-----|
+|chatgpt_4_turbo | 76.04 | 90.00 |1.46 | 1270 |
+|chatgpt_3_5_turbo | 50.00 | 50.00 | 0.00  | 536 |
+|saiga_llama3_8b  | 33.07  | 48.19 | 2.45 | 1166 |
+saiga_mistral_7b  | 23.38  | 35.99 | 2.34 | 949  |