Skip to content

Commit cf2565c

Browse files
Unify benchmark documentation navigation
Integrate the micro-benchmark guide with the CLI-first user guide and advanced framework reference, and make the intended reader path explicit.
2 parents ab2800b + 9480203 commit cf2565c

93 files changed

Lines changed: 13544 additions & 1714 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../skills/developer/isaaclab-updating-environment-docs

.github/actions/multi-gpu/multi_gpu_shard_runner.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ mkdir -p /tmp/mgpu-base-home /tmp/mgpu-pyuserbase
4949

5050
# Pytest deps (same as run-tests action). junitparser is imported at
5151
# tools/conftest.py load time, so it must be present first.
52-
./isaaclab.sh -p -m pip install pytest pytest-mock junitparser flatdict flaky "coverage>=7.6.1"
52+
./isaaclab.sh -p -m pip install pytest pytest-mock junitparser flaky "coverage>=7.6.1"
5353

5454
# Shard count from nvidia-smi -L (truth; torch under-counts MIG).
5555
MIG_COUNT=$(nvidia-smi -L | grep -c "^ MIG ") # grep -c = count of matching lines (MIG slices)

.github/actions/run-tests/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ runs:
396396
# set this detect-only flag, which makes cold asset downloads
397397
# fall back to slow repeated retries.
398398
unset HUB__ARGS__DETECT_ONLY
399-
./isaaclab.sh -p -m pip install pytest pytest-mock junitparser flatdict flaky \"coverage>=7.6.1\"
399+
./isaaclab.sh -p -m pip install pytest pytest-mock junitparser flaky \"coverage>=7.6.1\"
400400
if [ -n \"\${TEST_WHEELHOUSE_PACKAGES:-}\" ]; then
401401
if [ ! -d \"\${TEST_WHEELHOUSE_PATH:-}\" ]; then
402402
echo \"Wheelhouse path is missing: \${TEST_WHEELHOUSE_PATH:-}\"

.github/workflows/docs.yaml

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -118,10 +118,9 @@ jobs:
118118
git for-each-ref --format="%(refname:short)" refs/heads/ | xargs -r git branch -D
119119
make multi-docs
120120
121-
- name: Upload docs artifact
122-
uses: actions/upload-artifact@v7
121+
- name: Upload GitHub Pages artifact
122+
uses: actions/upload-pages-artifact@v4
123123
with:
124-
name: docs-html
125124
path: ./docs/_build
126125

127126
deploy-docs:
@@ -131,16 +130,15 @@ jobs:
131130
# deploy only on "deploy" branches
132131
if: needs.doc-build-type.outputs.trigger-deploy == 'true'
133132

134-
steps:
135-
- name: Download docs artifact
136-
uses: actions/download-artifact@v8
137-
with:
138-
name: docs-html
139-
path: ./docs/_build
133+
permissions:
134+
pages: write
135+
id-token: write
140136

141-
- name: Deploy to gh-pages
142-
uses: peaceiris/actions-gh-pages@v4
143-
with:
144-
github_token: ${{ secrets.GITHUB_TOKEN }}
145-
publish_dir: ./docs/_build
146-
keep_files: false
137+
environment:
138+
name: github-pages
139+
url: ${{ steps.deployment.outputs.page_url }}
140+
141+
steps:
142+
- name: Deploy GitHub Pages
143+
id: deployment
144+
uses: actions/deploy-pages@v4

.github/workflows/install-ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ jobs:
6060
$'^\\.github/workflows/install-ci\\.yml$\tThis workflow file'
6161
$'^VERSION$\tVersion file'
6262
$'(^|/)pyproject\\.toml$\tPython project metadata'
63+
$'^uv\\.lock$\tuv lockfile'
6364
$'(^|/)environment\\.ya?ml$\tConda environment file'
6465
)
6566
143 KB
Loading
137 KB
Loading
201 KB
Loading

docs/source/overview/environments.rst

Lines changed: 452 additions & 486 deletions
Large diffs are not rendered by default.

docs/source/testing/benchmark_framework.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,9 @@ Isolate One Method Or Sensor
464464
:class:`~isaaclab.benchmark.MethodBenchmarkRunner` builds on the base class to
465465
repeat one method or property across input modes, warm-up steps, and instance
466466
counts. It is the common bridge used by the asset micro-benchmarks. Sensor
467-
benchmarks use live scenes and their own correctness and timing boundaries.
467+
benchmarks use live scenes, :func:`~isaaclab.benchmark.measure_latency` for
468+
paired timing boundaries, and
469+
:class:`~isaaclab.benchmark.LatencyBenchmarkRunner` for structured output.
468470

469471
Do not infer end-to-end environment or training throughput from either kind of
470472
isolated result. The command matrix, backend prerequisites, mock-versus-live

0 commit comments

Comments
 (0)