Skip to content

Commit 6375515

Browse files
author
jax authors
committed
Merge pull request #11119 from hawkinsp:docs
PiperOrigin-RevId: 455264044
2 parents 062a557 + 7dbe8c3 commit 6375515

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/developer.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,28 @@ specify the paths to CUDA and CUDNN, which you must have installed. Here
6666
may need to use `python3` instead. By default, the wheel is written to the
6767
`dist/` subdirectory of the current directory.
6868

69+
### Building jaxlib from source with a modified TensorFlow repository.
70+
71+
JAX depends on XLA, whose source code is in the
72+
[Tensorflow GitHub repository](https://github.com/tensorflow/tensorflow).
73+
By default JAX uses a pinned copy of the TensorFlow repository, but we often
74+
want to use a locally-modified copy of XLA when working on JAX. There are two
75+
ways to do this:
76+
77+
* use Bazel's `override_repository` feature, which you can pass as a command
78+
line flag to `build.py` as follows:
79+
80+
```
81+
python build/build.py --bazel_options=--override_repository=org_tensorflow=/path/to/tensorflow
82+
```
83+
* modify the `WORKSPACE` file in the root of the JAX source tree to point to
84+
a different TensorFlow tree.
85+
86+
To contribute changes back to XLA, send PRs to the TensorFlow repository.
87+
88+
The version of XLA pinned by JAX is regularly updated, but is updated in
89+
particular before each `jaxlib` release.
90+
6991
### Additional Notes for Building `jaxlib` from source on Windows
7092

7193
On Windows, follow [Install Visual Studio](https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2019)

0 commit comments

Comments
 (0)