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 and clean up the quickstart README file #112

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

yuanchen8911
Copy link
Collaborator

@yuanchen8911 yuanchen8911 commented May 7, 2024

The current README does't read well. This PR updates the description and flow.

  1. Separate the description of the MIG examples (gpu-test-4/5/6) in a new folder from the first 3 test examples and update the flow.
  2. Add a description for multi-process service demo: gpu-test-mps.
  3. Add a link to KubeCon presentation. (Please check if it's a correct link.)

@yuanchen8911
Copy link
Collaborator Author

/cc @klueska

Comment on lines -14 to +13
kubectl apply --filename=gpu-test{1,2,3,4}.yaml
kubectl apply --filename=gpu-test{1,2,3}.yaml
Copy link
Collaborator

Choose a reason for hiding this comment

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

Interesting -- I though I had purposfully removed demo 4 from this READMe for exactly this reason. Maybe I only did it here, but not in our actual driver repo: https://github.com/kubernetes-sigs/dra-example-driver

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah -- I see now. This is the file down in the quickstart folder -- yeah, this was just copied from my demo script when I presented this.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It seems to me that test-4 (MIG demo) is different from the other three. We also describe test-4 separately in detail later. I think the descriptions would be clearer if we separated them.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Makes sense to update this to only include examples that can be run on any GPU and separate out the MIG use cases to another folder.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Agree, test-5/6 are MIG examples too. We didn't even describe them in README. Let me update the PR.

Copy link
Collaborator Author

@yuanchen8911 yuanchen8911 May 7, 2024

Choose a reason for hiding this comment

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

Created a new folder mig and moved the MIG example gpu-test4/5/6 to it and updated README files accordingly.

@yuanchen8911 yuanchen8911 requested a review from klueska May 7, 2024 15:11
Signed-off-by: Yuan Chen <[email protected]>

Add link

Signed-off-by: Yuan Chen <[email protected]>

Minor typo fix

Signed-off-by: Yuan Chen <[email protected]>

Add a new folder mig
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