rics.performance.cli#

Entry point for the performance testing CLI program.

Functions

run([time_per_candidate, name, save_raw])

Run a multivariate performance test.
run(time_per_candidate: float = 2.0, name: Union[str, bytes, PathLike] = 'performance', save_raw: bool = True) → None[source]#

Run a multivariate performance test.

Required files:

  • candidates.py - Public functions are used as candidates.

  • test_data.py - Members whose name start with ‘case_’ are used as test case data.

Hint

Define an ALL-attribute to declare explicit members to use.

Parameters

  • time_per_candidate – Time in seconds to allocate to each candidate function.

  • name – Name to use for artifacts produced. Also used as the figure title (stylized).

  • save_raw – If True, write raw performance data to disk.

Raises

ValueError – If candidates.py or test_data.py are missing or empty.