Interfaces

WebUI

The WebUI allows users to create and monitor the progress of experiments. It is accessible by visiting http://master-addr:8080, where master-addr is the hostname or IP address where the PEDL master is running.

CLI

Users can also interact with PEDL using a command-line interface. The CLI is distributed as a Python wheel package; once the wheel has been installed (see the installation instructions for details), the CLI can be used via the pedl command.

The CLI should be installed on any machine where a user would like to access PEDL. The -m or --master flag determines the network address of the PEDL master that the CLI connects to. If this flag is not specified, the value of the PEDL_MASTER environment variable is used; if that environment variable is not set, the default address is localhost. The master address can be specified in three different formats:

  • example.org:port (if port is omitted, it defaults to 8080)
  • http://example.org:port (if port is omitted, it defaults to 80)
  • https://example.org:port (if port is omitted, it defaults to 443)

Examples:

# Connect to localhost, port 8080.
$ pedl experiment list

# Connect to example.org, port 8888.
$ pedl -m example.org:8888 e list

# Connect to example.org, port 80.
$ pedl -m http://example.org e list

# Connect to example.org, port 443.
$ pedl -m https://example.org e list

# Connect to example.org, port 8080.
$ pedl -m example.org e list

# Set default PEDL master address to example.org, port 8888.
$ export PEDL_MASTER="example.org:8888"

CLI subcommands usually follow a <noun> <verb> form, similar to the paradigm of ip. Certain abbreviations are supported, and a missing verb is the same as list, when possible.

For example, the different commands within each of the blocks below all do the same thing:

# List all experiments.
$ pedl experiment list
$ pedl exp list
$ pedl e list
$ pedl e
# List all agents.
$ pedl agent list
$ pedl a list
$ pedl a
# List all slots.
$ pedl slot list
$ pedl slot
$ pedl s

For a complete description of the available nouns and abbreviations, see the output of pedl help. Each noun also provides a help verb that describes the possible verbs for that noun.