mpi_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

• MPIJob

• MPIJobList

Definitions

MPIJob

Appears In:

• MPIJobList

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

MPIJobList

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

MPIJobSpec

Appears In:

• MPIJob

Field	Description
slotsPerWorker integer	Specifies the number of slots per worker used in hostfile. Defaults to 1.
cleanPodPolicy CleanPodPolicy	CleanPodPolicy defines the policy that whether to kill pods after the job completes. Defaults to None.
mpiReplicaSpecs object (keys:ReplicaType, values:ReplicaSpec)	MPIReplicaSpecs contains maps from MPIReplicaType to ReplicaSpec that specify the MPI replicas to run.
mainContainer string	MainContainer specifies name of the main container which executes the MPI code.
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.