Skip to content

Commit 394392f

Browse files
Johannes Ball?copybara-github
authored andcommitted
Updates build instructions.
PiperOrigin-RevId: 281404009 Change-Id: I712ee2b9d266caa41da942f06339fa93690c10b9
1 parent 68df6ef commit 394392f

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -194,21 +194,23 @@ This section describes the necessary steps to build your own pip packages of
194194
tensorflow-compression. This may be necessary to install it on platforms for
195195
which we don't provide precompiled binaries (currently only Linux and Darwin).
196196

197-
We use the Docker image `tensorflow/tensorflow:nightly-custom-op` for building
198-
pip packages. Note that this is different from `tensorflow/tensorflow:devel`.
199-
To be compatible with the TensorFlow pip package, the GCC version must match,
200-
but `tensorflow/tensorflow:devel` has a different GCC version installed.
197+
We use the Docker image `tensorflow/tensorflow:custom-op-ubuntu16` for building
198+
pip packages for Linux. Note that this is different from
199+
`tensorflow/tensorflow:devel`. To be compatible with the TensorFlow pip package,
200+
the GCC version must match, but `tensorflow/tensorflow:devel` has a different
201+
GCC version installed.
201202

202203
Inside a Docker container from the image, the following steps need to be taken.
203204

204-
1. Install TensorFlow pip package.
205+
1. Install the TensorFlow pip package.
205206
2. Clone the `tensorflow/compression` repo from GitHub.
206-
3. Run `:build_pip_pkg` inside the cloned repo:
207+
3. Run `:build_pip_pkg` inside the cloned repo.
207208

209+
For example:
208210
```bash
209211
sudo docker run -v /tmp/tensorflow_compression:/tmp/tensorflow_compression \
210-
tensorflow/tensorflow:nightly-custom-op bash -c \
211-
"pip install tensorflow &&
212+
tensorflow/tensorflow:custom-op-ubuntu16 bash -c \
213+
"pip install tensorflow==1.15 &&
212214
git clone https://github.com/tensorflow/compression.git
213215
/tensorflow_compression &&
214216
cd /tensorflow_compression &&
@@ -238,6 +240,9 @@ When done, you can uninstall the pip package again:
238240
pip uninstall tensorflow-compression
239241
```
240242

243+
To build packages for Darwin (and potentially other platforms), you can follow
244+
the same steps, but the Docker image should not be necessary.
245+
241246
## Authors
242247

243248
Johannes Ballé (github: [jonycgn](https://github.com/jonycgn)), Sung Jin Hwang

0 commit comments

Comments
 (0)