diff --git a/README.md b/README.md index 26a173a..d037597 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,14 @@ This repository contains a tutorial on how to combine [wandb](https://wandb.ai/) with [Slurm](https://slurm.schedmd.com/)'s pre-emption, i.e. how to automatically re-queue and resume runs from a Weights & Biases sweep on a Slurm cluster. -This is work in progress: +## Getting started -- TODO Debug failure scenarios - -- TODO Write a self-contained walk-through. - -## Installation +### Installation ```bash pip install git+https://github.com/f-dangel/wandb_preempt.git@main ``` + +### Basic Example + +Please see the [docs](https://wandb-preempt.readthedocs.io/en/latest/walkthrough/).