Skip to content

Commit

Permalink
chore: move DeepDetect docker images to jolibrain's self-hosted registry
Browse files Browse the repository at this point in the history
  • Loading branch information
beniz committed Mar 31, 2023
1 parent 8e0770d commit a9652f4
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 22 deletions.
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,24 @@ Please join the community on [Gitter](https://gitter.im/beniz/deepdetect), where

---

| Build type | STABLE | DEVEL |
|------|--------|-------|
| SOURCE | <img src="https://img.shields.io/github/v/release/jolibrain/deepdetect?color=success&sort=semver"> | <img src="https://img.shields.io/github/commits-since/jolibrain/deepdetect/latest/master"> |

All DeepDetect Docker images available from https://docker.jolibrain.com/.

- To list all available images:
```
curl -X GET https://docker.jolibrain.com/v2/_catalog
```

- To list an image available tags, e.g. for the `deepdetect_cpu` image:
```
curl -X GET https://docker.jolibrain.com/v2/deepdetect_cpu/tags/list
```

---

* [Main features](#main-features)
* [Machine Learning functionalities per library](#machine-learning-functionalities-per-library)
* [Installation](https://www.deepdetect.com/quickstart-server/)
Expand Down Expand Up @@ -53,14 +71,6 @@ Please join the community on [Gitter](https://gitter.im/beniz/deepdetect), where
* [References](#references)
* [Authors](#authors)

| Build type | STABLE | DEVEL |
|------|--------|-------|
| SOURCE | <img src="https://img.shields.io/github/v/release/jolibrain/deepdetect?color=success&sort=semver"> | <img src="https://img.shields.io/github/commits-since/jolibrain/deepdetect/latest/master"> |
| Docker image CPU | [<img src="https://img.shields.io/docker/v/jolibrain/deepdetect_cpu?color=success&sort=semver" />](https://hub.docker.com/r/jolibrain/deepdetect_cpu) | <img src="https://img.shields.io/badge/dynamic/json?color=9cf&label=date&query=%24.tag_last_pushed&url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fjolibrain%2Fdeepdetect_cpu%2Ftags%2Fci-master"> |
| Docker image GPU | [<img src="https://img.shields.io/docker/v/jolibrain/deepdetect_gpu?color=success&sort=semver" />](https://hub.docker.com/r/jolibrain/deepdetect_gpu) | <img src="https://img.shields.io/badge/dynamic/json?color=9cf&label=date&query=%24.tag_last_pushed&url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fjolibrain%2Fdeepdetect_gpu%2Ftags%2Fci-master"> |
| Docker image GPU+TORCH | [<img src="https://img.shields.io/docker/v/jolibrain/deepdetect_gpu_torch?color=success&sort=semver" />](https://hub.docker.com/r/jolibrain/deepdetect_gpu_torch) | <img src="https://img.shields.io/badge/dynamic/json?color=9cf&label=date&query=%24.tag_last_pushed&url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fjolibrain%2Fdeepdetect_gpu_torch%2Ftags%2Fci-master"> |
| Docker image GPU+TENSORRT | [<img src="https://img.shields.io/docker/v/jolibrain/deepdetect_gpu_tensorrt?color=success&sort=semver" />](https://hub.docker.com/r/jolibrain/deepdetect_gpu_tensorrt) | <img src="https://img.shields.io/badge/dynamic/json?color=9cf&label=date&query=%24.tag_last_pushed&url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fjolibrain%2Fdeepdetect_gpu_tensorrt%2Ftags%2Fci-master"> |

## Main features

- high-level API for machine learning and deep learning
Expand Down
2 changes: 1 addition & 1 deletion ci/build-docker-images.sh
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ else
TMP_TAG="trash"
fi

image_url_prefix="jolibrain/deepdetect"
image_url_prefix="docker.jolibrain.com/deepdetect"

for name in $NAMES; do
target=${TARGETS[$name]}
Expand Down
10 changes: 5 additions & 5 deletions ci/release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ sed -ne "/^## \[$tag\]/,/^##.*202/p" CHANGELOG.md | sed -e '$d' -e '1d' > note.m
cat >> note.md <<EOF
### Docker images:
* CPU version: \`docker pull jolibrain/deepdetect_cpu:v$tag\`
* GPU (CUDA only): \`docker pull jolibrain/deepdetect_gpu:v$tag\`
* GPU (CUDA and Tensorrt) :\`docker pull jolibrain/deepdetect_cpu_tensorrt:v$tag\`
* GPU with torch backend: \`docker pull jolibrain/deepdetect_gpu_torch:v$tag\`
* All images available on https://hub.docker.com/u/jolibrain
* CPU version: \`docker pull docker.jolibrain.com/deepdetect_cpu:v$tag\`
* GPU (CUDA only): \`docker pull docker.jolibrain.com/deepdetect_gpu:v$tag\`
* GPU (CUDA and Tensorrt) :\`docker pull docker.jolibrain.com/deepdetect_cpu_tensorrt:v$tag\`
* GPU with torch backend: \`docker pull docker.jolibrain.com/deepdetect_gpu_torch:v$tag\`
* All images available from https://docker.jolibrain.com/, list images with `curl -X GET https://docker.jolibrain.com/v2/_catalog`
EOF

trap "rm -f note.md" EXIT
Expand Down
16 changes: 8 additions & 8 deletions docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ This allows to run the container and set an image classification model based on
## Getting and running official images

```
docker pull jolibrain/deepdetect_cpu
docker pull docker.jolibrain.com/deepdetect_cpu
```
or
```
docker pull jolibrain/deepdetect_gpu
docker pull docker.jolibrain.com/deepdetect_gpu
```

### Running the CPU image

```
docker run -d -p 8080:8080 jolibrain/deepdetect_cpu
docker run -d -p 8080:8080 docker.jolibrain.com/deepdetect_cpu
```

`dede` server is now listening on your port `8080`:
Expand Down Expand Up @@ -57,7 +57,7 @@ The following steps are required:
- install `nvidia-docker`: https://github.com/NVIDIA/nvidia-docker
- run with
```
nvidia-docker run -d -p 8080:8080 jolibrain/deepdetect_gpu
nvidia-docker run -d -p 8080:8080 docker.jolibrain.com/deepdetect_gpu
```

Notes:
Expand Down Expand Up @@ -88,14 +88,14 @@ Example:

- start container and server:
```
> docker run -d -p 8080:8080 jolibrain/deepdetect_cpu
> docker run -d -p 8080:8080 docker.jolibrain.com/deepdetect_cpu
```

- look for container:
```
> docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
d9944734d5d6 jolibrain/deepdetect_cpu "/bin/sh -c './dede -" 17 seconds ago Up 16 seconds 0.0.0.0:8080->8080/tcp loving_shaw
d9944734d5d6 docker.jolibrain.com/deepdetect_cpu "/bin/sh -c './dede -" 17 seconds ago Up 16 seconds 0.0.0.0:8080->8080/tcp loving_shaw
```

- access server logs:
Expand All @@ -108,7 +108,7 @@ Running DeepDetect HTTP server on 0.0.0.0:8080

- share a volume with the image:
```
docker run -d -p 8080:8080 -v /path/to/volume:/opt/deepdetect jolibrain/deepdetect_cpu
docker run -d -p 8080:8080 -v /path/to/volume:/opt/deepdetect docker.jolibrain.com/deepdetect_cpu
```
where `/path/to/volume` is the path to your local volume that you'd like to attach to `/opt/deepdetect`. This is useful for sharing / saving models, etc...

Expand All @@ -118,7 +118,7 @@ Given a running server on 0.0.0.0:8080, the documentation is served at `http://h

If dede is behind a custom API endpoint, e.g. `hostname:port/api/deepdetect`, swagger links won't work correctly. You can get around this by specifying the api path when you run the docker:
```bash
docker run -d -p 8080:8080 jolibrain/deepdetect_cpu -swagger_api_prefix api/deepdetect/
docker run -d -p 8080:8080 docker.jolibrain.com/deepdetect_cpu -swagger_api_prefix api/deepdetect/
```
You can now serve DeepDetect on `hostname:port/api/deepdetect/` and expect the links in swagger documentation to work correctly.

Expand Down

0 comments on commit a9652f4

Please sign in to comment.