Skip to content

Commit 161b245

Browse files
update install instructions
1 parent 7d5dfb8 commit 161b245

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,12 @@ We're keen to help users with any problems they encounter.
1919
To install the `unit-scaling` library, run:
2020

2121
```sh
22-
pip install git+https://github.com/graphcore-research/unit-scaling.git
22+
pip install unit-scaling
23+
```
24+
or for a local editable install (i.e. one which uses the files in this repo), run:
25+
26+
```sh
27+
pip install -e .
2328
```
2429

2530
## Development

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To install :code:`unit-scaling`, run:
1818

1919
.. code-block::
2020
21-
pip install git+https://github.com/graphcore-research/unit-scaling.git
21+
pip install unit-scaling
2222
2323
Getting Started
2424
---------------

docs/user_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To install the :code:`unit-scaling` library, run:
1919

2020
.. code-block::
2121
22-
pip install git+https://github.com/graphcore-research/unit-scaling.git
22+
pip install unit-scaling
2323
2424
For those who wish to develop on the :code:`unit-scaling` codebase, clone or fork our
2525
`GitHub repo <https://github.com/graphcore-research/unit-scaling.git>`_ and follow the

0 commit comments

Comments
 (0)