mxjobs.md

title	date	weight	description
Run a MXJob	2023-10-09	6	Run a Kueue scheduled MXJob

This page shows how to leverage Kueue's scheduling and resource management capabilities when running Training Operator MXJobs.

This guide is for batch users that have a basic understanding of Kueue. For more information, see Kueue's overview.

Before you begin

Check administer cluster quotas for details on the initial cluster setup.

Check the Training Operator installation guide.

Note that the minimum requirement training-operator version is v1.7.0.

You can modify kueue configurations from installed releases to include MXJobs as an allowed workload.

MXJob definition

a. Queue selection

The target local queue should be specified in the metadata.labels section of the MXJob configuration.

metadata:
  labels:
    kueue.x-k8s.io/queue-name: user-queue

b. Optionally set Suspend field in MXJobs

spec:
  runPolicy:
    suspend: true

By default, Kueue will set suspend to true via webhook and unsuspend it when the MXJob is admitted.

Sample MXJob

This example is based on https://github.com/kubeflow/training-operator/blob/a4c0cec561a4bfe478720f1a102f305ed656071b/examples/mxnet/mxjob_dist_v1.yaml.

{{< include "examples/jobs/sample-mxjob.yaml" "yaml" >}}