Update metadata doc section for KF 1.0 #1641
Conversation
zhenghuiwang
changed the title
zhenghuiwang
requested review from
sarahmaddox,
jinchihe and
neuromage
and removed request for
inc0 and
jinchihe
zhenghuiwang
changed the title
There was a problem hiding this comment.
I'll leave this to @joeliedtke for a full review. Just adding a couple of comments for your attention.
|
/assign @joeliedtke |
|
Fixes #1651 |
content/docs/components/metadata.md
Outdated
| --header "Content-Type: application/json" -d \ | ||
| '{"name":"myorg/mytype/v1","properties":{"f1":"STRING", "f2":"INT", "f3": "DOUBLE"}}' | ||
| ``` | ||
| Kubeflow metadata SDK saves and UI retrieves data via the gRPC service. Similarly, you can define your own metadata types to log and view metadata for your custom artifacts. For Python examples, you can check [MLMD Python client](https://pypi.org/project/ml-metadata/) and Kubeflow metadata SDK [source code](https://github.com/kubeflow/metadata/blob/master/sdk/python/kubeflow/metadata/metadata.py). For Go examples, you can check the Watcher [source code](https://github.com/kubeflow/metadata/blob/master/watcher/handlers/metalogger.go). |
There was a problem hiding this comment.
Suggested revision for: Kubeflow metadata SDK saves and UI retrieves data via the gRPC service.
The Kubeflow Metadata SDK saves and retrieves data via the gRPC service.
There was a problem hiding this comment.
metadata SDK -> Metadata SDK
There was a problem hiding this comment.
What is "the Watcher"? Could this be referred to as the resource_watcher, or some other descriptive name?
content/docs/components/metadata.md
Outdated
| --header "Content-Type: application/json" -d \ | ||
| '{"name":"myorg/mytype/v1","properties":{"f1":"STRING", "f2":"INT", "f3": "DOUBLE"}}' | ||
| ``` | ||
| Kubeflow Metadata SDK saves and retrieves data via the gRPC service. Similarly, you can define your own metadata types to log and view metadata for your custom artifacts. For Python examples, you can check [MLMD Python client](https://pypi.org/project/ml-metadata/) and Kubeflow Metadata SDK [source code](https://github.com/kubeflow/metadata/blob/master/sdk/python/kubeflow/metadata/metadata.py). For Go examples, you can check the [source code](https://github.com/kubeflow/metadata/blob/master/watcher/handlers/metalogger.go) of the [resource watcher](#metadata-watcher). |
There was a problem hiding this comment.
Do you have bandwidth to change "resource watcher" to "metadata watcher" since that is what it is referred to in the prior section?
|
Thanks @joeliedtke @sarahmaddox for the review. Could you take another look? |
|
/lgtm Thanks for working on this update! |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: joeliedtke The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Related to #1207
This PR update the metadata doc section for KF 1.0 release:
This change is