Update README.md

README.md

@@ -14,21 +14,21 @@ base_model:
 
 ### Описание
 
-**Vikhr-Nemo** - это наша фалгманская умнимодальная LLM (Large Language Model) представляющая из себя улучшенную версию [mistralai/Mistral-Nemo-Instruct-2407](https://huggingface.co/mistralai/Mistral-Nemo-Instruct-2407) командой **VikhrModels**, адаптированную преимущественно для русского и английского языков. Для ее обучения мы использовали несколько этапов включаюзих в себя **SFT** и **SMPO** - нашу собственную вариацию DPO, подробнее читайте в секции *"Как эта модель создавалась"*.
+**Vikhr-Nemo** - это наша флагманская унимодальная LLM (Large Language Model) представляющая из себя улучшенную версию [mistralai/Mistral-Nemo-Instruct-2407](https://huggingface.co/mistralai/Mistral-Nemo-Instruct-2407) командой **VikhrModels**, адаптированную преимущественно для русского и английского языков. Для ее обучения мы использовали несколько этапов включаюзих в себя **SFT** и **SMPO** - нашу собственную вариацию DPO, подробнее читайте в секции *"Как эта модель создавалась"*.
 
-Модель оптимизированна для различных вариантов использования, включая рассуждения, обобщение и ответы на вопросы. Vikhr-Nemo обладает возможностью многоязычной генерации, и высокопроизводительными возможностями RAG. Модель иммет лучшие оценки среди прочих на наших инструктивных и RAG бенчарках и, поэтому, мы верим, что в некоторыых случаях может использоваться как локальная замена для gpt-4o-mini от OpenAI.
+Модель оптимизированна для различных вариантов использования, включая ризонинг, суммаризацию, код, roleplay, поддержание диалога. Vikhr-Nemo обладает возможностью многоязычной генерации, и высокопроизводительными возможностями RAG. Модель иммет лучшие оценки среди прочих на наших инструктивных и RAG бенчарках и, поэтому, мы верим, что в некоторыых случаях может использоваться как локальная замена для gpt-4o-mini от OpenAI.
 
-Весь использованный код для обучения выложен в нашем репозитории [effective_llm_alignment](https://github.com/VikhrModels/leffective_llm_alignment/) на GitHub, а основаные датасеты дсотупны в нашем [профиле на HF](https://huggingface.co/Vikhrmodels).
+Весь использованный код для обучения выложен в нашем репозитории [effective_llm_alignment](https://github.com/VikhrModels/effective_llm_alignment/) на GitHub, а основаные датасеты дсотупны в нашем [профиле на HF](https://huggingface.co/Vikhrmodels).
 
 ### Особенности
-1. Высокое качество генераций на русском и английском языках, а также некоторых других языках, благодаря датасету Grandmaster-PRO-MAX и исходной модели.
+1. Высокое качество генераций на русском и английском языках, а также некоторых других языках, благодаря датасету [Grandmaster-PRO-MAX](https://huggingface.co/datasets/Vikhrmodels/GrandMaster-PRO-MAX) и исходной модели.
 2. Поддержка системных промптов для регулриования стиля ответов
 3. Поддержка до 128k токенов контекста благодаря исходной модели
 4. Grounded RAG режим - модель имеет специальную роль documents и специальный режим работы для поиска идентификаторов релевантных вопросу пользователя документов и использования их для ответа на вопрос, вдохновлено аналогичной способность модели Command-R
 
 ### Метрики и оценка качества
 
-Модель оценивалась на нашем русскоязычном опен-сорс SBS бенчмарке [ru-arena-general](https://github.com/VikhrModels/ru_llm_arena) (50 вопросов по 10 топикам), где судьей выступает gpt-4-1106-preview и [бенчмарке]() для RAG на основе тестового сета [Grounded-RAG-v2](https://huggingface.co/datasets/Vikhrmodels/Grounded-RAG-RU-v2), где судей выступа gpt-4o.
+Модель оценивалась на нашем русскоязычном опен-сорс SBS бенчмарке [ru-arena-general](https://github.com/VikhrModels/ru_llm_arena) (50 вопросов по 10 топикам), где судьей выступает gpt-4-1106-preview и [бенчмарке](https://colab.research.google.com/drive/16730rWQ4-yGqWoooLs0Ece_16frmOniP?usp=sharing) для RAG на основе тестового сета [Grounded-RAG-v2](https://huggingface.co/datasets/Vikhrmodels/Grounded-RAG-RU-v2), где судей выступа gpt-4o.
 
 #### Результаты на Ru-Arena-General
 
@@ -49,17 +49,149 @@ base_model:
 | mistral-nemo-instruct-2407                       | 50.5   | (-2.7, 2.6)        | 403              |
 | gpt-3.5-turbo-0125                               | 50.0   | (0.0, 0.0)         | 220              |
 | c4ai-command-r-v01                               | 49.0   | (-1.7, 2.2)        | 529              |
+| meta-llama-3.1-8b-instruct                       | 43.1   | (-2.8, 2.3)        | 628              |
 
 #### Результаты на бенчмарке RAG
 
-Тут в для оценки качества модель-судья была проинструктирована учитывать релеватность и фактологичкскую полноту ответов исходя из документов и реферсного ответа от gpt-4-1106-preview.
-
-...
+Тут для оценки качества модель-судья gpt-4o была проинструктирована учитывать релеватность и фактологичкскую полноту ответов исходя из документов и реферсного ответа от gpt-4-1106-preview.
+
+Подробности промптов и оценок смотрите в коде бенчмарка доступно на [коллабе](https://colab.research.google.com/drive/16730rWQ4-yGqWoooLs0Ece_16frmOniP?usp=sharing)
+
+<table>
+<thead>
+  <tr>
+    <th rowspan="2">question_type</th>
+    <th colspan="3">gpt-4o</th>
+  </tr>
+  <tr>
+    <th>judge_correct_percent</th>
+    <th>avg_answer_match_rougeL</th>
+    <th>avg_abs_indexes_diff</th>
+  </tr>
+</thead>
+<tbody>
+  <tr>
+    <td>in_domain</td>
+    <td>73%</td>
+    <td>0.34</td>
+    <td>NaN</td>
+  </tr>
+  <tr>
+    <td>out_of_domain</td>
+    <td>81%</td>
+    <td>0.20</td>
+    <td>NaN</td>
+  </tr>
+</tbody>
+</table>
+
+<table>
+<thead>
+  <tr>
+    <th style="visibility: hidden;" rowspan="2">question_type</th>
+    <th colspan="3">Vikhr-Nemo-12B-Instruct-R-21-09-24</th>
+  </tr>
+  <tr>
+    <th style="visibility: hidden;">judge_correct_percent</th>
+    <th style="visibility: hidden;">avg_answer_match_rougeL</th>
+    <th style="visibility: hidden;">avg_abs_indexes_diff</th>
+  </tr>
+</thead>
+<tbody>
+  <tr>
+    <td>in_domain</td>
+    <td>68%</td>
+    <td>0.41</td>
+    <td>0</td>
+  </tr>
+  <tr>
+    <td>out_of_domain</td>
+    <td>92%</td>
+    <td>0.52</td>
+    <td>0</td>
+  </tr>
+</tbody>
+</table>
+
+<table>
+<thead>
+  <tr>
+    <th style="visibility: hidden;" rowspan="2">question_type</th>
+    <th colspan="3">gpt-4-mini</th>
+  </tr>
+  <tr>
+    <th style="visibility: hidden;">judge_correct_percent</th>
+    <th style="visibility: hidden;">avg_answer_match_rougeL</th>
+    <th style="visibility: hidden;">avg_abs_indexes_diff</th>
+  </tr>
+</thead>
+<tbody>
+  <tr>
+    <td>in_domain</td>
+    <td>65%</td>
+    <td>0.33</td>
+    <td>NaN</td>
+  </tr>
+  <tr>
+    <td>out_of_domain</td>
+    <td>73%</td>
+    <td>0.18</td>
+    <td>NaN</td>
+  </tr>
+</tbody>
+</table>
+
+<table>
+<thead>
+  <tr>
+    <th style="visibility: hidden;" rowspan="2">question_type</th>
+    <th colspan="3">gpt-3.5-turbo-0125 </th>
+  </tr>
+  <tr>
+    <th style="visibility: hidden;">judge_correct_percent</th>
+    <th style="visibility: hidden;">avg_answer_match_rougeL</th>
+    <th style="visibility: hidden;">avg_abs_indexes_diff</th>
+  </tr>
+</thead>
+<tbody>
+  <tr>
+    <td>in_domain</td>
+    <td>49%</td>
+    <td>0.28</td>
+    <td>NaN</td>
+  </tr>
+  <tr>
+    <td>out_of_domain</td>
+    <td>76%</td>
+    <td>0.20</td>
+    <td>NaN</td>
+  </tr>
+</tbody>
+</table>
 
 ### Как эта модель создавалась
 
+#### Инструктивная SFT часть
+
+Для SFT этапа обучения модели мы подготовили наш большой (150к инструкций) инструктивный синтетический датасет [Vikhrmodels/GrandMaster-PRO-MAX](https://huggingface.co/datasets/Vikhrmodels/GrandMaster-PRO-MAX). Его особенностью является встроеный CoT (Chain-Of-Thought), для сбора которого мы использовали модифицированный промет для gpt-4-turbo, подробности в карточке датасета.
+
+Кроме того для того чтобы сделать RAG Grounding мы подготовили другой синтетический датасет - [Vikhrmodels/Grounded-RAG-RU-v2](https://huggingface.co/datasets/Vikhrmodels/Grounded-RAG-RU-v2), его пайплайн сборки достаточно сложный для короткого описания и полробнее об этом вы можете прочитать в его карточке.
+
+#### Этап алайнмента с SMPO
+
+Для дальнейшего улучшения качества ответов мы использовали следущий пайплайн:
+1) Обучили кастомную Reward модель (она пока не будет выкладываться в открытый доступ)
+2) Дедуплицировали и отфилтровали используя RM модель оригинальный датасет Vikhrmodels/GrandMaster-PRO-MAX, получив порядка 10к самых высококачественных и разнообразных диалогов.
+3) Сделали Rejection Samping с SFT чекпоинтом используя полученный датасет и Reward модель. (Генерировали 7 гипотез и брали только 2 самые худшие как rejected)
+4) Дообучили SFT чекпоинт с помощью нашего метода SMPO используя полученный датасет из этапа 3. SMPO был спроектирован и выбран как метод для повышения стабильности тренировки преференсов в условиях Rejection Samping и достижения нужного margin.
+
+Реализацию SMPO, rejection sampling и тд можно найти в нашей библиотеке [effective_llm_alignment](https://github.com/VikhrModels/effective_llm_alignment/) на GitHub
+
 ### Как работать с RAG
 
 ### Нюансы и ограничения
+- Модель имеет низкий уровень безопасности ответов и нацелена на правильное и полное выполенние инстуркций, имейте это ввиду при использовании
+- Системные промпты не предназначены для описание персонажей, используйте их только для спецификации стиля ответа (вроде "answer only in json format"). Кроме того они должны быть на английском, так как так было в датасете, здесь от английского не зависит язык ответа.
+- RAG режим требует обязательного наличия системного промпта описаного в секции *Как работать с RAG*
 
 ### Авторы