Job

The job commands accept 2 optional arguments:

  • Job: --job or -j to use a specific job.
  • Project: --project or -p to use a specific project.

If no project/job is provided, the command will default to the currently initialized project/last used job.

If no project/job is provided and no project/job is cached, the command will raise an error.

Usage:

polyaxon job [OPTIONS] COMMAND [ARGS]...

Commands for jobs.

Options:

option type description
-p, --project TEXT The project name, e.g. 'mnist' or 'adam/mnist'.
-j, --job INTEGER The job id.
--help Show this message and exit.

get

Usage:

$ polyaxon job get

Get job.

Uses Caching

Examples:

$ polyaxon job --job=1 get
$ polyaxon job -j 1 --project=project_name get

stop

Usage:

$ polyaxon job stop

Stop job.

Uses Caching

Examples:

$ polyaxon job stop
$ polyaxon job -j 2 stop

Options:

option type description
-y, --yes Flag Automatic yes to prompts. Assume "yes" as answer to all prompts and run non-interactively.
--help Show this message and exit.

update

Usage:

polyaxon job update [OPTIONS]

Update job.

Uses Caching

Example:

$ polyaxon job -j 2 update --description="new description for my job"

Options:

option type description
--name TEXT Name of the job, must be unique within the project, could none.
--description TEXT Description of the job.
--tags TEXT Tags of the job, comma separated values.
--help Show this message and exit.

delete

Usage:

$ polyaxon job delete

Delete job.

Uses Caching

Example:

$ polyaxon job delete
$ polyaxon job -j 2 delete

restart

Usage:

$ polyaxon job restart

Restart job.

Uses Caching

Examples:

$ polyaxon job --job=1 restart

Options:

option type description
-c, --copy To copy the job before restarting.
-f, --file PATH The polyaxon files to update with.
-u To upload the repo before restarting.
--help Show this message and exit.

logs

Usage:

$ polyaxon job logs

Get job logs.

Uses Caching

Examples:

$ polyaxon job -j 2 logs
$ polyaxon job logs --past --follow

Options:

option type description
--past Show the past logs.
--follow Stream logs after showing past logs.
--help Show this message and exit.

resources

Usage:

$ polyaxon job resources

Usage: polyaxon job resources [OPTIONS]

Get job resources.

Uses Caching

Examples:

$ polyaxon job -j 2 resources

For GPU resources

$ polyaxon job -j 2 resources --gpu

Options:

option type description
-g, --gpu Flag List experiment GPU resources.
--help Show this message and exit.

statuses

Usage:

$ polyaxon job statuses

Get job statuses.

Uses Caching

Examples:

$ polyaxon job -j 2 statuses

Options:

option type description
--page INTEGER To paginate through the list of statuses.
--help Show this message and exit.

outputs

Usage:

$ polyaxon job outputs [OPTIONS]

Download outputs for job.

Uses Caching

Examples:

$ polyaxon job -xp 1 outputs

bookmark

Usage:

$ polyaxon job bookmark

Bookmark job.

Uses Caching

Examples:

$ polyaxon job bookmark
$ polyaxon job -j 2 bookmark

unbookmark

Usage:

$ polyaxon job unbookmark

Unbookmark job.

Uses Caching

Examples:

$ polyaxon job unbookmark
$ polyaxon job -j 2 unbookmark