Skip to content

Commit d2637d0

Browse files
authored
Refresh README documentation (#1097)
- Refer to the new `Dockerfile.tmpl` - Remove outdated documentation about GPU layers/ - Remove link to outdated external documentation.
1 parent 7ffc2b9 commit d2637d0

File tree

1 file changed

+4
-12
lines changed

1 file changed

+4
-12
lines changed

README.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,13 @@
22

33
[Kaggle Notebooks](https://www.kaggle.com/notebooks) allow users to run a Python Notebook in the cloud against our competitions and datasets without having to download data or set up their environment.
44

5-
This repository includes our Dockerfiles for building the [CPU-only](Dockerfile) and [GPU](gpu.Dockerfile) image that runs Python Notebooks on Kaggle.
5+
This repository includes the [Dockerfile](Dockerfile.tmpl) for building the CPU-only and GPU image that runs Python Notebooks on Kaggle.
66

7-
Our Python Docker images are stored on Google Container Registry at:
7+
Our Python Docker images are stored on the Google Container Registry at:
88

99
* CPU-only: [gcr.io/kaggle-images/python](https://gcr.io/kaggle-images/python)
1010
* GPU: [gcr.io/kaggle-gpu-images/python](https://gcr.io/kaggle-gpu-images/python)
1111

12-
Note: The base image for the GPU image is our CPU-only image. The [gpu.Dockerfile](gpu.Dockerfile) adds a few extra layers to install GPU related libraries and packages (cuda, libcudnn, pycuda etc.) and reinstall packages with specific GPU builds (torch, tensorflow and a few mores).
13-
14-
## Getting started
15-
16-
To get started with this image, read our [guide](https://medium.com/@kaggleteam/how-to-get-started-with-data-science-in-containers-6ed48cb08266) to using it yourself, or browse [Kaggle Notebooks](https://www.kaggle.com/notebooks) for ideas.
17-
1812
## Requesting new packages
1913

2014
First, evaluate whether installing the package yourself in your own notebooks suits your needs. See [guide](https://github.com/Kaggle/docker-python/wiki/Missing-Packages).
@@ -23,9 +17,7 @@ If you the first step above doesn't work for your use case, [open an issue](http
2317

2418
## Opening a pull request
2519

26-
1. Update the *Dockerfile*
27-
1. For changes specific to the GPU image, update the [gpu.Dockerfile](gpu.Dockerfile).
28-
1. Otherwise, update the [Dockerfile](Dockerfile).
20+
1. Edit the [Dockerfile](Dockerfile.tmpl).
2921
1. Follow the instructions below to build a new image.
3022
1. Add tests for your new package. See this [example](https://github.com/Kaggle/docker-python/blob/main/tests/test_fastai.py).
3123
1. Follow the instructions below to test the new image.
@@ -74,4 +66,4 @@ docker run --runtime nvidia --rm -it kaggle/python-gpu-build /bin/bash
7466
docker run --runtime nvidia --rm -it gcr.io/kaggle-gpu-images/python /bin/bash
7567
```
7668

77-
To ensure your container can access the GPU, follow the instructions posted [here](https://github.com/Kaggle/docker-python/issues/361#issuecomment-448093930).
69+
To ensure your container can access the GPU, follow the instructions posted [here](https://github.com/Kaggle/docker-python/issues/361#issuecomment-448093930).

0 commit comments

Comments
 (0)