Skip to content

Commit

Permalink
Update tensorflow wheels documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rosbo committed Dec 21, 2018
1 parent a160884 commit ac1d799
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 11 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ If you the first step above doesn't work for your use case, [open an issue](http
## Opening a pull request

1. Update the *Dockerfile*
1. For changes specific to the GPU image, update the [gpu.Dockerfile](gpu.Dockerfile).
2. Otherwise, update the [Dockerfile](Dockerfile).
2. Follow the instructions below to build a new image.
3. Add tests for your new package. See this [example](https://github.com/Kaggle/docker-python/blob/master/tests/test_fastai.py).
4. Follow the instructions below to test the new image.
5. Open a PR on this repo and you are all set!
1. For changes specific to the GPU image, update the [gpu.Dockerfile](gpu.Dockerfile).
1. Otherwise, update the [Dockerfile](Dockerfile).
1. Follow the instructions below to build a new image.
1. Add tests for your new package. See this [example](https://github.com/Kaggle/docker-python/blob/master/tests/test_fastai.py).
1. Follow the instructions below to test the new image.
1. Open a PR on this repo and you are all set!

## Building a new image

Expand All @@ -52,11 +52,15 @@ Flags:

* `--gpu` to test the GPU image.

## Tensorflow custom pre-built wheels
## Tensorflow custom pre-built wheel

We are building Tensorflow from sources mainly for:
A Tensorflow custom pre-built wheel is used mainly for:

* Better performance. When building from sources, we can leverage CPU specific optimizations
* Tensorflow with GPU support must be built from sources
* Faster build time: Building tensorflow from sources takes ~1h. Keeping this process outside the main build allows faster iterations when working on our Dockerfiles.

Building Tensorflow from sources:

* Increase performance: When building from sources, we can leverage CPU specific optimizations
* Is required: Tensorflow with GPU support must be built from sources

The [Dockerfile](tensorflow-whl/Dockerfile) and the [instructions](tensorflow-whl/README.md) can be found in the [tensorflow-whl folder/](tensorflow/).
8 changes: 7 additions & 1 deletion tensorflow-whl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
./build
```

# Push the new wheels
# Push the new wheels (Kaggle Engineers only)

1. Add an entry in the [CHANGELOG](CHANGELOG.md) with an appropriate `LABEL`.
2. Push the new image using the `LABEL` you picked above.
Expand All @@ -17,6 +17,12 @@

Update the line below in the [CPU Dockerfile](../Dockerfile) and the [GPU Dockerfile](../gpu.Dockerfile) to use the new `LABEL`.

To use wheels built locally:
```
FROM kaggle/python-tensorflow-whl as tensorflow_whl
```

To use our pre-built wheels:
```
FROM gcr.io/kaggle-images/python-tensorflow-whl:<LABEL> as tensorflow_whl
```

0 comments on commit ac1d799

Please sign in to comment.