mxnet_generated.asciidoc

API Reference

Packages

• kubeflow.org/v1

kubeflow.org/v1

Package v1 is the v1 version of the API.

Package v1 contains API Schema definitions for the kubeflow.org v1 API group

Resource Types

• MXJob

• MXJobList

Definitions

JobModeType (string)

JobModeType id the type for JobMode

Appears In:

• MXJobSpec

MXJob

MXJob is the Schema for the mxjobs API

Appears In:

• MXJobList

Field	Description
apiVersion string	kubeflow.org/v1
kind string	MXJob
TypeMeta TypeMeta
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec MXJobSpec
status JobStatus

MXJobList

MXJobList contains a list of MXJob

Field	Description
apiVersion string	kubeflow.org/v1
kind string	MXJobList
TypeMeta TypeMeta
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items MXJob

MXJobSpec

MXJobSpec defines the desired state of MXJob

Appears In:

• MXJob

Field	Description
runPolicy RunPolicy	RunPolicy encapsulates various runtime policies of the distributed training job, for example how to clean up resources and how long the job can stay active.
jobMode JobModeType	JobMode specify the kind of MXjob to do. Different mode may have different MXReplicaSpecs request
mxReplicaSpecs object (keys:ReplicaType, values:ReplicaSpec)	MXReplicaSpecs is map of common.ReplicaType and common.ReplicaSpec specifies the MX replicas to run. For example, { "Scheduler": common.ReplicaSpec, "Server": common.ReplicaSpec, "Worker": common.ReplicaSpec, }