Skip to main content

A fast CLI for submitting and managing Azure ML jobs via pure REST APIs

Project description

Azure Jobs

A fast, lightweight CLI for submitting and managing Azure ML jobs via pure REST APIs. Uses YAML template inheritance, sensible defaults, and rich terminal output. Supports both Azure ML compute clusters and Singularity virtual clusters.

Install

pipx install azure_jobs

For development:

uv pip install -e .

Quick Start

aj ws set                             # configure workspace (interactive)
aj template pull user/templates       # clone shared templates
aj template list                      # show available templates
aj run -t gpu python train.py         # submit a job
aj job list                           # monitor jobs
aj job logs <id>                      # view logs

Commands

Job Submission

aj run -t gpu python train.py       # submit using "gpu" template
aj run python train.py              # re-use last template
aj run -d python train.py           # dry run — inspect config without submitting
aj run -L python train.py           # run locally for testing
Flag Purpose
-t Template name
-n Number of nodes
-p Processes per node
-d Dry run
-y Skip confirmation
-L Run locally

Job Management

aj job list                         # list recent cloud jobs
aj job list -s Running              # filter by status
aj job show <id>                    # show job details
aj job cancel <id>                  # cancel a running job
aj job logs <id>                    # download and display logs
aj list                             # show local submission history

Templates

aj template list                    # list available templates
aj template show <name>             # display resolved config after inheritance
aj template validate                # check all templates for errors
aj template pull <repo>             # clone template repository
aj template push -m "msg"           # commit and push local changes

Workspace & Auth

aj ws list                          # list workspaces in subscription
aj ws set                           # set active workspace (interactive picker)
aj auth status                      # show login and credential status
aj auth login                       # delegate to az login

Resources

aj env list                         # list registered environments
aj env show <name>                  # show environment versions and images
aj ds list                          # list datastores
aj ds show <name>                   # show datastore details
aj quota list                       # show Singularity VC quota and availability
aj quota list --aml                 # show AML compute cluster availability
aj exp list                         # list experiments (aggregated from jobs)
aj image list                       # list Singularity curated base images

Other

aj config show                      # print all configuration
aj config timezone Asia/Shanghai    # set display timezone
aj dash                             # open interactive TUI dashboard

How It Works

  1. Templates define reusable job configs as YAML with optional base inheritance
  2. aj run loads a template, resolves the inheritance chain, merges configs, and applies CLI overrides
  3. Code upload — zips your code, uploads to workspace blob storage, and registers a code asset
  4. Environment — registers Docker images as Azure ML environment versions (with SHA-based dedup)
  5. Submission — builds a REST job body and submits via PUT /jobs/{name} to Azure Resource Manager
  6. Tracking — records each submission locally to record.jsonl and prints the portal URL

No dependency on amlt or the azure-ai-ml SDK. All Azure interactions use lightweight REST APIs with AzureCliCredential.

Documentation

Document Contents
Architecture Module layout, data flow, design decisions
Configuration Templates, inheritance, merge rules, environment variables
REST API REST client design, endpoints, authentication
Roadmap Planned features and milestones

Testing

uv run pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

azure_jobs-0.1.19.tar.gz (155.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

azure_jobs-0.1.19-py3-none-any.whl (97.6 kB view details)

Uploaded Python 3

File details

Details for the file azure_jobs-0.1.19.tar.gz.

File metadata

  • Download URL: azure_jobs-0.1.19.tar.gz
  • Upload date:
  • Size: 155.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for azure_jobs-0.1.19.tar.gz
Algorithm Hash digest
SHA256 edef99ac49c7dac94b2e089067d059a8dcbf08c13b5c9084a1b47a42e3898b25
MD5 1f4e661d0c0075342682c4b34a089e5e
BLAKE2b-256 7e054596fbae8b24a01f2c3e6e82687119349eb456fae6a02c4101ba67bf718e

See more details on using hashes here.

Provenance

The following attestation bundles were made for azure_jobs-0.1.19.tar.gz:

Publisher: release.yml on HSPK/azure_jobs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file azure_jobs-0.1.19-py3-none-any.whl.

File metadata

  • Download URL: azure_jobs-0.1.19-py3-none-any.whl
  • Upload date:
  • Size: 97.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for azure_jobs-0.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 21d9bad9315b9d52d161ff00f676e03d11d6d62b641cebd8b63f48bda492db2c
MD5 d963d4af058b5f1d54d9cef4fbbe2673
BLAKE2b-256 fcb8c7268cf176dfde6838603e0d1e5603f771cf972d01f5f2016d3fa4e8e0fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for azure_jobs-0.1.19-py3-none-any.whl:

Publisher: release.yml on HSPK/azure_jobs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page