Skip to content

[doc] Update after benchmark integration #801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aobolensk merged 1 commit into from
Jun 6, 2026
Merged

[doc] Update after benchmark integration #801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions docs/locale/en/LC_MESSAGES/user_guide/ci.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ msgstr ""

#: ../../../../docs/user_guide/ci.rst:19
msgid ""
"Performance (perf) — ``scripts/generate_perf_results.sh`` produces "
"``build/perf_stat_dir``; uploads ``perf-stat`` (Linux) and ``perf-stat-"
"macos`` (macOS)."
"Performance (perf) — ``scripts/run_tests.py --running-type=performance`` "
"writes benchmark data to ``build/perf_stat_dir``; uploads ``perf-stat`` "
"(Linux) and ``perf-stat-macos`` (macOS)."
msgstr ""

#: ../../../../docs/user_guide/ci.rst:21
Expand Down Expand Up @@ -191,9 +191,9 @@ msgstr ""

#: ../../../../docs/user_guide/ci.rst:84
msgid ""
"Scoreboard: generate perf stats (``scripts/generate_perf_results.sh``) "
"and build scoreboard target or use ``python3 scoreboard/main.py`` "
"locally."
"Scoreboard: generate perf stats (``scripts/run_tests.py --running-"
"type=performance``) and build scoreboard target or use ``python3 "
"scoreboard/main.py`` locally."
msgstr ""

#: ../../../../docs/user_guide/ci.rst:87
Expand Down Expand Up @@ -239,8 +239,8 @@ msgstr ""

#: ../../../../docs/user_guide/ci.rst:94
msgid ""
"Performance job fails: ensure exactly two perf tests (``task`` and "
"``pipeline``) and keep durations within limits."
"Performance job fails: ensure performance tests are enabled and keep "
"durations within limits."
msgstr ""

#: ../../../../docs/user_guide/ci.rst:97
Expand Down Expand Up @@ -378,4 +378,3 @@ msgstr ""
#~ " or verifying the exact arguments "
#~ "passed to the test binaries."
#~ msgstr ""

5 changes: 2 additions & 3 deletions docs/locale/en/LC_MESSAGES/user_guide/submit_work.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,8 @@ msgstr ""

#: ../../../../docs/user_guide/submit_work.rst:103
msgid ""
"Cover edge cases in functional tests; add exactly two performance test "
"styles (``task`` and ``pipeline``) inside the suite."
"Cover edge cases in functional tests; add focused performance tests for "
"enabled implementations."
msgstr ""

#: ../../../../docs/user_guide/submit_work.rst:105
Expand Down Expand Up @@ -431,4 +431,3 @@ msgstr ""
#~ "integration flow used in semester "
#~ "repositories."
#~ msgstr ""

33 changes: 17 additions & 16 deletions docs/locale/ru/LC_MESSAGES/user_guide/ci.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,14 @@ msgstr ""

#: ../../../../docs/user_guide/ci.rst:19
msgid ""
"Performance (perf) — ``scripts/generate_perf_results.sh`` produces "
"``build/perf_stat_dir``; uploads ``perf-stat`` (Linux) and ``perf-stat-"
"macos`` (macOS)."
"Performance (perf) — ``scripts/run_tests.py --running-type=performance`` "
"writes benchmark data to ``build/perf_stat_dir``; uploads ``perf-stat`` "
"(Linux) and ``perf-stat-macos`` (macOS)."
msgstr ""
"Производительность (perf) — ``scripts/generate_perf_results.sh`` "
"формирует ``build/perf_stat_dir``; загружаются артефакты ``perf-stat`` "
"(Linux) и ``perf-stat-macos`` (macOS)."
"Производительность (perf) — ``scripts/run_tests.py --running-"
"type=performance`` записывает данные бенчмарков в ``build/perf_stat_dir``;"
" загружаются артефакты ``perf-stat`` (Linux) и ``perf-stat-macos`` "
"(macOS)."

#: ../../../../docs/user_guide/ci.rst:21
msgid ""
Expand Down Expand Up @@ -238,13 +239,13 @@ msgstr ""

#: ../../../../docs/user_guide/ci.rst:84
msgid ""
"Scoreboard: generate perf stats (``scripts/generate_perf_results.sh``) "
"and build scoreboard target or use ``python3 scoreboard/main.py`` "
"locally."
"Scoreboard: generate perf stats (``scripts/run_tests.py --running-"
"type=performance``) and build scoreboard target or use ``python3 "
"scoreboard/main.py`` locally."
msgstr ""
"Табло: сформируйте статистику (``scripts/generate_perf_results.sh``) и "
"соберите цель табло или воспользуйтесь локально ``python3 "
"scoreboard/main.py``."
"Табло: сформируйте статистику (``scripts/run_tests.py --running-"
"type=performance``) и соберите цель табло или воспользуйтесь локально "
"``python3 scoreboard/main.py``."

#: ../../../../docs/user_guide/ci.rst:87
msgid "Troubleshooting"
Expand Down Expand Up @@ -305,11 +306,11 @@ msgstr ""

#: ../../../../docs/user_guide/ci.rst:94
msgid ""
"Performance job fails: ensure exactly two perf tests (``task`` and "
"``pipeline``) and keep durations within limits."
"Performance job fails: ensure performance tests are enabled and keep "
"durations within limits."
msgstr ""
"Падает job производительности: убедитесь, что ровно два перфтеста "
"(``task`` и ``pipeline``) и длительность в пределах лимитов."
"Падает job производительности: убедитесь, что перфтесты включены и "
"длительность в пределах лимитов."

#: ../../../../docs/user_guide/ci.rst:97
msgid "Local clang-tidy and gcovr examples"
Expand Down
8 changes: 4 additions & 4 deletions docs/locale/ru/LC_MESSAGES/user_guide/submit_work.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,11 +164,11 @@ msgstr "Используйте ``PPC_ID_<task_id>`` для доступа к ф

#: ../../../../docs/user_guide/submit_work.rst:103
msgid ""
"Cover edge cases in functional tests; add exactly two performance test "
"styles (``task`` and ``pipeline``) inside the suite."
"Cover edge cases in functional tests; add focused performance tests for "
"enabled implementations."
msgstr ""
"Покрывайте крайние случаи в функциональных тестах; добавьте ровно два "
"стиля перфтестов (``task`` и ``pipeline``) внутри набора."
"Покрывайте крайние случаи в функциональных тестах; добавьте сфокусированные "
"перфтесты для включенных реализаций."

#: ../../../../docs/user_guide/submit_work.rst:105
msgid "``data/`` — optional input files for tests (e.g., images)."
Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/ci.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ High‑level pipeline

- Coverage (Ubuntu/GCC) — ``-D USE_COVERAGE=ON`` + gcovr; publishes to Codecov and uploads ``cov-report`` (HTML).

- Performance (perf) — ``scripts/generate_perf_results.sh`` produces ``build/perf_stat_dir``; uploads ``perf-stat`` (Linux) and ``perf-stat-macos`` (macOS).
- Performance (perf) — ``scripts/run_tests.py --running-type=performance`` writes benchmark data to ``build/perf_stat_dir``; uploads ``perf-stat`` (Linux) and ``perf-stat-macos`` (macOS).

- Pages (docs and scoreboard) — builds Doxygen XML and Sphinx (EN+RU) + scoreboard; on ``master`` deploys with coverage to GitHub Pages.

Expand Down Expand Up @@ -81,7 +81,7 @@ Coverage and sanitizers locally
Docs and scoreboard artifacts
-----------------------------
- Docs: run Doxygen first (``doxygen Doxyfile``), then Sphinx EN/RU via CMake targets ``docs_gettext``, ``docs_update``, ``docs_html``.
- Scoreboard: generate perf stats (``scripts/generate_perf_results.sh``) and build scoreboard target or use ``python3 scoreboard/main.py`` locally.
- Scoreboard: generate perf stats (``scripts/run_tests.py --running-type=performance``) and build scoreboard target or use ``python3 scoreboard/main.py`` locally.

Troubleshooting
---------------
Expand All @@ -91,7 +91,7 @@ Troubleshooting
- Time limits exceeded: reduce data sizes; prefer env vars (:doc:`environment_variables`) like ``PPC_TASK_MAX_TIME``/``PPC_PERF_MAX_TIME``; avoid sleeps/randomness.
- MPI runs fail locally: set ``PPC_NUM_PROC`` and try ``--additional-mpi-args=\"--oversubscribe\"``.
- Docs build fails: fix RST warnings; run ``doxygen Doxyfile`` before Sphinx targets.
- Performance job fails: ensure exactly two perf tests (``task`` and ``pipeline``) and keep durations within limits.
- Performance job fails: ensure performance tests are enabled and keep durations within limits.

Local clang-tidy and gcovr examples
-----------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/submit_work.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Tips for tests
--------------
- Keep tests deterministic and under time limits; prefer env vars (see ``User Guide → Environment Variables``) over sleeps.
- Use ``PPC_ID_<task_id>`` to access files from ``data/``.
- Cover edge cases in functional tests; add exactly two performance test styles (``task`` and ``pipeline``) inside the suite.
- Cover edge cases in functional tests; add focused performance tests for enabled implementations.

- ``data/`` — optional input files for tests (e.g., images).
- ``settings.json`` — enable required technologies for your semester, e.g.:
Expand Down
Loading