Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

dcs(ml-models): enhancing ml model documentation #8848

Merged
merged 6 commits into from
Sep 19, 2023
Merged

dcs(ml-models): enhancing ml model documentation #8848

merged 6 commits into from
Sep 19, 2023

Conversation

gabe-lyons
Copy link
Contributor

Adds improved examples, additional context per entity and documentation for the ML Primary Key entity.

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@github-actions github-actions bot added ingestion PR or Issue related to the ingestion of metadata docs Issues and Improvements to docs labels Sep 15, 2023
yoonhyejin
yoonhyejin reviewed Sep 18, 2023
View reviewed changes
docs/api/tutorials/ml.md Outdated
@@ -23,6 +23,8 @@ This guide will show you how to
- Create ML entities: MlFeature, MlFeatureTable, MlModel, MlModelGroup
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Create ML entities: MlFeature, MlFeatureTable, MlModel, MlModelGroup
- Create ML entities: MlFeature, MlFeatureTable, MlModel, MlModelGroup, MlPrimaryKey

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

docs/api/tutorials/ml.md Show resolved Hide resolved
@yoonhyejin
Copy link
Collaborator

Overall looks great!
@gabe-lyons Do you think it's reasonable to have "Read mlPrimaryKey" somewhere?

@gabe-lyons
Copy link
Contributor Author

Overall looks great! @gabe-lyons Do you think it's reasonable to have "Read mlPrimaryKey" somewhere?

@yoonhyejin added 👍

@yoonhyejin
Copy link
Collaborator

lgtm!

@gabe-lyons gabe-lyons merged commit 67af682 into datahub-project:master Sep 19, 2023
58 of 59 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yoonhyejin yoonhyejin yoonhyejin approved these changes

@eboneil eboneil eboneil approved these changes

Assignees
No one assigned
Labels
docs Issues and Improvements to docs ingestion PR or Issue related to the ingestion of metadata
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@gabe-lyons @yoonhyejin @eboneil