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.

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

docs: add info about installing extras #373

Merged

Conversation

tarilabs
Copy link
Member

Description

Resolves #370

How Has This Been Tested?

Screenshot 2024-09-10 at 09 21 21

Merge criteria:

  • All the commits have been signed-off (To pass the DCO check)
  • The commits have meaningful messages; the author will squash them after approval or in case of manual merges will ask to merge with squash.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has manually tested the changes and verified that the changes work.
  • Code changes follow the kubeflow contribution guidelines.

If you have UI changes

  • The developer has added tests or explained why testing cannot be added.
  • Included any necessary screenshots or gifs if it was a UI change.
  • Verify that UI/UX changes conform the UX guidelines for Kubeflow.

Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
Copy link
Member Author

@tarilabs tarilabs left a comment

Choose a reason for hiding this comment

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

cc @isinyaaa wdyt?

Comment on lines +103 to +104
extra (available as `model-registry[hf]`). Reference section "[installing extras](#installing-extras)" above for
more information.
Copy link
Member Author

Choose a reason for hiding this comment

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

addresses the comment from #370

@tarilabs tarilabs mentioned this pull request Sep 10, 2024
7 tasks
Copy link
Contributor

@isinyaaa isinyaaa left a comment

Choose a reason for hiding this comment

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

Looks great Matteo! I'd just add that remark also on the error string under model_registry.ModelRegistry.register_hf_model e.g.:

https://github.com/kubeflow/model-registry/pull/375/files#diff-ed25c8c4e927ca78d91721d179bfe9c0bac9a3e424f417f21d25d0c9363eedc6

clients/python/README.md Outdated Show resolved Hide resolved
tarilabs and others added 2 commits September 10, 2024 21:33
Co-authored-by: Isabella Basso <isabellabdoamaral@gmail.com>
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
Co-authored-by: Isabella Basso <isabellabdoamaral@gmail.com>
Signed-off-by: Matteo Mortari <matteo.mortari@gmail.com>
@tarilabs tarilabs force-pushed the tarilabs-20240910-pydocsextras branch from 7ff4113 to fc6b750 Compare September 10, 2024 19:36
@tarilabs tarilabs requested a review from rareddy September 10, 2024 19:36
Copy link
Contributor

@rareddy rareddy left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@google-oss-prow google-oss-prow bot added the lgtm label Sep 11, 2024
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: isinyaaa, rareddy

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow google-oss-prow bot merged commit 4eadcec into kubeflow:main Sep 11, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Please clarify how the Model Registry libraries installed for Hugging face
3 participants