Skip to content

Commit 3fd7fa0

Browse files
Cleanup documentation
1 parent 78ca891 commit 3fd7fa0

File tree

2 files changed

+3
-12
lines changed

2 files changed

+3
-12
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,11 @@ This image can be built and entered interactively using:
2424

2525
```sh
2626
docker build -t unit-scaling-dev:latest .
27-
docker run -it --rm \
28-
-v ~/.ssh:/home/developer/.ssh:ro -v ~/.gitconfig:/home/developer/.gitconfig:ro \
29-
--user developer:developer -v $(pwd):/home/developer/unit-scaling unit-scaling-dev:latest
30-
# The second line in `docker run` here is optional. It enables git within the container.
27+
docker run -it --rm --user developer:developer -v $(pwd):/home/developer/unit-scaling unit-scaling-dev:latest
28+
# To use git within the container, add `-v ~/.ssh:/home/developer/.ssh:ro -v ~/.gitconfig:/home/developer/.gitconfig:ro`.
3129
```
3230

33-
For vscode users, this repo also contains a `devcontainer.json` file, which enables the container to be used as a full-featured IDE (see the [Dev Container docs](https://code.visualstudio.com/docs/devcontainers/containers) for details on how to use this feature).
31+
For vscode users, this repo also contains a `.devcontainer.json` file, which enables the container to be used as a full-featured IDE (see the [Dev Container docs](https://code.visualstudio.com/docs/devcontainers/containers) for details on how to use this feature).
3432

3533
Key development functionality is contained within the `./dev` script. This includes running unit tests, linting, formatting, documentation generation and more. Run `./dev --help` for the available options. Running `./dev` without arguments is equivalent to using the `--ci` option, which runs all of the available dev checks. This is the test used for GitHub CI.
3634

docs/user_guide.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,6 @@ The advantage of using a unit-scaled model is as follows:
5555
scales have stayed within range for all unit-scaled models tested thus far.
5656
3. This can enable the use of smaller, more efficient number formats out-of-the-box,
5757
such as FP16 and even FP8.
58-
4. As the behaviour of some ops depends on scale, unit-scaling a model can change its
59-
training dynamics slightly. In some experiments this has been shown to lead to
60-
loss decreasing faster, though further work is needed to validate this.
61-
62-
For a more in-depth treatment of unit scaling, see our paper
63-
`Unit Scaling: Out-of-the-Box Low-Precision Training (ICML, 2023)
64-
<https://arxiv.org/abs/2303.11257>`_.
6558

6659

6760
How to unit-scale a model

0 commit comments

Comments
 (0)