-
Notifications
You must be signed in to change notification settings - Fork 359
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: Describe task config policies #9969
Conversation
✅ Deploy Preview for determined-ui canceled.
|
7b3915f
to
f9509b7
Compare
9a5ffe3
to
ee028d8
Compare
ee028d8
to
ceaf527
Compare
41fc612
to
9c93066
Compare
31494c5
to
7093614
Compare
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.
LGTM
docs/manage/config-policies.rst
Outdated
# Create a new policy | ||
det policy create <policy_name> --config <policy_config_file.yaml> |
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.
# Create a new policy | |
det policy create <policy_name> --config <policy_config_file.yaml> | |
# Set config policies for a given scope. | |
det config-policies set <workload_type> --workspace <workspace_name> --config-file <policy_config_file> | |
where <workload_type> can be either `experiment` or `ntsc` and <policy_config_file> is the absolute or relative path the YAML or JSON file containing your config policies. | |
When creating global config policies, you don't need to specify `--workspace <workspace_name>` |
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.
On the note of the <workload_type>
being experiment
or ntsc
I brought up using "NTSC" instead of "Tasks" in the webUI during a demo a couple of weeks ago, and someone (I think Tim?) mentioned that customers aren't very familiar with the NTSC terminology /categorization. If that's the case, it could be worth changing ntsc
to tasks
in the CLI for consistency (if time permits)!
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.
I think it's also important we use plural "config policies" everywhere!
We should probably mention somewhere in the docs that config policies are set together or not at all (updating config policies with the webUI or CLI will always update both your invariant config and constraints for a given scope, you cannot just update one of the two using our API)
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.
@amandavialva01 changes applied but, keeping this open in case you want to retain your note about the CLI. Do we need to share this with the CLI engineer?
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.
Yes! Saloni was the CLI developer, but she is currently on rotation on a different team! We currently have one ticket left for CLI work that I picked up.
But we have been tackling high priority fixes/work before making other changes. With that being said, I do think the only remaining "bug" fix is in review and a change like this could be made in the CLI ticket I linked (CM-576).
WDYT @kkunapuli ? Should we make this change after comments from the demo two weeks ago?
e151016
to
1e98075
Compare
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.
Looks awesome, Tara, fantastic work!!
docs/manage/config-policies.rst
Outdated
|
||
.. note:: | ||
|
||
Tasks such as NTSC (notebooks, tensorboards, shells, and commands) and resource managers (RMs) |
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.
Tasks such as NTSC (notebooks, tensorboards, shells, and commands) and resource managers (RMs) | |
Tasks such as NTSC (notebooks, tensorboards, shells, and commands) and experiments |
d4ae6c3
to
e14c106
Compare
changes from Amanda
the bug was fixed and the priority can no longer be overridden
8c8fd9e
to
8361fa6
Compare
8361fa6
to
3063d7c
Compare
Docs Created/Updated
Note: Feature is enterprise only
Description
Test Plan
Scenarios tested with screen captures:
priority_limit
invariant_config
complete example
#example invariant config
Checklist