Skip to content

Commit

Permalink
[DOC] Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
f-dangel committed Sep 11, 2024
1 parent cf45b0a commit de0fad0
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

0 comments on commit de0fad0

Please sign in to comment.