Skip to content

Commit ccd4804

Browse files
committed
fixes #1
1 parent dbad027 commit ccd4804

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
# SWAG in Optax
22

3+
[![PyPI version](https://badge.fury.io/py/optax-swag.svg)](https://pypi.org/project/optax-swag/)
4+
35
This package implements [SWAG](https://arxiv.org/abs/1902.02476)
46
as an [Optax](https://optax.readthedocs.io/) transform to allow
57
usage with [JAX](https://jax.readthedocs.io/).
68

79
## Installation
810

9-
For now, the only available mode of installation is directly from source as
11+
Install from `pip` as:
12+
```shell
13+
pip install optax-swag
1014
```
15+
16+
To install the latest directly from source, run
17+
```shell
1118
pip install git+https://github.com/activatedgeek/optax-swag.git
1219
```
1320

14-
**TODO**: A PyPI package will be available soon.
15-
1621
## Usage
1722

1823
To start updating the iterate statistics, use [chaining](https://optax.readthedocs.io/en/latest/api.html#chain) as

0 commit comments

Comments
 (0)