TFJob TensorFlow

Reference documentation for TFJob

Packages:

kubeflow.org

Package v1beta2 is the v1beta2 version of the API.

Resource Types:

TFJob represents the configuration of signal TFJob

Field Description

apiVersionstring kubeflow.org/v1beta2

kindstring TFJob

metadataKubernetes meta/v1.ObjectMeta Standard object’s metadata.Refer to the Kubernetes API documentation for the fields of themetadata field.

specTFJobSpec

Specification of the desired behavior of the TFJob.

`activeDeadlineSeconds`int64	(Optional)Specifies the duration in seconds relative to the startTime that the job may be activebefore the system tries to terminate it; value must be positive integer.This method applies only to pods with restartPolicy == OnFailure or Always.
`backoffLimit`int32	(Optional)Optional number of retries before marking this job failed.
`cleanPodPolicy`common/v1beta2.CleanPodPolicy	CleanPodPolicy defines the policy to kill pods after TFJob issucceeded.Default to Running.
`ttlSecondsAfterFinished`int32	TTLSecondsAfterFinished is the TTL to clean up tf-jobs (temporarybefore kubernetes adds the cleanup controller).It may take extra ReconcilePeriod seconds for the cleanup, sincereconcile gets called periodically.Default to infinite.
`tfReplicaSpecs`map[github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1beta2.TFReplicaType]github.com/kubeflow/tf-operator/pkg/apis/common/v1beta2.ReplicaSpec*	TFReplicaSpecs is map of TFReplicaType and ReplicaSpecspecifies the TF replicas to run.For example,{“PS”: ReplicaSpec,“Worker”: ReplicaSpec,}

statuscommon/v1beta2.JobStatus Most recently observed status of the TFJob.This data may not be up to date.Populated by the system.Read-only.

(Appears on:TFJob)

TFJobSpec is a desired state description of the TFJob.

Field	Description
`activeDeadlineSeconds`int64	(Optional)Specifies the duration in seconds relative to the startTime that the job may be activebefore the system tries to terminate it; value must be positive integer.This method applies only to pods with restartPolicy == OnFailure or Always.
`backoffLimit`int32	(Optional)Optional number of retries before marking this job failed.
`cleanPodPolicy`common/v1beta2.CleanPodPolicy	CleanPodPolicy defines the policy to kill pods after TFJob issucceeded.Default to Running.
`ttlSecondsAfterFinished`int32	TTLSecondsAfterFinished is the TTL to clean up tf-jobs (temporarybefore kubernetes adds the cleanup controller).It may take extra ReconcilePeriod seconds for the cleanup, sincereconcile gets called periodically.Default to infinite.
`tfReplicaSpecs`map[github.com/kubeflow/tf-operator/pkg/apis/tensorflow/v1beta2.TFReplicaType]github.com/kubeflow/tf-operator/pkg/apis/common/v1beta2.ReplicaSpec*	TFReplicaSpecs is map of TFReplicaType and ReplicaSpecspecifies the TF replicas to run.For example,{“PS”: ReplicaSpec,“Worker”: ReplicaSpec,}

TFReplicaType is the type for TFReplica.

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

Was this page helpful?

Sorry to hear that. Please tell us how we can improve.