Add params #1128
Add params #1128
Conversation
content/docs/sidebar.json
Outdated
| @@ -284,6 +284,17 @@ | |||
| "label": "move", | |||
| "slug": "move" | |||
| }, | |||
| { | |||
| "label": "param", | |||
There was a problem hiding this comment.
It looks great to me
- maybe some links from
params diffto the params index description (which gives an excellent overview of what params are). May be just repeat some paragraphs.
One typo in sidebar.
- Also, we need to update prism.js scripts to highight these new commands cc @jorgeorpinel
|
@dmpetrov thanks 🙏 .. really appreciate doing this. @jorgeorpinel |
There was a problem hiding this comment.
Phew... I have lots of questions and suggestions, sorry! 😅
Please just mostly notice the questions in bullets
But feel free to comment on any other comment. I can take over this PR and address all the other stutff. Much of it should be easy to apply since I left GH suggestions so feel fee to commit some of those as well.
| usage: dvc run [-h] [-q | -v] [-d DEPS] [-o OUTS] [-O OUTS_NO_CACHE] | ||
| [-p PARAMS] [-m METRICS] [-M METRICS_NO_CACHE] [-f FILE] | ||
| [-c CWD] [-w WDIR] [--no-exec] [-y] [--overwrite-dvcfile] | ||
| [--ignore-build-cache] [--remove-outs] [--no-commit] | ||
| [--outs-persist OUTS_PERSIST] | ||
| [--outs-persist-no-cache OUTS_PERSIST_NO_CACHE] | ||
| [--always-changed] | ||
| command |
There was a problem hiding this comment.
One last comment: dvc run is getting gargantuan 🐋
Isn't there an issue out there somewhere to split it into 2 commands? May be time to revisit that 😬
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
More feedback for myself to address, please ignore.
Thanks for all the material @dmpetrov this is really complete!
- We may also need to update the DVC-file format doc to include info about params field.
fix synopsis sections of list, update cmd refs
|
Did lot's of editing in db3989d in case you want to check it @shcheklein @dmpetrov |
| Supported parameter _value_ types are: string, integer, float, and arrays. DVC | ||
| itself does not ascribe any specific meaning for these values. They are | ||
| user-defined, and serve as a way to generalize and parametrize an machine | ||
| learning algorithms or data processing code. |
There was a problem hiding this comment.
The only question I still have is about this paragraph. What do we mean supported? Isn't any valid YAML or JSON value automatically supported? Supported for what, for params diff? If so maybe we should only mention this in that other doc (I did copy part of this p to there already). @dmpetrov
Params and
params diff