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

Update rhoai docs to include sdg #219

Merged
merged 1 commit into from
Dec 2, 2024

Conversation

HumairAK
Copy link
Contributor

@HumairAK HumairAK commented Nov 29, 2024

Description

This pr does the following:

  • update pre-requisite section to reflect requirements for judge/teacher models
  • add ToC with links
  • removes ilab data generate instructions
  • adds links on how to make your own taxonomy tree (links to rhel ai docs)
  • adds instructions on how to deploy your own teacher model
  • adds instructions on how to deploy standalone pod with in cluster sdg enabled
  • makes various formatting changes, removes bullet point structuring for a more standard doc approach
  • removes inline hyperlink for easier maintenance

How Has This Been Tested?

Follow the docs.

Merge criteria:

  • The commits are squashed in a cohesive manner and have meaningful messages.
  • 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

@HumairAK HumairAK force-pushed the ilab-on-rhoai-read-me branch 3 times, most recently from a937ca7 to e3d0f7b Compare November 29, 2024 19:00
* On the right hand side select ‘Deploy model’ under Single-model serving platform
* Under Serving runtime choose the serving runtime `vLLM Serving Runtime for Kserve`.
* Check the `Make deployed models available through an external route` box.
* Under token authentication check the `Require token authentication` box, select the service account that we have created above.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* Under token authentication check the `Require token authentication` box, select the service account that we have created above.
* Under token authentication check the `Require token authentication` box, write the name of the service account that we have created above.

IIRC the there's no selection mechanism here, and Dashboard will create/manage a new SA if not typed to match

apiVersion: v1
kind: ServiceAccount
metadata:
name: <model-server-service-account-name>
Copy link
Member

Choose a reason for hiding this comment

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

given that we are defining mixtral-sa explicitly for teacher, maybe we should go ahead and just name this mistral-sa, judge-sa, etc to avoid confusion

- "--judge-serving-model-secret"
- "<judge-model-details-k8s-secret>"
- "--sdg-object-store-secret"
- "<created-object-store-credentials-secret-name>"
Copy link
Member

Choose a reason for hiding this comment

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

i think we defined this expicitly above as sdg-object-store-credentials so might as well remove confusion and use that here

Copy link
Member

@gmfrasca gmfrasca left a comment

Choose a reason for hiding this comment

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

some nitpicks but otherwise /lgtm

@HumairAK HumairAK force-pushed the ilab-on-rhoai-read-me branch from e3d0f7b to 5216ae5 Compare December 2, 2024 17:29
As well as make various adjustments to formatting, layout, etc.

Co-Authored-By: Giulio Frasca <[email protected]>

Signed-off-by: Humair Khan <[email protected]>
@HumairAK HumairAK force-pushed the ilab-on-rhoai-read-me branch from 5216ae5 to 159d96a Compare December 2, 2024 17:39
@HumairAK HumairAK merged commit e57915f into opendatahub-io:main Dec 2, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants