website/content/docs/reference/tfjob/v1beta2/tensorflow.md

+++ title = "TFJob TensorFlow" description = "Reference documentation for TFJob" weight = 100 +++

Packages:

• kubeflow.org

kubeflow.org

Package v1beta2 is the v1beta2 version of the API.

Resource Types:

• TFJob

TFJob

TFJob represents the configuration of signal TFJob

Field	Description
apiVersion string	kubeflow.org/v1beta2
kind string	TFJob
metadata Kubernetes meta/v1.ObjectMeta	Standard object’s metadata. Refer to the Kubernetes API documentation for the fields of the metadata field.
spec TFJobSpec	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 active before 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 is succeeded. Default to Running. ttlSecondsAfterFinished int32 TTLSecondsAfterFinished is the TTL to clean up tf-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. 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 ReplicaSpec specifies the TF replicas to run. For example, { “PS”: ReplicaSpec, “Worker”: ReplicaSpec, }
status common/v1beta2.JobStatus	Most recently observed status of the TFJob. This data may not be up to date. Populated by the system. Read-only.

TFJobSpec

(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 active before 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 is succeeded. Default to Running.
ttlSecondsAfterFinished int32	TTLSecondsAfterFinished is the TTL to clean up tf-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.
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 ReplicaSpec specifies the TF replicas to run. For example, { “PS”: ReplicaSpec, “Worker”: ReplicaSpec, }

TFReplicaType (string alias)

TFReplicaType is the type for TFReplica.

---

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