Документация обновлена, добавлены подробные инструкции по установке

docs/requirements.txt

@@ -1,42 +1,39 @@
 sphinx==6.1.3
 sphinx_rtd_theme==1.2.0
 sphinx-toolbox==3.4.0
-sphinx-tabs>=3.4.1
-sphinxcontrib-video>=0.1.1
+sphinx-tabs==3.4.1
+sphinxcontrib-video==0.1.1
 # sphinx_design==0.3.0
 sphinx-intl==2.1.0
 nbsphinx==0.8.12
 sphinx_github_changelog==1.2.0
 sphinx-copybutton==0.5.1
-ipython>=8.10.0
-colorama>=0.4.6
-numpy>=1.24.2
-pandas>=1.5.3
-prettytable>=3.6.0
-torch>=1.13.1
-torchaudio>=0.13.1
-torchvision>=0.14.1
-av>=10.0.0
-filetype>=1.2.0
-vosk>=0.3.44
-requests>=2.28.2
-black>=23.1.0
-pyyaml>=6.0
-streamlit>=1.20.0
-watchdog>=2.3.1
-pymediainfo >= 6.0.1
-pillow >= 9.5.0
-imgaug >= 0.4.0
-flask >= 2.3.3
-ffmpeg >= 1.4
-librosa >= 0.10.1
-matplotlib >= 3.6.3
-mediapipe == 0.9.3.0
-opencv_contrib_python >= 4.9.0.80
-werkzeug == 3.0.1
-einops >= 0.7.0
-lion_pytorch >= 0.1.4
-scikit-learn >= 1.4.2
-tqdm >= 4.66.2
-seaborn >= 0.13.2
-Flask >= 3.0.3
+ipython==8.31.0
+colorama==0.4.6
+numpy==1.26.4
+pandas==2.2.3
+prettytable==3.12.0
+torch==2.2.2
+torchaudio==2.2.2
+torchvision==0.17.2
+av==14.0.1
+filetype==1.2.0
+vosk==0.3.44
+requests==2.32.3
+pyyaml==6.0.2
+streamlit==1.41.1
+watchdog==6.0.0
+pymediainfo==6.1.0
+pillow==11.0.0
+imgaug==0.4.0
+ffmpeg==1.4
+librosa==0.10.2.post1
+matplotlib==3.10.0
+mediapipe==0.10.20
+opencv_contrib_python==4.10.0.84
+einops==0.8.0
+lion_pytorch==0.2.3
+scikit-learn==1.6.0
+tqdm==4.67.1
+seaborn==0.13.2
+Flask==3.1.0

docs/source/user_guide/installation.rst

@@ -2,57 +2,8 @@
 ======================
 
 .. toctree::
-   :maxdepth: 3
-   :hidden:
-   :caption: Содержание:
+   :maxdepth: 1
 
-Установка с помощью `PyPi <https://pypi.org/project/openav/>`_
----------------------------------------------------------------
-
-.. code-block:: sh
-
-   pip install openav
-
-Обновление с помощью `PyPi <https://pypi.org/project/openav/>`_
-----------------------------------------------------------------
-
-.. code-block:: sh
-
-   pip install --upgrade openav
-
-Зависимости
------------
-
-.. csv-table:: Устанавливаются автоматически
-   :align: center
-   :header: "Библиотека", "Рекомендуемая версия", "Текущая версия"
-   :widths: 30, 30, 30
-
-   "ipython", "8.10.0", ".. image:: https://img.shields.io/pypi/v/ipython"
-   "colorama", "0.4.6", ".. image:: https://img.shields.io/pypi/v/colorama"
-   "numpy", "1.24.2", ".. image:: https://img.shields.io/pypi/v/numpy"
-   "pandas", "1.5.3", ".. image:: https://img.shields.io/pypi/v/pandas"
-   "prettytable", "3.6.0", ".. image:: https://img.shields.io/pypi/v/prettytable"
-   "torch", "1.13.1", ".. image:: https://img.shields.io/pypi/v/torch"
-   "torchaudio", "0.13.1", ".. image:: https://img.shields.io/pypi/v/torchaudio"
-   "torchvision", "0.14.1", ".. image:: https://img.shields.io/pypi/v/torchvision"
-   "vosk", "0.3.44", ".. image:: https://img.shields.io/pypi/v/vosk"
-   "av", "10.0.0", ".. image:: https://img.shields.io/pypi/v/av"
-   "filetype", "1.2.0", ".. image:: https://img.shields.io/pypi/v/filetype"
-   "requests", "2.28.2", ".. image:: https://img.shields.io/pypi/v/requests"
-   "pyyaml", "6.0", ".. image:: https://img.shields.io/pypi/v/pyyaml"
-   "streamlit", "1.20.0", ".. image:: https://img.shields.io/pypi/v/streamlit"
-   "watchdog", "2.3.1", ".. image:: https://img.shields.io/pypi/v/watchdog"
-   "pymediainfo", "6.0.1", ".. image:: https://img.shields.io/pypi/v/pymediainfo"
-   "pillow", "9.5.0", ".. image:: https://img.shields.io/pypi/v/pillow"
-   "imgaug", "0.4.0", ".. image:: https://img.shields.io/pypi/v/imgaug"
-   "flask", "2.3.3", ".. image:: https://img.shields.io/pypi/v/flask"
-   "ffmpeg", "1.4", ".. image:: https://img.shields.io/pypi/v/ffmpeg"
-   "librosa", "0.10.1", ".. image:: https://img.shields.io/pypi/v/librosa"
-   "matplotlib", "3.6.3", ".. image:: https://img.shields.io/pypi/v/matplotlib"
-   "mediapipe", "0.9.3.0", ".. image:: https://img.shields.io/pypi/v/mediapipe"
-   "opencv_contrib_python", "4.9.0.80", ".. image:: https://img.shields.io/pypi/v/opencv_contrib_python"
-   "einops", "0.7.0", ".. image:: https://img.shields.io/pypi/v/einops"
-   "lion_pytorch", "0.1.4", ".. image:: https://img.shields.io/pypi/v/lion_pytorch"
-   "scikit-learn", "1.4.2", ".. image:: https://img.shields.io/pypi/v/scikit-learn"
-   "tqdm", "4.66.2", ".. image:: https://img.shields.io/pypi/v/tqdm"
+   installation/installation_win
+   installation/installation_mac
+   installation/dependencies

docs/source/user_guide/installation/dependencies.rst

@@ -0,0 +1,39 @@
+Зависимости
+===========
+
+.. important:: Необходимая версия Python 3.10 и выше.
+
+.. csv-table:: Устанавливаются автоматически
+   :align: center
+   :header: "Библиотека", "Рекомендуемая версия", "Текущая версия"
+   :widths: 30, 30, 30
+
+   "ipython", "8.31.0", ".. image:: https://img.shields.io/pypi/v/ipython"
+   "colorama", "0.4.6", ".. image:: https://img.shields.io/pypi/v/colorama"
+   "numpy", "1.26.4", ".. image:: https://img.shields.io/pypi/v/numpy"
+   "pandas", "2.2.3", ".. image:: https://img.shields.io/pypi/v/pandas"
+   "prettytable", "3.12.0", ".. image:: https://img.shields.io/pypi/v/prettytable"
+   "torch", "2.2.2", ".. image:: https://img.shields.io/pypi/v/torch"
+   "torchaudio", "2.2.2", ".. image:: https://img.shields.io/pypi/v/torchaudio"
+   "torchvision", "0.17.2", ".. image:: https://img.shields.io/pypi/v/torchvision"
+   "vosk", "0.3.44", ".. image:: https://img.shields.io/pypi/v/vosk"
+   "av", "14.0.1", ".. image:: https://img.shields.io/pypi/v/av"
+   "filetype", "1.2.0", ".. image:: https://img.shields.io/pypi/v/filetype"
+   "requests", "2.32.3", ".. image:: https://img.shields.io/pypi/v/requests"
+   "pyyaml", "6.0.2", ".. image:: https://img.shields.io/pypi/v/pyyaml"
+   "streamlit", "1.41.1", ".. image:: https://img.shields.io/pypi/v/streamlit"
+   "watchdog", "6.0.0", ".. image:: https://img.shields.io/pypi/v/watchdog"
+   "pymediainfo", "6.1.0", ".. image:: https://img.shields.io/pypi/v/pymediainfo"
+   "pillow", "11.0.0", ".. image:: https://img.shields.io/pypi/v/pillow"
+   "imgaug", "0.4.0", ".. image:: https://img.shields.io/pypi/v/imgaug"
+   "ffmpeg", "1.4", ".. image:: https://img.shields.io/pypi/v/ffmpeg"
+   "librosa", "0.10.2.post1", ".. image:: https://img.shields.io/pypi/v/librosa"
+   "matplotlib", "3.10.0", ".. image:: https://img.shields.io/pypi/v/matplotlib"
+   "mediapipe", "0.10.20", ".. image:: https://img.shields.io/pypi/v/mediapipe"
+   "opencv_contrib_python", "4.10.0.84", ".. image:: https://img.shields.io/pypi/v/opencv_contrib_python"
+   "einops", "0.8.0", ".. image:: https://img.shields.io/pypi/v/einops"
+   "lion_pytorch", "0.2.3", ".. image:: https://img.shields.io/pypi/v/lion_pytorch"
+   "scikit-learn", "1.6.0", ".. image:: https://img.shields.io/pypi/v/scikit-learn"
+   "tqdm", "4.67.1", ".. image:: https://img.shields.io/pypi/v/tqdm"
+   "seaborn", "0.13.2", ".. image:: https://img.shields.io/pypi/v/seaborn"
+   "Flask", "3.1.0", ".. image:: https://img.shields.io/pypi/v/flask"

docs/source/user_guide/installation/installation_mac.rst

@@ -0,0 +1,105 @@
+.. include:: ../../reuse_content/general.rst
+
+.. |a_download_mac| raw:: html
+
+    <a href="https://www.python.org/downloads/macos/" target="_blank">
+
+Установка и обновление на операционных системах MacOS/Linux
+===========================================================
+
+Подготовка рабочего пространства
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Перейти на сайт и |a_download_mac| скачать необходимый дистрибутив |/a| (например Python 3.12.8)
+
+.. figure:: ../../_static/img/installation/mac/download_mac.png
+        :align: center
+        :alt: Загрузка дистрибутива
+
+        |br|
+
+2. Установить Python
+
+.. figure:: ../../_static/img/installation/mac/install.png
+        :align: center
+        :alt: Завершенный процесс установки Python
+
+        |br|
+
+3. Установить библиотеку virtualenv для создания изолированных сред Python:
+
+.. code-block:: sh
+
+   pip install virtualenv
+
+.. figure:: ../../_static/img/installation/mac/virtualenv.png
+        :align: center
+        :alt: Завершенный процесс установки библиотеки virtualenv
+
+        |br|
+
+4. Добавить путь к вашей версии Python 3.10 и выше в PATH:
+
+.. code-block:: sh
+
+   export PATH="ПУТЬ_К_PYTHON:$PATH"
+
+.. figure:: ../../_static/img/installation/mac/path.png
+        :align: center
+        :alt: Добавление пути к установленному Python в PATH
+
+        |br|
+
+Создание изолированной среды OpenAV
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Создать директорию envs и перейти в нее:
+
+.. code-block:: sh
+
+   cd ПУТЬ_К_ДИРЕКТОРИИ
+
+.. figure:: ../../_static/img/installation/mac/cd_envs.png
+        :align: center
+        :alt: Переход в директорию envs через команду «cd»
+
+        |br|
+
+2. Разместить новую виртуальную среду OpenAV в указанной директории с указанной версией Python:
+
+.. code-block:: sh
+
+   virtualenv --python=ПУТЬ_К_PYTHON OpenAV
+
+.. figure:: ../../_static/img/installation/mac/dir_placed.png
+        :align: center
+        :alt: Размещение новой виртуальной среды OpenAV в указанной директории с указанной версией Python
+
+        |br|
+
+3. Активировать созданную виртуальную среду OpenAV в директории:
+
+.. code-block:: sh
+
+   source OpenAV/bin/activate
+
+.. figure:: ../../_static/img/installation/mac/activate.png
+        :align: center
+        :alt: Активация созданной виртуальной среды OpenAV в директории
+
+        |br|
+
+Работа с библиотекой OpenAV
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Установить библиотеку OpenAV:
+
+.. code-block:: sh
+
+   pip install openav
+
+.. figure:: ../../_static/img/installation/mac/openav.png
+        :align: center
+        :alt: Установленная библиотека OpenAV со всеми зависимостями
+
+        |br|

docs/source/user_guide/installation/installation_win.rst

@@ -0,0 +1,80 @@
+.. include:: ../../reuse_content/general.rst
+
+.. |a_download| raw:: html
+
+    <a href="https://www.python.org/downloads/windows/" target="_blank">
+
+Установка и обновление на операционной системе Windows
+======================================================
+
+Подготовка рабочего пространства и оздание изолированной среды OpenAV
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Перейти на сайт и |a_download| скачать необходимый дистрибутив |/a| (например Python 3.12.8)
+
+.. figure:: ../../_static/img/installation/win/download.png
+        :align: center
+        :alt: Загрузка дистрибутива
+
+        |br|
+
+2. Установить Python
+
+.. figure:: ../../_static/img/installation/win/install.png
+        :align: center
+        :alt: Завершенный процесс установки Python
+
+        |br|
+
+3. Перейти в подготовленный каталог с проектом:
+
+.. code-block:: sh
+
+   cd ПУТЬ_К_ДИРЕКТОРИИ
+
+.. figure:: ../../_static/img/installation/win/dir.png
+        :align: center
+        :alt: Переход в директорию с проектом через команду «cd»
+
+        |br|
+
+4. Разместить новую виртуальную среду OpenAV в указанной директории с указанной версией Python (с помощью команды ``py --list`` можно проверить установленные версии Python):
+
+.. code-block:: sh
+
+   py -3.12 -m venv env
+
+.. figure:: ../../_static/img/installation/win/env.png
+        :align: center
+        :alt: Размещение новой виртуальной среды OpenAV в указанной директории с указанной версией Python
+
+        |br|
+
+5. Активировать созданную виртуальную среду OpenAV в директории:
+
+.. code-block:: sh
+
+   cd env/Scripts/
+   ./activate
+   cd ../../
+
+.. figure:: ../../_static/img/installation/win/activate.png
+        :align: center
+        :alt: Активация созданной виртуальной среды OpenAV в директории с проектом
+
+        |br|
+
+Работа с библиотекой OpenAV
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Установить библиотеку OpenAV:
+
+.. code-block:: sh
+
+   pip install openav
+
+.. figure:: ../../_static/img/installation/win/openav.png
+        :align: center
+        :alt: Установленная библиотека OpenAV со всеми зависимостями
+
+        |br|