Add docs for the PyTorchJob integration #1048
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for kubernetes-sigs-kueue ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
6679ad7 to
38bc9ae
Compare
38bc9ae to
fa963b7
Compare
Signed-off-by: Yuki Iwai <yuki.iwai.tz@gmail.com>
fa963b7 to
d3b029a
Compare
|
Blocked on #995 |
mwielgus
reviewed
Aug 10, 2023
d3b029a to
80cb611
Compare
|
Is this still WIP? |
Yes, I need to add a sample to the |
80cb611 to
194577a
Compare
|
@alculquicondor This PR is ready for review. |
site/content/en/docs/tasks/run_with_kubeflow/run_pytorchjobs.md
Outdated
Show resolved
Hide resolved
194577a to
0a82b98
Compare
|
|
||
| This example is based on https://github.com/kubeflow/training-operator/blob/855e0960668b34992ba4e1fd5914a08a3362cfb1/examples/pytorch/simple.yaml. | ||
|
|
||
| Note that the minimum requirement training-operator version is v1.7.0. |
There was a problem hiding this comment.
This should be said in the "Before you begin" section.
eac90cf to
d05b74f
Compare
site/layouts/shortcodes/include.html
Outdated
| ```{{ .Get 1 }} | ||
| {{ (printf "%s%s" .Page.File.Dir $path) | readFile | replaceRE "^---[\\s\\S]+?---" "" | safeHTML }} | ||
| {{ (printf "%s" $path) | readFile | replaceRE "^---[\\s\\S]+?---" "" | safeHTML }} |
There was a problem hiding this comment.
Suggested change
| {{ (printf "%s" $path) | readFile | replaceRE "^---[\\s\\S]+?---" "" | safeHTML }} | |
| {{ $path | readFile | replaceRE "^---[\\s\\S]+?---" "" | safeHTML }} |
?
There was a problem hiding this comment.
site/layouts/shortcodes/include.html
Outdated
| @@ -1,6 +1,6 @@ | |||
| {{ $file := .Get 0 }} | |||
| [{{$file}}]({{printf "/examples/%s" $file}}) | |||
| {{ $path := (printf "../../static/examples/%s" $file)}} | |||
| {{ $path := (printf "/opt/build/repo/site/static/examples/%s" $file)}} | |||
There was a problem hiding this comment.
uhm... this is worrisome. It will work in the bot, but it won't work if someone is trying to build the site locally.
Can you try "site/static/examples/%" or "static/examples/%"?
There was a problem hiding this comment.
It sounds reasonable. Let me try it.
593f652 to
3e5da71
Compare
Signed-off-by: Yuki Iwai <yuki.iwai.tz@gmail.com>
3e5da71 to
f978bb5
Compare
|
/lgtm |
|
@alculquicondor Can you add |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alculquicondor, tenzen-y 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 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind documentation
What this PR does / why we need it:
I added docs for the PyTorchJob integration.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?