Basic Usage

Benchpark Commands

The easiest way to get started is to run existing experiments one existing systems, or to modify one that is similar. You can search through the existing experiments and benchmarks with the below commands.

Search for available system and experiment specifications in Benchpark.

Searching for specifications in Benchpark

Command	Description	Listing in the docs
benchpark list	Lists all benchmarks and systems specified in Benchpark
benchpark list systems	Lists all system specified in Benchpark	System Specifications
benchmark list benchmarks	Lists all benchmarks specified in Benchpark
benchpark tags workspace	Lists all tags specified in Benchpark
benchpark tags -a application workspace	Lists all tags specified for a given application in Benchpark
benchpark tags -t tag workspace	Lists all experiments in Benchpark with a given tag

Now that you know the existing benchmarks and systems, you can determine your necessary workflow in Benchpark Workflow.

Getting Help

Benchpark help menu:

$ benchpark --help

usage: main.py [-h] [-V]
               {list,tags,system,experiment,setup,unit-test,audit} ...

Benchpark

options:
  -h, --help            show this help message and exit
  -V, --version         show version number and exit

Subcommands:
  {list,tags,system,experiment,setup,unit-test,audit}
    list                List available experiments, systems, and modifiers
    tags                Tags in Benchpark experiments
    system              Initialize a system config
    experiment          Interact with experiments
    setup               Set up an experiment and prepare it to build/run
    unit-test           Run benchpark unit tests
    audit               Look for problems in System/Experiment repos