Skip to content

Commit 21cf330

Browse files
committed
Add build instructions to README
1 parent 2fbee44 commit 21cf330

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,31 @@
55

66
|License|
77

8+
Augment Build Instructions
9+
==========================
10+
We maintain a fork of TransformerEngine with a small number of modifications. Each augment-specific
11+
branch is tagged VERSION-augment where VERSION is the release branch forked from upstream. The
12+
latest version is v0.13-augment.
13+
14+
To build a release wheel for a particular branch, run the following inside a dev container or other
15+
reasonable build environment:
16+
17+
.. code-block:: bash
18+
19+
git clone --recursive git@github.com:augmentcode/TransformerEngine.git
20+
cd TransformerEngine/
21+
git checkout v0.13-augment
22+
export NVTE_FRAMEWORK=pytorch # Don't build TensorFlow bindings even if a TF install is detected
23+
export MAX_JOBS=8 # Don't let ninja take over your entire computer
24+
python setup.py bdist_wheel
25+
# Go prepare a beverage of your choice
26+
27+
After a while, you will get a wheel file at dist/transformer_engine-<stuff>.whl, where <stuff> includes
28+
both the branch tag as well as system information like the Python version.
29+
30+
TODO: how to upload a wheel file to the augment PyPI server?
31+
32+
833
Transformer Engine
934
==================
1035

0 commit comments

Comments
 (0)