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.
Since Polyaxon 2.18.0, components, operations, and files without kind accept the same fields, and kind and version are optional:
kind: componentmarks a reusable component. When you run it with the CLI or the Python client, Polyaxon wraps it in an operation, so-ffiles and run options apply on top of it.- With
kind: operation, or withoutkind, the file is the operation that runs, and-ffiles merge into it. - Polyaxon keeps supplied
kindandversionvalues.versiondoes not select a parser or validation schema.
Older CLI and server versions require kind and version: 1.1.
Root shortcuts such as container, cmd, and resources set common run fields without a nested run section.