Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fwhigh committed May 17, 2021
1 parent c9b9ea4 commit d3978f7
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,28 @@ Convenience utilities for common machine learning tasks on Metaflow

## Quickstart

You can run the tournament immediately like this.
First, install a convenience package I'm calling `metaflow-helper`.
You can run the model selection tournament immediately like this.
Install a convenience package called metaflow-helper.


```bash
git clone https://github.com/fwhigh/metaflow-helper.git
cd metaflow-helper
python -m pip install .
```

Second, run the Metaflow tournament job.
This one needs a few more packages, including Metaflow itself,
which `metaflow-helper` doesn't currently require.
Then run a Metaflow example.
Examples need a few more packages, including Metaflow itself, which metaflow-helper doesn’t currently require.

```bash
python -m pip install -r example-requirements.txt
python examples/model-selection/train.py run
```

Visualize the flow.
You can visualize the example flow.

```bash
python examples/model-selection/train.py output-dot | dot -Grankdir=TB -Tpng -o flow.pngflow.png
python examples/model-selection/train.py output-dot | dot -Grankdir=TB -Tpng -o model-selection-flow.png
```

## Release procedure
Expand Down

0 comments on commit d3978f7

Please sign in to comment.