Skip to content

Commit 7d6efad

Browse files
authored
[doc] Update after benchmark integration (#801)
1 parent 97e205a commit 7d6efad

6 files changed

Lines changed: 35 additions & 36 deletions

File tree

docs/locale/en/LC_MESSAGES/user_guide/ci.po

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ msgstr ""
7171

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

7979
#: ../../../../docs/user_guide/ci.rst:21
@@ -191,9 +191,9 @@ msgstr ""
191191

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

199199
#: ../../../../docs/user_guide/ci.rst:87
@@ -239,8 +239,8 @@ msgstr ""
239239

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

246246
#: ../../../../docs/user_guide/ci.rst:97
@@ -378,4 +378,3 @@ msgstr ""
378378
#~ " or verifying the exact arguments "
379379
#~ "passed to the test binaries."
380380
#~ msgstr ""
381-

docs/locale/en/LC_MESSAGES/user_guide/submit_work.po

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,8 @@ msgstr ""
134134

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

141141
#: ../../../../docs/user_guide/submit_work.rst:105
@@ -431,4 +431,3 @@ msgstr ""
431431
#~ "integration flow used in semester "
432432
#~ "repositories."
433433
#~ msgstr ""
434-

docs/locale/ru/LC_MESSAGES/user_guide/ci.po

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,14 @@ msgstr ""
8787

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

9899
#: ../../../../docs/user_guide/ci.rst:21
99100
msgid ""
@@ -238,13 +239,13 @@ msgstr ""
238239

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

249250
#: ../../../../docs/user_guide/ci.rst:87
250251
msgid "Troubleshooting"
@@ -305,11 +306,11 @@ msgstr ""
305306

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

314315
#: ../../../../docs/user_guide/ci.rst:97
315316
msgid "Local clang-tidy and gcovr examples"

docs/locale/ru/LC_MESSAGES/user_guide/submit_work.po

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,11 +164,11 @@ msgstr "Используйте ``PPC_ID_<task_id>`` для доступа к ф
164164

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

173173
#: ../../../../docs/user_guide/submit_work.rst:105
174174
msgid "``data/`` — optional input files for tests (e.g., images)."

docs/user_guide/ci.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ High‑level pipeline
1616

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

19-
- Performance (perf) — ``scripts/generate_perf_results.sh`` produces ``build/perf_stat_dir``; uploads ``perf-stat`` (Linux) and ``perf-stat-macos`` (macOS).
19+
- 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).
2020

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

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

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

9696
Local clang-tidy and gcovr examples
9797
-----------------------------------

docs/user_guide/submit_work.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Tips for tests
100100
--------------
101101
- Keep tests deterministic and under time limits; prefer env vars (see ``User Guide → Environment Variables``) over sleeps.
102102
- Use ``PPC_ID_<task_id>`` to access files from ``data/``.
103-
- Cover edge cases in functional tests; add exactly two performance test styles (``task`` and ``pipeline``) inside the suite.
103+
- Cover edge cases in functional tests; add focused performance tests for enabled implementations.
104104

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

0 commit comments

Comments
 (0)