API Reference

Packages

• batch.tensorstack.dev/v1beta1

batch.tensorstack.dev/v1beta1

Package v1beta1 contains API Schema definitions for the batch v1beta1 API group

Resource Types

• XGBoostTrainingJob
• XGBoostTrainingJobList

ReplicaSpec

ReplicaSpec outlines the intended configuration and execution parameters for a XGBoostTrainingJob.

Appears in: - XGBoostTrainingJobSpec

Field	Description
type ReplicaType	ReplicaType is the type of the replica, one of "master" or "worker".
replicas integer	The desired number of replicas of the current template. If unspecified, defaults to 1.
template PodTemplateSpec	Describes the pod that will be created for this replica. Note that RestartPolicy in PodTemplateSpec will always be set to Never as the job controller will decide if restarts are desired.
restartPolicy RestartPolicy	Restart policy for all replicas within the job. One of Always, OnFailure, Never, or ExitCode. Defaults to OnFailure.

ReplicaType

Underlying type: string

ReplicaType is the type of the replica, one of "master" or "worker".

Appears in: - ReplicaSpec

XGBoostTrainingJob

Appears in: - XGBoostTrainingJobList

Field	Description
apiVersion string	batch.tensorstack.dev/v1beta1
kind string	XGBoostTrainingJob
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec XGBoostTrainingJobSpec
status XGBoostTrainingJobStatus

XGBoostTrainingJobList

XGBoostTrainingJobList contains a list of XGBoostTrainingJob.

Field	Description
apiVersion string	batch.tensorstack.dev/v1beta1
kind string	XGBoostTrainingJobList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items XGBoostTrainingJob array

XGBoostTrainingJobSpec

Appears in: - XGBoostTrainingJob

Field	Description
replicaSpecs ReplicaSpec array	An array of ReplicaSpec. Specifies the XGBoost replica configurations.
runMode RunMode	Job's execution behavior. If omitted, defaults to Immediate mode, and tasks are executed immediately upon submission.
runPolicy RunPolicy	Execution policy configurations governing the behavior of the XGBoostTrainingJob.
scheduler SchedulePolicy	Identifies the preferred scheduler for allocating resources to replicas. Defaults to cluster default scheduler.

XGBoostTrainingJobStatus

XGBoostTrainingJobStatus defines the observed state of XGBoostTrainingJob.

Appears in: - XGBoostTrainingJob

Field	Description
tasks Tasks array	The status details of individual tasks.
backoffCount integer	The number of restarts being performed.
aggregate Aggregate
conditions JobCondition array	The latest available observations of an object's current state.
phase JobPhase	Provides a simple, high-level summary of where the Job is in its lifecycle. Note that this is NOT indended to be a comprehensive state machine.