Skip to content
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

Add --force and change the default doc to dvc queue kill #4183

Merged
merged 1 commit into from
Dec 30, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions content/docs/command-reference/queue/kill.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ Kill actively running [DVC experiment] tasks (see `dvc queue start`).
## Synopsis

```usage
usage: dvc queue kill [-h] [-q | -v] [<task> ...]
usage: dvc queue kill [-h] [-q | -v] [-f] [<task> ...]

positional arguments:
<task> Tasks in queue to kill.
```

## Description

Forcefully stops execution of the specified (running) experiment tasks.
Gracefully interrupt running experiment queue tasks (equivalent to Ctrl-C).

<admon type="warn">

Expand All @@ -38,3 +38,6 @@ To kill all running experiments and also stop processing the queue, use
- `-q`, `--quiet` - do not write anything to standard output.

- `-v`, `--verbose` - displays detailed tracing information.

- `-f`, `--force` - Forcefully and immediately kill running experiment queue
tasks.