Skip to content

Commit a7b5b3c

Browse files
committed
Add releasing instructions
1 parent ecbc6c7 commit a7b5b3c

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@ Key development functionality is contained within the `./dev` script. This inclu
4444

4545
We encourage pull requests from the community. Please reach out to us with any questions about contributing.
4646

47+
**Releasing:**
48+
49+
1. `git push origin origin/main:refs/tags/v<MAJOR>.<MINOR>.<PATCH>`
50+
2. Create a release at https://github.com/graphcore-research/unit-scaling/releases/
51+
3. Check [GitHub Actions](https://github.com/graphcore-research/unit-scaling/actions) and [PyPI](https://pypi.org/project/unit-scaling/), which should auto-publish the project
52+
4753
## What is u-μP?
4854

4955
u-μP inserts scaling factors into the model to make activations, gradients and weights unit-scaled (RMS ≈ 1) at initialisation, and into optimiser learning rates to keep updates stable as models are scaled in width and depth. This results in hyperparameter transfer from small to large models and easy support for low-precision training.

0 commit comments

Comments
 (0)