TFJob TensorFlow

Reference documentation for TFJob

Packages:

kubeflow.org

Package v1 is the v1 version of the API.

Resource Types:

TFJob

Represents a TFJob resource.

FieldDescription
apiVersionstring kubeflow.org/v1
kindstringTFJob
metadataKubernetes meta/v1.ObjectMeta Standard Kubernetes object’s metadata. Refer to the Kubernetes API documentation for the fields of themetadata field.
specTFJobSpec Specification of the desired state of the TFJob.
activeDeadlineSecondsint64(Optional) Specifies the duration (in seconds) since startTime during which the job can remain activebefore it is terminated. Must be a positive integer.This setting applies only to pods where restartPolicy is OnFailure or Always.
backoffLimitint32(Optional) Number of retries before marking this job as failed.
cleanPodPolicycommon/v1.CleanPodPolicy Defines the policy for cleaning up pods after the TFJob completes.Defaults to Running.
ttlSecondsAfterFinishedint32 Defines the TTL for cleaning up finished TFJobs (temporarybefore kubernetes adds the cleanup controller).It may take extra ReconcilePeriod seconds for the cleanup, sincereconcile gets called periodically.Defaults to infinite.
tfReplicaSpecsmap[github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1.TFReplicaType]*github.com/kubeflow/tf-operator/pkg/apis/common/v1.ReplicaSpec A map of TFReplicaType (type) to ReplicaSpec (value). Specifies the TF cluster configuration.For example,{“PS”: ReplicaSpec,“Worker”: ReplicaSpec,}

statuscommon/v1.JobStatus Most recently observed status of the TFJob.Read-only (modified by the system).

TFJobSpec

(Appears on:TFJob)

TFJobSpec is a desired state description of the TFJob.

FieldDescription
activeDeadlineSecondsint64(Optional) Specifies the duration (in seconds) since startTime during which the job can remain activebefore it is terminated. Must be a positive integer.This setting applies only to pods where restartPolicy is OnFailure or Always.
backoffLimitint32(Optional) Number of retries before marking this job as failed.
cleanPodPolicycommon/v1.CleanPodPolicy Defines the policy for cleaning up pods after the TFJob completes.Defaults to Running.
ttlSecondsAfterFinishedint32 Defines the TTL for cleaning up finished TFJobs (temporarybefore kubernetes adds the cleanup controller).It may take extra ReconcilePeriod seconds for the cleanup, sincereconcile gets called periodically.Defaults to infinite.
tfReplicaSpecsmap[github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1.TFReplicaType]*github.com/kubeflow/tf-operator/pkg/apis/common/v1.ReplicaSpec A map of TFReplicaType (type) to ReplicaSpec (value). Specifies the TF cluster configuration.For example,{“PS”: ReplicaSpec,“Worker”: ReplicaSpec,}

TFReplicaType(string alias)

TFReplicaType is the type for TFReplica. Can be one of: “Chief”/“Master” (semantically equivalent),“Worker”, “PS”, or “Evaluator”.

Generated with gen-crd-api-reference-docson git commit fd76deec.