This repository has been archived by the owner on Jun 6, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 549
Add help info #4950
Merged
Merged
Add help info #4950
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -84,32 +84,23 @@ export const PAI_ENV_VAR = [ | |
}, | ||
]; | ||
export const PROTOCOL_TOOLTIPS = { | ||
jobName: | ||
'Name for the job, need to be unique, should be string in ^[A-Za-z0-9\\-._~]+$ format.', | ||
taskRoleName: 'Name of the taskRole, string in ^[A-Za-z0-9\\-._~]+$ format.', | ||
taskRoleContainerSize: [ | ||
'Resource required per container instance', | ||
'CPU number and memory number will be auto scaled with GPU number by default.', | ||
], | ||
hivedSkuType: [ | ||
'SKU defines a resource unit in all resource dimensions, ', | ||
'including GPU, CPU, and memory.', | ||
], | ||
taskRole: [ | ||
'Task roles are different types of task in the protocol.', | ||
'One job may have one or more task roles, each task role has one or more instances, and each instance runs inside one container.', | ||
], | ||
taskRoleContainerSize: | ||
'https://openpai.readthedocs.io/en/latest/manual/cluster-user/quick-start.html', | ||
hivedSkuType: | ||
'https://openpai.readthedocs.io/en/latest/manual/cluster-user/quick-start.html', | ||
taskRole: | ||
'https://openpai.readthedocs.io/en/latest/manual/cluster-user/how-to-run-distributed-job.html#taskrole-and-instance', | ||
parameters: | ||
'Parameters are key-value pairs that you could save your frequently used values and reference them in command section by their keys.', | ||
secrets: `Secrets are used to store sensitive data. The value will be masked and won't be seen by other users.`, | ||
'https://openpai.readthedocs.io/en/latest/manual/cluster-user/quick-start.html', | ||
secrets: `https://openpai.readthedocs.io/en/latest/manual/cluster-user/quick-start.html`, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should be |
||
data: | ||
'Data section is used to generate pre-command that download/mount your data to specific path in container.', | ||
'https://openpai.readthedocs.io/en/latest/manual/cluster-user/how-to-manage-data.html', | ||
tools: | ||
'Tools section is used to configure the tools that are useful for jobs.', | ||
'https://openpai.readthedocs.io/en/latest/manual/cluster-user/how-to-debug-jobs.html#how-to-debug-jobs', | ||
dockerImage: | ||
'Please contact admin to make sure which cuda versions in docker image is supported by gpu drivers.', | ||
'https://openpai.readthedocs.io/en/latest/manual/cluster-user/docker-images-and-job-examples.html', | ||
teamStorage: | ||
"Team share storage is external storage defined by cluster admin. Select an element means the external storage will be mount to 'path' and user can treat it as local path.", | ||
'https://openpai.readthedocs.io/en/latest/manual/cluster-user/how-to-manage-data.html#use-storage-in-jobs', | ||
}; | ||
|
||
export const COMMAND_PLACEHOLDER = `'You could define your own Parameters, Secrets or Data mount point on the right sidebar. | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be
https://openpai.readthedocs.io/en/latest/manual/cluster-user/how-to-use-advanced-job-settings.html#parameters-and-secrets