Skip to content

Commit

Permalink
add audiovisual train page
Browse files Browse the repository at this point in the history
  • Loading branch information
@MiSTeR1995
MiSTeR1995 committed Apr 26, 2024
1 parent 4aa9689 commit af66386
Show file tree
Hide file tree
Showing 4 changed files with 662 additions and 0 deletions.
72 changes: 72 additions & 0 deletions docs/source/user_guide/modules/train/audiovisual.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
.. include:: ../../../reuse_content/general.rst

.. |a_config| raw:: html

<a href="https://github.com/DmitryRyumin/OpenAV/blob/develop/openav/rsrs/train_audiovisual.yaml" target="_blank">

Обучение аудиовизуальных нейросетевых моделей
=============================================

Команда для запуска процесса обучения аудиовизуальных нейросетевых моделей:

.. code-block:: sh
openav_train_audiovisual --config <путь_к_вашему_конфигурационному_файлу>.yaml
.. important:: Для запуска команды необходимо обязательно указать путь к конфигурационному файлу. Запускать программу необходимо из директории, где она расположена.

Конфигурационный файл
~~~~~~~~~~~~~~~~~~~~~

Конфигурационный файл включает в себя следующие настройки:

* Отображение процесса выполнения программы в терминале (командной строке)
* Работа с файловой системой
* Параметры настройки процесса обучения нейросетевых моделей

.. rst-class:: config-link

|a_config|
Пример конфигурационного файла
|/a|

Отображение процесса выполнения команды в терминале
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. rst-class:: custom-table shell-table
.. csv-table::
:align: center
:header: "Параметр", "Тип", "Значение по умолчанию", "Описание"
:widths: 23, 7, 25, 45

"hide_metadata", "bool", "``false``", "Включение отображения метаданных"
"hide_libs_vers", "bool", "``false``", "Включение отображения версий установленных библиотек в командной строке"


Работа с файловой системой
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. rst-class:: custom-table filesystem-table
.. csv-table::
:align: center
:header: "Параметр", "Тип", "Значение по умолчанию", "Описание"
:widths: 23, 7, 25, 45

"path_to_dataset", "str", "``<путь_к_набору_данных>``", "Директория, где размещается подготовленный набор данных для обучения нейросетевых моделей"


Параметры процесса обучения визуальных нейросетевых моделей
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. rst-class:: custom-table encode-table
.. csv-table::
:align: center
:header: "Параметр", "Тип", "Значение по умолчанию", "Описание"
:widths: 23, 7, 20, 50

"seed", "int", "``42``", "Параметр для инициализации случайных процессов, который обеспечивает воспроизводимость результатов и одинаковые начальные условия"
"batch_size", "int", "``8``", "Размер батча. Общее число тренировочных объектов, представленных в одном батче. Устанавливается в зависимости от возможности вашего оборудования"
"lr", "float", "``0.0001``", "Коэффициент скорости обучения. Чем меньше значение, тем дольше будет идти обучение модели. Однако, стоит помнить, что может наступить переобучение модели. Данный коэффициент подбирается эмпирическим путем"
"epoch", "int", "``100``", "Количество эпох обучения модели. Проход одной эпохи значит, что весь датасет прошел через нейронную сеть в прямом и обратном направлении только один раз. Параметр ``epoch_stop`` позволяет избежать переобучения модели"
"epoch_stop", "int", "``5``", "Количество эпох, в течении которых модель не прогрессирует в обучении. Т.е. если по прошествии, например, ``5`` эпох модель не показывала прирост ``accuracy`` (либо ваша метрика), то в данном случае процесс обучения останавливается и сохраняется модель на эпохе с наибольшей точностью. Данный параметр позволяет предотварить переобучение модели, а также снизить длительность обучения"
1 change: 1 addition & 0 deletions docs/source/user_guide/modules/train_index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@

train/audio
train/video
train/audiovisual
294 changes: 294 additions & 0 deletions locales/en/LC_MESSAGES/user_guide/modules/train/audiovisual.po
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,294 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2022-24. Dmitry Ryumin, Denis Ivanko, Nikolay Shilov, Maxim
# Markitantov, Alexey Karpov
# This file is distributed under the same license as the OpenAV package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: OpenAV 1.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2024-04-26 10:53+0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
"Language-Team: en <LL@li.org>\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.11.0\n"

#: ../../source/reuse_content/general.rst:1 0b729f46410f47dc826efa88a9fcbc2a
msgid "</br>"
msgstr ""

#: ../../source/reuse_content/general.rst:5 1e6d926df71f434084be206b729ea2d0
msgid "<b>"
msgstr ""

#: ../../source/reuse_content/general.rst:9 9edc977b85e24b14bf57ff5aefe58bb1
msgid "</b>"
msgstr ""

#: ../../source/reuse_content/general.rst:14 4989cd7e55d9465ebb9b2d676aa5aab4
#: cd54d0a044a241bbae7daba4e049b048
msgid "</a>"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:3
#: c3512f87283842a38d5ce8590a2467e6 c661b05fbf0941a0a98970014bf85ea5
msgid ""
"<a "
"href=\"https://github.com/DmitryRyumin/OpenAV/blob/develop/openav/rsrs/train_audiovisual.yaml\""
" target=\"_blank\">"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:8
#: f4b3387499ca4d8d91a73b44e0f380b3
msgid "Обучение аудиовизуальных нейросетевых моделей"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:10
#: 04fc35d4d37042c38d9654f49798f22a
msgid ""
"Команда для запуска процесса обучения аудиовизуальных нейросетевых "
"моделей:"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:12
#: 8a36c8070c814439bc47cfade7c0f665
msgid ""
"openav_train_audiovisual --config "
"<путь_к_вашему_конфигурационному_файлу>.yaml"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:17
#: 6f136e58b9f94962bfbc720ca3a1e0f5
msgid ""
"Для запуска команды необходимо обязательно указать путь к "
"конфигурационному файлу. Запускать программу необходимо из директории, "
"где она расположена."
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:20
#: b3d385e7a9e24527b9c41d312c2d2fd4
msgid "Конфигурационный файл"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:22
#: b93c000409934a46a40589a2e73d9f01
msgid "Конфигурационный файл включает в себя следующие настройки:"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:24
#: f80e981b17cf428e987a26f1968d36ff
msgid "Отображение процесса выполнения программы в терминале (командной строке)"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:25
#: ../../source/user_guide/modules/train/audiovisual.rst:48
#: 0db3025a686f4ad2991037aad1a863d2 7eae0651b17c4f02b71bc6585b10fd7a
msgid "Работа с файловой системой"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:26
#: 7cc46efc541a4fecacff7ae62bca8736
msgid "Параметры настройки процесса обучения нейросетевых моделей"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:30
#: b7d34368889e4f4181ae84df80e293aa
msgid "|a_config| Пример конфигурационного файла |/a|"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:35
#: 26c4237690ae46cfab990f739db7b40b
msgid "Отображение процесса выполнения команды в терминале"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 27e8efb3ae7041b3a4df1b00c23dddc6 71a6a9b03bd94634a9569edcb2bab8ea
#: 8189cb1ffbe04e39bab8494155941c6c
msgid "Параметр"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 06670f4c83d7474e97633ce8878e5988 85378bde28d0481f8642d7ac9024950b
#: fddc2b7f5ffb4f2a9a95464151c61bc8
msgid "Тип"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 9b75bc8b3fce45279b431f1cb6e3dabe a77161b457ef4a66b97bcada8c4bb7ba
#: f61d497894de4970a7d52be86dd69a86
msgid "Значение по умолчанию"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 02d498a4dc8b46239ab6a8647115d8ac 5dd27a47784f49bbad1f30dcd76b8889
#: a96d7c6c32cf4bc2bc46f6c8cf147ece
msgid "Описание"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 28e5e3cd9df0476da4f52676860570a6
msgid "hide_metadata"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 0b01084dbb0d4f53b77d6f051dfc704b 4305ec1b2dfa4db68882a2014d416a27
msgid "bool"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 53d17a969b214ba79dafc6ea7d6c16eb af43b134d2744388bf036eee3602c644
msgid "``false``"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 57673357dd3244909b25906de27060a7
msgid "Включение отображения метаданных"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: de82eee238424b2dae96b105636f44e9
msgid "hide_libs_vers"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: e3fcefa8589848a19c05bd5f67dc92a6
msgid "Включение отображения версий установленных библиотек в командной строке"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 1c81f1c6114d498983d069b3cd4d2cec
msgid "path_to_dataset"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: a2d547da2a344814a056d242fd188db6
msgid "str"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: d7a6ec6369724785b263656691d83de6
msgid "``<путь_к_набору_данных>``"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: cf9519361a1b477aa7540671d240f952
msgid ""
"Директория, где размещается подготовленный набор данных для обучения "
"нейросетевых моделей"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:60
#: 7ed8ad63b1ad4427b5415bf99c49c6f4
msgid "Параметры процесса обучения визуальных нейросетевых моделей"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 005bd94f1b4d4293b07b54573ed9040c
msgid "seed"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 2d4494cfa35d47e6a8cd6a90d388c5a8 8b8e42f22f5e48e8a0276112d49ed6c4
#: aea4774a879c44aa81d1f841162c8b19 b7dafd3c81404a3098270b69094b16a1
msgid "int"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 2649866f96974358af9609265cd52305
msgid "``42``"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 059bea74e3914421a0e4e136432afac2
msgid ""
"Параметр для инициализации случайных процессов, который обеспечивает "
"воспроизводимость результатов и одинаковые начальные условия"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: ef924e3650df466d9d11ad620f943562
msgid "batch_size"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 93e03035c07a43f88ecb3de0f5393aad
msgid "``8``"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 6f4642ce160b4383843ef0ca68a9f119
msgid ""
"Размер батча. Общее число тренировочных объектов, представленных в одном "
"батче. Устанавливается в зависимости от возможности вашего оборудования"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: c057c5c675a544ab97cb0b0cf1c42f3a
msgid "lr"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 050ae20cdeb94c39a9948b1e830ad481
msgid "float"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 43fa92816a414036ae9bb5b91d287c20
msgid "``0.0001``"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: fb97d75c7ca14f37bf1896b387892f16
msgid ""
"Коэффициент скорости обучения. Чем меньше значение, тем дольше будет идти"
" обучение модели. Однако, стоит помнить, что может наступить переобучение"
" модели. Данный коэффициент подбирается эмпирическим путем"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 915b53fb02054caca2d1a4f8955ae39c
msgid "epoch"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 14097515edcc43709d4fe443a7b6d039
msgid "``100``"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: abb2bf7546b5499e8ec34f2760afc43d
msgid ""
"Количество эпох обучения модели. Проход одной эпохи значит, что весь "
"датасет прошел через нейронную сеть в прямом и обратном направлении "
"только один раз. Параметр ``epoch_stop`` позволяет избежать переобучения "
"модели"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 00b719b888fc4623b1a3a194e8c3eae3
msgid "epoch_stop"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: d28b3eef52e047519ed1e9eef3c43b13
msgid "``5``"
msgstr ""

#: ../../source/user_guide/modules/train/audiovisual.rst:1
#: 77647df54490452cb7cd847e9652d6ff
msgid ""
"Количество эпох, в течении которых модель не прогрессирует в обучении. "
"Т.е. если по прошествии, например, ``5`` эпох модель не показывала "
"прирост ``accuracy`` (либо ваша метрика), то в данном случае процесс "
"обучения останавливается и сохраняется модель на эпохе с наибольшей "
"точностью. Данный параметр позволяет предотварить переобучение модели, а "
"также снизить длительность обучения"
msgstr ""

Loading

0 comments on commit af66386

Please sign in to comment.