API Reference

Packages

kubeflow.org/v1

Package v1 is the v1 version of the API.

Package v1 contains API Schema definitions for the kubeflow.org v1 API group

Resource Types

TFJob represents a TFJob resource.

Appears In:

Field	Description
`apiVersion` string	`kubeflow.org/v1`
`kind` string	`TFJob`
`TypeMeta` TypeMeta	Standard Kubernetes type metadata.
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` TFJobSpec	Specification of the desired state of the TFJob.
`status` JobStatus	Most recently observed status of the TFJob. Populated by the system. Read-only.

TFJobList is a list of TFJobs.

Field	Description
`apiVersion` string	`kubeflow.org/v1`
`kind` string	`TFJobList`
`TypeMeta` TypeMeta	Standard type metadata.
`metadata` ListMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`items` TFJob	List of TFJobs.

TFJobSpec is a desired state description of the TFJob.

Appears In:

Field	Description
`runPolicy` RunPolicy	RunPolicy encapsulates various runtime policies of the distributed training job, for example how to clean up resources and how long the job can stay active.
`successPolicy` SuccessPolicy	SuccessPolicy defines the policy to mark the TFJob as succeeded. Default to "", using the default rules.
`tfReplicaSpecs` object (keys:ReplicaType, values:ReplicaSpec)	A map of TFReplicaType (type) to ReplicaSpec (value). Specifies the TF cluster configuration. For example, { "PS": ReplicaSpec, "Worker": ReplicaSpec, }
`enableDynamicWorker` boolean	A switch to enable dynamic worker