mirror of
https://github.com/hanzo-ml/trainer.git
synced 2026-09-24 00:31:34 +00:00
Andrey VelichkevichandGitHub
a6aec1b7b9
* Update links and corresponding files for training-operator repository Use Go 1.17 * Generate SDK * Remove Travis * Modify developer guide * Fix go mod * Fix legacy docs * Generate SDK * Remove travis * Update ignore files
100 lines
3.6 KiB
Plaintext
100 lines
3.6 KiB
Plaintext
// Generated documentation. Please do not edit.
|
|
:anchor_prefix: k8s-api
|
|
|
|
[id="{p}-api-reference"]
|
|
= API Reference
|
|
|
|
.Packages
|
|
- xref:{anchor_prefix}-kubeflow-org-v1[$$kubeflow.org/v1$$]
|
|
|
|
|
|
[id="{anchor_prefix}-kubeflow-org-v1"]
|
|
== 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
|
|
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]
|
|
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjoblist[$$MXJobList$$]
|
|
|
|
|
|
=== Definitions
|
|
|
|
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-jobmodetype"]
|
|
==== JobModeType (string)
|
|
|
|
JobModeType id the type for JobMode
|
|
|
|
.Appears In:
|
|
****
|
|
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjobspec[$$MXJobSpec$$]
|
|
****
|
|
|
|
|
|
|
|
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjob"]
|
|
==== MXJob
|
|
|
|
MXJob is the Schema for the mxjobs API
|
|
|
|
.Appears In:
|
|
****
|
|
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjoblist[$$MXJobList$$]
|
|
****
|
|
|
|
[cols="25a,75a", options="header"]
|
|
|===
|
|
| Field | Description
|
|
| *`apiVersion`* __string__ | `kubeflow.org/v1`
|
|
| *`kind`* __string__ | `MXJob`
|
|
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ |
|
|
| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.
|
|
|
|
| *`spec`* __xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjobspec[$$MXJobSpec$$]__ |
|
|
| *`status`* __xref:{anchor_prefix}-github-com-kubeflow-common-pkg-apis-common-v1-jobstatus[$$JobStatus$$]__ |
|
|
|===
|
|
|
|
|
|
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjoblist"]
|
|
==== MXJobList
|
|
|
|
MXJobList contains a list of MXJob
|
|
|
|
|
|
|
|
[cols="25a,75a", options="header"]
|
|
|===
|
|
| Field | Description
|
|
| *`apiVersion`* __string__ | `kubeflow.org/v1`
|
|
| *`kind`* __string__ | `MXJobList`
|
|
| *`TypeMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#typemeta-v1-meta[$$TypeMeta$$]__ |
|
|
| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.
|
|
|
|
| *`items`* __xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]__ |
|
|
|===
|
|
|
|
|
|
[id="{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjobspec"]
|
|
==== MXJobSpec
|
|
|
|
MXJobSpec defines the desired state of MXJob
|
|
|
|
.Appears In:
|
|
****
|
|
- xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-mxjob[$$MXJob$$]
|
|
****
|
|
|
|
[cols="25a,75a", options="header"]
|
|
|===
|
|
| Field | Description
|
|
| *`runPolicy`* __xref:{anchor_prefix}-github-com-kubeflow-common-pkg-apis-common-v1-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.
|
|
| *`jobMode`* __xref:{anchor_prefix}-github-com-kubeflow-training-operator-pkg-apis-mxnet-v1-jobmodetype[$$JobModeType$$]__ | JobMode specify the kind of MXjob to do. Different mode may have different MXReplicaSpecs request
|
|
| *`mxReplicaSpecs`* __object (keys:ReplicaType, values:ReplicaSpec)__ | MXReplicaSpecs is map of common.ReplicaType and common.ReplicaSpec specifies the MX replicas to run. For example, { "Scheduler": common.ReplicaSpec, "Server": common.ReplicaSpec, "Worker": common.ReplicaSpec, }
|
|
|===
|
|
|
|
|
|
|
|
|