test 2 locales

Author: mishadr

.gitignore

@@ -1,54 +1,34 @@
+# Byte-compiled / optimized / DLL / temporary / generated files 
 *~
-*.py[co]
+*__pycache__*
+*$py.class
+*.py[cod]
 *.cpp
 *.so
 *.orig
 
-### Python template
-# Byte-compiled / optimized / DLL files
-*__pycache__*
-*.py[cod]
-*$py.class
-*experiments/explainers_metrics*
+# Virtual env
+/venv
 
+# IDE files
 .cache
 .idea
 .project
-
-_static
-build
-config
-pics
-pic
-results
-sphinx_docs
-*explainers_metrics*
-experiments/explainers_metrics/**/*_metrics.json
-
-datasets
-explanations
-models
-models_exp
-results
-data_info
-#user_models_obj
-#user_models_managers
-user_datasets
-PGE_gen_models
-
-venv
-venv_new
-
-
 .vscode
 
-gnn
-torch_install
-gnn_aid/.vscode
-
 # Mac OS extentions
 *.DS_Store
 
+# Project directories
+/data/ptg-library-graphs/
+/datasets/
+/explanations/
+/models/
+/data_info/
+/user_datasets
+/PGE_gen_models
+
 # Sphinx documentation
-docs/_build/
+/docs/source/_build/
+/docs/**/*.mo
 

docs/source/conf.py

@@ -1,5 +1,16 @@
 # Configuration file for the Sphinx documentation builder.
 
+# # Извлечь тексты для перевода
+# sphinx-build -b gettext . _build/gettext
+#
+# # Создать/обновить англ переводы
+# sphinx-intl update -p _build/gettext -l en
+#
+# # Собрать документацию на англ и русском
+# sphinx-build -b html -D language=en . _build/html/en
+# sphinx-build -b html -D language=ru . _build/html/ru
+
+
 # -- Path setup --------------------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -15,6 +26,7 @@
 # Use fake imports sto avoid readthedocs fails because of installation timeout
 sys.path.insert(0, os.path.abspath("../"))    # path to docs/
 import docs.mock_imports
+import sphinx_rtd_theme
 
 # -- Project information
 
@@ -53,20 +65,6 @@
 
 templates_path = ['_templates']
 
-# -- Options for HTML output
-
-html_theme = 'sphinx_rtd_theme'
-html_theme_options = {
-    'collapse_navigation': True,
-    'titles_only': False,
-}
-
-html_static_path = ["_static"]
-html_logo = "_static/logo.png"
-
-# -- Options for EPUB output
-epub_show_urls = 'footnote'
-
 # ---------------------
 autodoc_member_order = 'bysource'
 autodoc_special_members = '__init__'
@@ -82,4 +80,25 @@
 autosummary_generate = True
 add_module_names = False  # убирает 'datasets.ptg_datasets.' перед именем
 
-todo_include_todos = True
+todo_include_todos = True
+
+# -- locale
+
+language = 'ru'  # русский как основной
+locale_dirs = ['locale/']
+gettext_compact = False
+
+# -- Options for HTML output
+
+html_theme = 'sphinx_rtd_theme'
+html_theme_options = {
+    'collapse_navigation': True,
+    'titles_only': False,
+}
+
+html_static_path = ["_static"]
+html_logo = "_static/logo.png"
+
+# -- Options for EPUB output
+epub_show_urls = 'footnote'
+

docs/source/getting_started.rst

@@ -1,120 +1,122 @@
-Getting started
-***************
+Начало работы
+*************
 
 .. contents::
     :local:
     :depth: 2
 
 ..
-    гайд по установке и запуску (на не более 30мин), с ощущением достижения для читателя
+    гайд по установке и запуску (не более 30 минут), с ощущением достижения для читателя
 
     установка
-    запуск на бэке
+    запуск на бэкенде
         взять датасет, обучить модель, добавить 2 атаки и посмотреть числа
-    запуск фронта
+    запуск фронтенда
         запуск main и как открыть в браузере
         запуск из докера?
 
 
-Installation
-============
+Установка
+=========
 
-| GNN-AID was developed and tested under Ubuntu 20.04 and 22, so they
-  suit best for it.
-| For another OS consider docker.
+| GNN-AID разрабатывался и тестировался под Ubuntu 20.04 и 22.04, поэтому
+  они подходят лучше всего.
+| Для других операционных систем рекомендуется использовать Docker.
 
-You need python of version ``3.11`` or higher. We advice to create
-virtual environment with ``pip``.
+Вам понадобится Python версии ``3.11`` или выше. Мы рекомендуем создать
+виртуальное окружение с помощью ``pip``.
 
 ::
 
    python -m pip install --upgrade pip
 
-First, get auxiliary libraries
+Сначала установите вспомогательные библиотеки
 
 ::
 
    sudo apt-get install -y build-essential python3-dev libfreetype6-dev pkg-config
 
-Then install all project dependencies
+Затем установите все зависимости проекта
 
 ::
 
    pip install -r requirements1.txt
    pip install -r requirements2.txt
    pip install -r requirements3.txt
 
-The 3rd pack of requirements will take around 20 minutes.
+Третий набор зависимостей устанавливается примерно 20 минут.
 
-Problems
+Проблемы
 --------
 
-If you see 139 or 134 error code when run the script, it is likely a
-compatibility issue. Try the following:
+Если при запуске скрипта вы видите код ошибки 139 или 134, скорее всего,
+это проблема совместимости. Попробуйте следующее:
 
-1. Update video card drivers (if you have decided to use cuda).
-2. Update gcc to the most recent version.
-3. Remove all torch modules that use С++ code.
-4. Install all torch packages again.
+1. Обновите драйверы видеокарты (если вы используете CUDA).
+2. Обновите gcc до самой новой версии.
+3. Удалите все модули torch, использующие C++ код.
+4. Установите все пакеты torch заново.
 
-Run in backend
+Запуск бэкенда
 ==============
 
 .. todo::
 
     TODO
 
 
-Create dataset
---------------
+Создание датасета
+-----------------
 
 .. todo::
 
     TODO
 
 
-Build and train model
----------------------
+Сборка и обучение модели
+------------------------
 
 .. todo::
 
     TODO
 
-Run in frontend
-===============
 
-Suppose you are at the project root folder. Activate virtual environment
+Запуск фронтенда
+================
+
+Предполагается, что вы находитесь в корневой директории проекта.
+Активируйте виртуальное окружение
 
 .. code:: text
 
    source venv/bin/activate
 
-Go to ``gnn_aid`` folder and add it to python dependencies
+Перейдите в каталог ``gnn_aid`` и добавьте его в зависимости Python
 
 .. code:: text
 
    cd gnn_aid
    export PYTHONPATH=.
 
-Run ``main.py`` script
+Запустите скрипт ``main.py``
 
 .. code:: text
 
    python web_interface/main.py
 
-You will see something like this
+Вы увидите примерно следующее
 
 .. code:: text
 
    ======== Running on http://0.0.0.0:5000 ========
    (Press CTRL+C to quit)
 
-Then go to `127.0.0.1:5000 <http://127.0.0.1:5000>`__ in your browser.
-You should see web-interface is loaded.
+Затем откройте `127.0.0.1:5000 <http://127.0.0.1:5000>`__ в браузере.
+Вы должны увидеть загруженный веб-интерфейс.
 
-Docker version
---------------
+Версия с Docker
+---------------
 
 .. todo::
 
-    TODO
+    TODO

docs/source/index.rst

@@ -1,41 +1,43 @@
-Welcome to GNN-AID documentation!
-=================================
+Добро пожаловать в документацию GNN-AID!
+=========================================
 
-GNN-AID is an open framework for **A**\ nalysis, **I**\ nterpretation, and **D**\ efensing Graph Neural Networks.
-It is built on `PyTorch-Geometric <https://pytorch-geometric.readthedocs.io>`_ and:
+**GNN-AID** — это открытый фреймворк для визуализации, анализа, интерпретации графовых нейронных сетей с возможность применять атаки и защиты.
+Фреймворк построен на базе `PyTorch-Geometric <https://pytorch-geometric.readthedocs.io>`_ и:
 
-- includes preloaded `datasets from PyG <https://pytorch-geometric.readthedocs.io/en/latest/cheatsheet/data_cheatsheet.html>`_
-- extendable API for custom architectures: datasets, models, explainers, attacks and defense methods
-- MLOps features for experiments reproducibility
+- включает готовые `датасеты из PyG <https://pytorch-geometric.readthedocs.io/en/latest/cheatsheet/data_cheatsheet.html>`_
+- расширяемый API для пользовательских архитектур на уровне датасетов, моделей, методов интерпретации, атак и защит
+- MLOps техники для воспроизводимых экспериментов
 
-GNN-AID has a web interface which supports:
+GNN-AID имеет веб-интерфейс, который поддерживает:
+
+- интерактивную визуализацию графов
+- конструктор модели "без кода"
+- визуализация объяснений решения модели
+- визуализация результатов атак на модель
 
-- graph visualization and analysis tools
-- no-code model building
-- visualization of models explanations
 
 .. Check out :doc:`installation` of the project.
 
 .. .. note::
 
-..    This project is under active development.
+..    Проект находится в разработке.
 
 
 .. toctree::
     :maxdepth: 1
-    :caption: Getting started
+    :caption: Начало
 
     getting_started
 
 .. toctree::
     :maxdepth: 1
-    :caption: Tutorials
+    :caption: Примеры
 
     tutorials
 
 .. toctree::
     :maxdepth: 1
-    :caption: User guide
+    :caption: Руководство пользователя
 
     user_guide/pipeline
     user_guide/backend
@@ -47,7 +49,7 @@ GNN-AID has a web interface which supports:
 
 .. toctree::
     :maxdepth: 1
-    :caption: Developer guide
+    :caption: Руководство разработчика
 
     dev_guide/arch_back.rst
     dev_guide/arch_front.rst
@@ -56,7 +58,7 @@ GNN-AID has a web interface which supports:
 
 .. toctree::
     :maxdepth: 1
-    :caption: Package reference
+    :caption: Обзор пакетов
 
     api/aux
     api/data_structures