API Reference
Packages
tensorstack.dev/v1beta1
Package v1beta1 contains API Schema definitions for the v1beta1 API group
Resource Types
HttpDataSource
Details of HTTP data source.
Appears in:
| Field | Description |
|---|---|
url string array | Url pointing to the log files. |
PVCDataSource
Details of PVC data source.
Appears in:
| Field | Description |
|---|---|
name string | PVC name. |
subPath string array | The relative paths of logs in the PVC. |
PodReference
PodReference references to a v1.pod.
Appears in:
| Field | Description |
|---|---|
name string | Name of the Pod. |
uid string | UID of the Pod. |
PodStatus
Pod defines the observed state of a replica.
Appears in:
| Field | Description |
|---|---|
reference PodReference | References to the subordinate v1.Pod. |
phase PodPhase | Replicated from the corresponding field in the subordinate v1.Pod. |
S3DataSource
Details of S3 data source.
Appears in:
| Field | Description |
|---|---|
secretRef SecretRef | S3 data source uses a secret to transmit access/secret key and service enpoint. |
uri string array | S3 object uri. |
SchedulePolicy
SchedulePolicy specifies the preferred scheduler responsible for handling resource allocation requests.
Appears in:
| Field | Description |
|---|---|
t9kScheduler T9kScheduler |
SecretRef
Appears in:
| Field | Description |
|---|---|
name string | Secret name. |
T9kScheduler
Appears in:
| Field | Description |
|---|---|
queue string | Name of the queue to use with the T9kScheduler. |
TensorBoard
TensorBoard is the Schema for the tensorboards API
Appears in:
| Field | Description |
|---|---|
apiVersion string | tensorstack.dev/v1beta1 |
kind string | TensorBoard |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec TensorBoardSpec | |
status TensorBoardStatus |
TensorBoardCondition
TensorBoardCondition defines the observed condition of TensorBoard
Appears in:
| Field | Description |
|---|---|
type TensorBoardConditionType | Type is the type of the condition. Possible values are Idle, etc |
status ConditionStatus | Status is the status of the condition type. Possible values of type Idle are True |
message string | Message is the reason of the status |
lastTransitionTime Time | LastTransitionTime is the last time the status was changed |
lastProbeTime Time | LastProbeTime is the last time the condition was probed |
TensorBoardConditionType
Underlying type: string
Appears in:
TensorBoardDataSource
TensorBoardDataSource represents the location and type of the tensorboard data source. It includes three types of data sources: PVC, S3, and HTTP. In a tensorboard service, these three types of data sources can be used simultaneously.
Appears in:
| Field | Description |
|---|---|
pvc PVCDataSource array | PVC represents PVCs that are mounted to workload as directories to provide log data. |
s3 S3DataSource | S3 represents a s3 service and access/secret key to access the service. |
http HttpDataSource | HTTP provides several urls. |
TensorBoardList
TensorBoardList contains a list of TensorBoard
| Field | Description |
|---|---|
apiVersion string | tensorstack.dev/v1beta1 |
kind string | TensorBoardList |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items TensorBoard array |
TensorBoardPhase
Underlying type: string
Appears in:
TensorBoardSpec
TensorBoardSpec defines the desired state of TensorBoard
Appears in:
| Field | Description |
|---|---|
trainingLogFilesets string array | TrainingLogFilesets is the list of filesets containing training log. The format of fileset: t9k://pvc/[pvc-name]/[subpath] t9k://minio/[secret-name]/[bucket]/[subpath] To be deprecated: Use spec.logDir instead. |
logDir TensorBoardDataSource | LogDir is a series of data source containing training log. |
image string | The container image used to run the tensorboard. |
suspend boolean | suspend specifies whether the TensorBoard controller should delete Pods or not. If true, the associated v1.Pod can be terminated. However, other API resources, such as ConfigMaps and Services, will be preserved for use upon resuming the TensorBoard. Defaults to false. |
scheduler SchedulePolicy | |
resources ResourceRequirements | Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
TensorBoardStatus
TensorBoardStatus defines the observed state of TensorBoard
Appears in:
| Field | Description |
|---|---|
phase TensorBoardPhase | |
pod PodStatus | |
conditions TensorBoardCondition array | Conditions is an array of current conditions |
url string | The URL to Web UI of the tensorboard |