Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
romesco authored Dec 1, 2020
1 parent ce9136f commit b1310b4
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Configuration classes enabling type-safe PyTorch configuration for Hydra apps.

The config dataclasses are generated using [configen](https://github.com/facebookresearch/hydra/tree/master/tools/configen), check it out if you want to generate config dataclasses for your own project.

### Install:
```
# For now, please obtain through github. Soon, versioned (per-project) dists will be on PyPI.
pip install git+https://github.com/pytorch/hydra-torch
```

### Example config:
Here is one of many configs available. Notice it uses the defaults defined in the torch function signatures:
```python
Expand All @@ -18,6 +24,10 @@ class AdadeltaConf:
```
###### (once pytorch updates type annotations, these will automatically change from `Any` -> `Int/Float`)

### Install:
```
pip install git+f"{project} @ git+https://github.com/pytorch/hydra-torch/#subdirectory={project}"
### Getting Started:
Take a look at our tutorial series:
1. [Basic Tutorial](examples/mnist_00.md)
Expand Down

0 comments on commit b1310b4

Please sign in to comment.