Overview
In order to schedule runs on Polyaxon, users need to create Polyaxonfiles.
These files use a specification to describe how jobs, distributed jobs, services, parallel executions, and pipelines should run on Polyaxon.
The Polyaxonfile specification can be authored in YAML, json, python, and partially in Go, TypeScript, and Java. This specification is based on a list of sections, in this guide, we describe the required and optional sections.
Primitives
The main primitives that the user will be interacting with are:
- Component: A discrete, repeatable, and self-contained action that defines an environment and a runtime.
- Operation: This is how Polyaxon operationalizes and executes a component by passing parameters, connections, and possibly patch the run environment.
The kind field identifies a Polyaxonfile as a component or an operation.
Starting in v2.18, version is optional. Polyaxon retains a supplied value but does not use it to select a parser or validation schema. Older CLI and server versions may still require version: 1.1.