This repository has been archived by the owner on Oct 16, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 12
Semi-autogenerated cli reference #172
Merged
Merged
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
4840479
semi-autogenerated cli reference
mike0sv 2fa1e07
fix double spaces and impls order
mike0sv 7b83973
fix double spaces (for real)
mike0sv d48ed0d
add abc subcommand args
mike0sv 96f2f7b
address comments
mike0sv a7085ab
prettier
mike0sv de0b20a
prettier
mike0sv 65f1588
delete spec, update usage and options formatting
mike0sv e0c1b9d
lint?
mike0sv 7182940
lint?
mike0sv 5b221ba
lint?
mike0sv 2ed3efa
lint
mike0sv e196fc4
feedback
mike0sv fabe888
revert yarn.lock
renovate[bot] e669838
move scripts, re-generate from latest docs
mike0sv f254cb6
MLEM model and MLEM dataset
mike0sv 095acea
💅🏼
mike0sv 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
move scripts, re-generate from latest docs
- Loading branch information
commit e6698387f5f188b43fb699aaca0932aab37e2aaa
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# deployment wait | ||
|
||
Wait for status of deployed service | ||
|
||
## Synopsis | ||
|
||
```usage | ||
usage: mlem deployment wait [-p <path>] | ||
[-s <[unknown|not_deployed|starting|crashed|stopped|running]>] | ||
[-i <[unknown|not_deployed|starting|crashed|stopped|running]>] | ||
[-p <float>] [-t <integer>] [-h] | ||
path | ||
|
||
arguments: | ||
path Path to deployment meta | ||
``` | ||
|
||
## Description | ||
|
||
TODO | ||
|
||
## Options | ||
|
||
- `-p <path>`, `--project <path>` - Path to MLEM project [default: (none)] | ||
- `-s <[unknown|not_deployed|starting|crashed|stopped|running]>`, | ||
`--status <[unknown|not_deployed|starting|crashed|stopped|running]>` - | ||
statuses to wait for [default: DeployStatus.RUNNING] | ||
- `-i <[unknown|not_deployed|starting|crashed|stopped|running]>`, | ||
`--intermediate <[unknown|not_deployed|starting|crashed|stopped|running]>` - | ||
Possible intermediate statuses | ||
- `-p <float>`, `--poll-timeout <float>` - Timeout between attempts [default: | ||
1.0] | ||
- `-t <integer>`, `--times <integer>` - Number of attempts. 0 -> indefinite | ||
[default: 0] | ||
- `-h`, `--help` - Show this message and exit. | ||
|
||
## Example: Wait for deployment setup (after mlem deployment run command) | ||
|
||
```cli | ||
$ mlem deployment wait service_name -i starting | ||
``` |
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
File renamed without changes.
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.
MODEL -> model
required / optional check how it's done in other docs
list with options - it was better the way it was done (compact, easier to read, etc)
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.
required and optional are different things: required means you always should provide it, optional means it can have
None
value. Required optional means you will get error if you don't provide it, but you can set it toNone
. Not required not optional means there is a default value which is notNone
and you can't set it toNone
also cli changed a bit, now
mlem build *
are subcommands (instead of argument). Alsomlem build
is a separate command (for building from saved config using-l
). I will update this soon when I decide how to better reflect this (same withserve
andapply-remote
)