Skip to content

Commit 2d9564c

Browse files
zhenghuiwangk8s-ci-robot
authored andcommitted
Add metadata API reference doc (kubeflow#1058)
* add metadata API spec * add link to metadata doc page * address comments * remove metadata.md
1 parent d01f2cb commit 2d9564c

File tree

3 files changed

+3827
-2
lines changed

3 files changed

+3827
-2
lines changed

content/docs/components/misc/metadata.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ You can find an example of how to use the logging API in this [notebook](https:/
3838

3939
## Backend
4040

41-
The backend uses [ML-Metadata](https://github.com/google/ml-metadata/blob/master/g3doc/get_started.md) to manage all the metadata and relations. It exposes a [REST API](https://github.com/kubeflow/metadata/blob/master/api/service.swagger.json).
41+
The backend uses [ML-Metadata](https://github.com/google/ml-metadata/blob/master/g3doc/get_started.md) to manage all the metadata and relations. It exposes a [REST API](/docs/reference/metadata/v1alpha1/kubeflow-metadata-api-spec/).
4242

4343
## UI
4444

content/docs/reference/metadata/v1alpha1/kubeflow-metadata-api-spec.html

+3,816
Large diffs are not rendered by default.

content/docs/reference/overview.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight = 1
88
<a id="tfjob">
99
## TFJob
1010

11-
TFJob is a Kubernetes
11+
TFJob is a Kubernetes
1212
[custom resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
1313
that you can use to run TensorFlow training jobs on Kubernetes. For help with
1414
using TFJob with Kubeflow, see the [user guide](/docs/components/tftraining/).
@@ -30,3 +30,12 @@ API references:
3030

3131
* [v1](/docs/reference/pytorchjob/v1/pytorch/)
3232
* [v1beta2](/docs/reference/pytorchjob/v1beta2/pytorch/)
33+
34+
<a id="metadata">
35+
## Metadata
36+
37+
The goal of the [Metadata](https://github.com/kubeflow/metadata) project is to help Kubeflow users understand and manage their machine learning workflows by tracking and managing the metadata of workflows.
38+
39+
API references:
40+
41+
* [v1alpha1](/docs/reference/metadata/v1alpha1/kubeflow-metadata-api-spec/)

0 commit comments

Comments
 (0)