diff --git a/README.md b/README.md index 63ab1ec..2644df3 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,12 @@ We're keen to help users with any problems they encounter. To install the `unit-scaling` library, run: ```sh -pip install git+https://github.com/graphcore-research/unit-scaling.git +pip install unit-scaling +``` +or for a local editable install (i.e. one which uses the files in this repo), run: + +```sh +pip install -e . ``` ## Development diff --git a/docs/index.rst b/docs/index.rst index de8eafe..13e9610 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,7 +18,7 @@ To install :code:`unit-scaling`, run: .. code-block:: - pip install git+https://github.com/graphcore-research/unit-scaling.git + pip install unit-scaling Getting Started --------------- diff --git a/docs/user_guide.rst b/docs/user_guide.rst index a8ec322..1a85eea 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -19,7 +19,7 @@ To install the :code:`unit-scaling` library, run: .. code-block:: - pip install git+https://github.com/graphcore-research/unit-scaling.git + pip install unit-scaling For those who wish to develop on the :code:`unit-scaling` codebase, clone or fork our `GitHub repo `_ and follow the