Skip to content

Commit a218391

Browse files
Rewrite advanced benchmark framework guide
Lead with the supported typed Python workflows, document verified request and result contracts, and provide an executable lower-level extension example. Align API reference coverage and testing navigation with the three-part benchmark journey.
1 parent e6eeb54 commit a218391

5 files changed

Lines changed: 451 additions & 1204 deletions

File tree

docs/source/api/lab/isaaclab.benchmark.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,39 @@ isaaclab.benchmark
3434
MethodBenchmarkDefinition
3535
MethodBenchmarkRunner
3636
MethodBenchmarkRunnerConfig
37+
38+
.. rubric:: Measurements and metadata
39+
40+
.. autosummary::
41+
42+
BooleanMeasurement
43+
DictMeasurement
44+
DictMetadata
45+
FloatMetadata
46+
IntMetadata
47+
ListMeasurement
48+
Measurement
49+
MetadataBase
50+
SingleMeasurement
51+
StatisticalMeasurement
52+
StringMetadata
53+
TestPhase
54+
55+
.. rubric:: Result schema
56+
57+
.. autosummary::
58+
59+
EnvironmentStepTiming
60+
Learning
61+
LearningCurve
62+
MeanStd
3763
PlayBundle
64+
Resources
65+
RunConfig
66+
RunIdentity
67+
Runtime
3868
RuntimeBundle
3969
StartupBundle
70+
StartupPhase
71+
StartupTime
4072
TrainingBundle

0 commit comments

Comments
 (0)