Skip to content

Commit 0e89ab2

Browse files
authored
Additional corrections to IPU documentation. (#11)
1 parent e0603fc commit 0e89ab2

File tree

3 files changed

+16
-12
lines changed

3 files changed

+16
-12
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,11 @@ Alternatively, like other JAX flags, these can be set using environment variable
8484

8585
## License
8686

87-
The project remains licensed under the **Apache License 2.0**. No additional Python or C++ dependency has been introduced compared to the original JAX source code (outside Graphcore Poplar and Poplibs licensed under MIT license).
88-
* JAX license: https://github.com/graphcore-research/jax-experimental/LICENSE
89-
* JAXLIB license (including compiled dependencies): https://github.com/graphcore-research/jax-experimental/build/LICENSE.txt
90-
* Graphcore license agreements: https://docs.graphcore.ai/en/latest/licenses.html
87+
The project remains licensed under the **Apache License 2.0**, with the following files unchanged:
88+
* [JAX Apache license 2.0](./LICENSE);
89+
* [JAXLIB and compiled dependencies licenses;](build/LICENSE.txt)
90+
91+
The additional dependencies introduced for Graphcore IPU support are:
92+
* [Poplar: licensed under the Graphcore EULA](https://docs.graphcore.ai/projects/eula/en/latest/);
93+
* [PopLibs: licensed under MIT license](https://docs.graphcore.ai/en/latest/licenses.html);
94+
* [TensorFlow XLA for IPU: licensed under Apache license 2.0](https://docs.graphcore.ai/en/latest/licenses.html);

WORKSPACE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")
2121
git_repository(
2222
name = "org_tensorflow",
2323
# Jaxlib 0.3.15 compatible with JAX 0.3.16
24-
branch = "jaxlibv0.3.15/sdk-release-3.0-lean-jax",
25-
remote = "git@github.com:graphcore-research/tensorflow-jax-mk2-experimental.git"
24+
branch = "jaxlibv0.3.15/sdk-release-3.1-lean-jax",
25+
remote = "git@github.com:graphcore-research/tensorflow-jax-experimental.git"
2626
)
2727

2828
# For development, one often wants to make changes to the TF repository as well

ipu/docs/build.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
# How to build experimental JAX on IPU Mk2
1+
# How to build experimental JAX on IPU
22

3-
Building and testing JAX on IPU requires the following base configuration: Ubuntu 20.04, [Graphcore Poplar SDK 3.1](https://www.graphcore.ai/posts/poplar-sdk-3.1-now-available) and [Bazel 5.2.0](https://docs.bazel.build/versions/5.2.0/install.html). Other OS or Python versions have not been tested.
3+
Building and testing JAX on IPU requires the following base configuration: Ubuntu 20.04, Python 3.8, [Graphcore Poplar SDK 3.1](https://www.graphcore.ai/posts/poplar-sdk-3.1-now-available) and [Bazel 5.2.0](https://docs.bazel.build/versions/5.2.0/install.html). Other OS or Python versions have not been tested.
44

5-
Additionally, one needs to install to the following packages in your Python environment:
5+
Additionally, you need to install to the following packages in your Python environment:
66
```bash
77
pip install numpy==1.21.6 scipy cython pytest
88
```
9-
Note: the build process will work with more recent versions of Numpy, but that will then limit Numpy backward compatibility.
9+
Note: the build process will work with more recent versions of NumPy, but that will then limit NumPy backward compatibility.
1010

1111
## Build IPU JAXLIB
1212

1313
Building `jaxlib` currently requires the branch `jax-v0.3.15-ipu`. Once the branch checked out, the build process is similar to other backends:
1414
```bash
1515
export TF_POPLAR_BASE=#...poplar install directory
16-
python build/build.py --bazel_options=--override_repository=org_tensorflow=PATH/tensorflow-jax-mk2-experimental
16+
python build/build.py --bazel_options=--override_repository=org_tensorflow=PATH/tensorflow-jax-experimental
1717
```
18-
The `override_repository` config is optional. By default, the build process will pull the experimental IPU TensorFlow XLA code from the repository https://github.com/graphcore-research/tensorflow-jax-mk2-experimental.
18+
The `override_repository` config is optional. By default, the build process will pull the experimental IPU TensorFlow XLA code from the repository https://github.com/graphcore-research/tensorflow-jax-experimental.
1919

2020
If the build is successful, a binary `jaxlib` Python wheel will be produced in the `dist/` directory.
2121

0 commit comments

Comments
 (0)