Kubeflow – TFJob v1beta2

Docs: TFJob Common

Mon, 01 Jan 0001 00:00:00 +0000

Out of date

This guide contains outdated information pertaining to Kubeflow 1.0. This guide needs to be updated for Kubeflow 1.1.

Packages:

kubeflow.org

kubeflow.org

Package v1beta2 is the v1beta2 version of the API.

Resource Types:

CleanPodPolicy (`string` alias)

CleanPodPolicy describes how to deal with pods when the job is finished.

JobCondition

(Appears on: JobStatus)

JobCondition describes the state of the job at a certain point.

Field	Description
`type` JobConditionType	Type of job condition.
`status` Kubernetes core/v1.ConditionStatus	Status of the condition, one of True, False, Unknown.
`reason` string	The reason for the condition’s last transition.
`message` string	A human readable message indicating details about the transition.
`lastUpdateTime` Kubernetes meta/v1.Time	The last time this condition was updated.
`lastTransitionTime` Kubernetes meta/v1.Time	Last time the condition transitioned from one status to another.

JobConditionType (`string` alias)

(Appears on: JobCondition)

JobConditionType defines all kinds of types of JobStatus.

JobStatus

JobStatus represents the current observed state of the training Job.

Field	Description
`conditions` [][]github.com/kubeflow/tf-operator/pkg/apis/common/v1beta2.JobCondition	Conditions is an array of current observed job conditions.
`replicaStatuses` map[github.com/kubeflow/tf-operator/pkg/apis/common/v1beta2.ReplicaType]github.com/kubeflow/tf-operator/pkg/apis/common/v1beta2.ReplicaStatus*	ReplicaStatuses is map of ReplicaType and ReplicaStatus, specifies the status of each replica.
`startTime` Kubernetes meta/v1.Time	Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
`completionTime` Kubernetes meta/v1.Time	Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.
`lastReconcileTime` Kubernetes meta/v1.Time	Represents last time when the job was reconciled. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

ReplicaSpec

ReplicaSpec is a description of the replica

Field	Description
`replicas` int32	Replicas is the desired number of replicas of the given template. If unspecified, defaults to 1.
`template` Kubernetes core/v1.PodTemplateSpec	Template is the object that describes the pod that will be created for this replica. RestartPolicy in PodTemplateSpec will be overide by RestartPolicy in ReplicaSpec
`restartPolicy` RestartPolicy	Restart policy for all replicas within the job. One of Always, OnFailure, Never and ExitCode. Default to Never.

ReplicaStatus

(Appears on: JobStatus)

ReplicaStatus represents the current observed state of the replica.

Field	Description
`active` int32	The number of actively running pods.
`succeeded` int32	The number of pods which reached phase Succeeded.
`failed` int32	The number of pods which reached phase Failed.

ReplicaType (`string` alias)

ReplicaType represents the type of the replica. Each operator needs to define its own set of ReplicaTypes.

RestartPolicy (`string` alias)

(Appears on: ReplicaSpec)

RestartPolicy describes how the replicas should be restarted. Only one of the following restart policies may be specified. If none of the following policies is specified, the default one is RestartPolicyAlways.

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

Docs: TFJob TensorFlow

Mon, 01 Jan 0001 00:00:00 +0000

Out of date

This guide contains outdated information pertaining to Kubeflow 1.0. This guide needs to be updated for Kubeflow 1.1.

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 fd76deec.

Kubeflow – TFJob v1beta2

Docs: TFJob Common

Out of date

kubeflow.org

CleanPodPolicy (string alias)

JobCondition

JobConditionType (string alias)

JobStatus

ReplicaSpec

ReplicaStatus

ReplicaType (string alias)

RestartPolicy (string alias)

Docs: TFJob TensorFlow

Out of date

kubeflow.org

TFJob

TFJobSpec

TFReplicaType (string alias)

CleanPodPolicy (`string` alias)

JobConditionType (`string` alias)

ReplicaType (`string` alias)

RestartPolicy (`string` alias)

TFReplicaType (`string` alias)