Tunes for wiki

.github/workflows/sync-docs-to-wiki.yml

@@ -28,6 +28,17 @@ jobs:
         run: |
           find . -type f -name '*.md' -exec \
             sed -i -E 's|\[([^]]*)\]\(([^)]*)\)|[\1](https://github.com/EvilFreelancer/impruver/blob/main/\2)|g' {} +
+      - name: Remove first h1 and shift headings
+        working-directory: wiki
+        run: |
+          # В одной find-команде используем несколько -e флагов для sed
+          find . -type f -name '*.md' -exec sed -i \
+            -e '1{/^# .*/d}' \
+            -e 's/^## /# /g' \
+            -e 's/^### /## /g' \
+            -e 's/^#### /### /g' \
+            -e 's/^##### /#### /g' \
+            -e 's/^###### /##### /g' {} +
       - name: Commit and push changes
         working-directory: wiki
         run: |

docs/Конвертер.md

@@ -1,7 +1,9 @@
+# Конвертер
+
 `converter` - функция конвертации отдельного элемента необходима для того, чтобы привести все входящие данные датасета к
 общему виду.
 
-Например, у нас имеется датасет на HuggingFace со стриктурой вида:
+Например, у нас имеется датасет на HuggingFace со структурой вида:
 
 ```json lines
 {"conversation":[{"from":"human","value":"text"},{"from":"gpt","value":"text"}]}

docs/Конфигурация.md

@@ -1,3 +1,5 @@
+# Конфигурация
+
 Описание секций конфигурации
 
 ## Пути
@@ -237,10 +239,20 @@ model:
 как `repo_id` на HuggingFace, так и путь до директории (абсолютный или относительный) в которой будут находиться
 веса и конфигурация модели.
 
-## Секация `trainer`
+## Секция `trainer`
+
+В данной секции можно передавать любой доступный в тренере параметр.
+
+### Параметр `trainer_class`
+
+Единственный параметр который не передаётся напрямую в конструктор `TrainerArguments`, он содержит в себе класс
+который будет заниматься непосредственной тренировкой моделей. По умолчанию он равен `transformers.Trainer`,
+но его можно заменить на любой другой или на свою реализацию.
 
 ### Параметр `optim`
 
+Список оптимизаторов, доступных в библиотеке `transformers` из коробки.
+
 ```json
 [
   "adamw_hf",

docs/Обучение.md

@@ -1,3 +1,5 @@
+# Режимы обучения
+
 Проект `impruver` поддерживает обучение моделей на одной или распределённое на нескольких видеокартах,
 по идее можно и на нескольких серверах выполнить обучение, но за неимением оных мне подобное протестировать
 пока что не удалось.

docs/Рецепты.md

@@ -1,3 +1,5 @@
+# Рецепты обучения
+
 Рецепты - это скрипты, которые выполняют некие работы в соответствии с тем, что описано в выбранной конфигурации.
 
 ## Рецепт `compose_dataset`