Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
PythonFZ committed Jan 26, 2025
1 parent 345cc47 commit eda140a
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pip install paraffin

## Usage

### `paraffin submit`
### paraffin submit
You can submit your current DVC workflow to a database file `paraffin.db` for later execution.

> [!TIP]
Expand All @@ -34,14 +34,21 @@ You can submit your current DVC workflow to a database file `paraffin.db` for la
paraffin submit C_AddNodeNumbers "A*"
```

### `paraffin worker`
### paraffin worker
A submitted job will be executed by paraffin workers.
To start a worker you can run `paraffin worker`.
The worker will pick up all the jobs in the workeres queue and close once finished.

### `paraffin ui`
```bash
paraffin worker
```

### paraffin ui
Paraffin ships with a web application for visualizing the progress.
You can start it using `paraffin ui`.
You can start it using
```bash
paraffin ui
```

## Queue Labels

Expand Down

0 comments on commit eda140a

Please sign in to comment.