Introduction

In order to use Polyaxon, users need to create YAML polyaxonfiles. These files use a specification to describe how experiments, experiment groups, jobs, plugins should run on Polyaxon.

The Polyaxon specification is based on a list of sections, in this guide, we describe the required and optional sections.

Note

Polyaxon specification can parse both YAML and Json format.

Experiment Sections

  • version required: defines the version of the file to be parsed and validated.
  • kind required: defines the kind of operation to run: experiment.
  • logging: defines the logging.
  • project required: defines the project name (must be unique).
  • environment: defines the run environment, resources, persistence, and node selectors.
  • declarations: defines variables/modules that can be reused.
  • build required: defines the how the user can set a docker image.
  • run required: defines the how the user can set a command to execute.

Experiment Group Sections

  • version required: defines the version of the file to be parsed and validated.
  • kind required: defines the kind of operation to run: group.
  • logging: defines the logging.
  • project required: defines the project name (must be unique).
  • hptuning required: defines the seed, concurrent runs, search algorithm, early stopping, matrix hyper parameters.
  • environment: defines the run environment, resources, node selectors, and distributed jobs definition.
  • declarations: defines variables/modules that can be reused.
  • build required: defines the how the user can set a docker image.
  • run required: defines the how the user can set a command to execute.

Build Job sections

  • version required: defines the version of the file to be parsed and validated.
  • kind required: defines the kind of operation to run: plugin.
  • project required: defines the project name (must be unique).
  • environment: defines the run environment, resources, persistence, and node selectors.
  • build required: defines the how the user can set a docker image.

Generic Job sections

  • version required: defines the version of the file to be parsed and validated.
  • kind required: defines the kind of operation to run: plugin.
  • project required: defines the project name (must be unique).
  • environment: defines the run environment, resources, persistence, and node selectors.
  • build required: defines the how the user can set a docker image.
  • run required: defines the how the user can set a command to execute.

Tensorboard sections

  • version required: defines the version of the file to be parsed and validated.
  • kind required: defines the kind of operation to run: plugin.
  • project required: defines the project name (must be unique).
  • environment: defines the run environment, resources, persistence, and node selectors.
  • build required: defines the how the user can set a docker image.

Notebook sections

  • version required: defines the version of the file to be parsed and validated.
  • kind required: defines the kind of operation to run: plugin.
  • project required: defines the project name (must be unique).
  • environment: defines the run environment, resources, persistence, and node selectors.
  • build required: defines the how the user can set a docker image.