Version v0.5 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.

PyTorchJob

Reference documentation for PyTorchJob

Packages:

kubeflow.org

Package v1beta1 is the v1beta1 version of the API.

Resource Types:

PyTorchJob

PyTorchJob represents the configuration of PyTorchJob

Field Description
apiVersion
string		 kubeflow.org/v1beta1
kind
string 		PyTorchJob
metadata
Kubernetes meta/v1.ObjectMeta

Standard object’s metadata.

Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
PyTorchJobSpec

Specification of the desired behavior of the PyTorchJob.



cleanPodPolicy
common/v1beta1.CleanPodPolicy

CleanPodPolicy defines the policy to kill pods after PyTorchJob is succeeded. Default to Running.
ttlSecondsAfterFinished
int32

TTLSecondsAfterFinished is the TTL to clean up pytorch-jobs (temporary before kubernetes adds the cleanup controller). It may take extra ReconcilePeriod seconds for the cleanup, since reconcile gets called periodically. Default to infinite.
pytorchReplicaSpecs
map[github.com/kubeflow/pytorch-operator/pkg/apis/pytorch/v1beta1.PyTorchReplicaType]*github.com/kubeflow/tf-operator/pkg/apis/common/v1beta1.ReplicaSpec

PyTorchReplicaSpecs is map of PyTorchReplicaType and PyTorchReplicaSpec specifies the PyTorch replicas to run. For example, { “Master”: PyTorchReplicaSpec, “Worker”: PyTorchReplicaSpec, }
status
common/v1beta1.JobStatus

Most recently observed status of the PyTorchJob. This data may not be up to date. Populated by the system. Read-only.

PyTorchJobSpec

(Appears on: PyTorchJob)

PyTorchJobSpec is a desired state description of the PyTorchJob.

Field Description
cleanPodPolicy
common/v1beta1.CleanPodPolicy

CleanPodPolicy defines the policy to kill pods after PyTorchJob is succeeded. Default to Running.
ttlSecondsAfterFinished
int32

TTLSecondsAfterFinished is the TTL to clean up pytorch-jobs (temporary before kubernetes adds the cleanup controller). It may take extra ReconcilePeriod seconds for the cleanup, since reconcile gets called periodically. Default to infinite.
pytorchReplicaSpecs
map[github.com/kubeflow/pytorch-operator/pkg/apis/pytorch/v1beta1.PyTorchReplicaType]*github.com/kubeflow/tf-operator/pkg/apis/common/v1beta1.ReplicaSpec

PyTorchReplicaSpecs is map of PyTorchReplicaType and PyTorchReplicaSpec specifies the PyTorch replicas to run. For example, { “Master”: PyTorchReplicaSpec, “Worker”: PyTorchReplicaSpec, }

PyTorchReplicaType (string alias)

PyTorchReplicaType is the type for PyTorchReplica.

Generated with gen-crd-api-reference-docs on git commit e8d4d04.

Last modified 28.03.2019: Pytorch documentation for v1beta1 and v1beta2 (#545) (fa1af46)