Skip to content

Commit

Permalink
cpu flag for CI + remove latest tag + update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
odulcy-mindee committed Sep 28, 2023
1 parent 2849b6c commit 9f7c649
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
steps:
- uses: actions/checkout@v3
- name: Build docker image
run: docker build . -t doctr-tf-py3.8-slim
run: docker build -t doctr-tf-py3.8-slim --build-arg SYSTEM=cpu .
- name: Run docker container
run: docker run doctr-tf-py3.8-slim python3 -c 'import doctr'

Expand Down
3 changes: 0 additions & 3 deletions .github/workflows/public_docker_images.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,6 @@ jobs:
tags: |
# used only on schedule event
type=schedule,pattern={{date 'YYYY-MM'}},prefix=${{ matrix.framework }}-py${{ matrix.python }}-${{ matrix.system }}-
# set latest tag only if `enable` is True
# see https://github.com/docker/metadata-action#latest-tag
type=raw,value=latest,enable=${{ matrix.framework == 'tf' && matrix.python == '3.8.18' && matrix.system == 'gpu' && github.ref == format('refs/heads/{0}', 'main') }}
# used only if a tag following semver is published
type=semver,pattern={{raw}},prefix=${{ matrix.framework }}-py${{ matrix.python }}-${{ matrix.system }}-
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,24 +272,25 @@ To verify and configure GPU support for Docker, please follow the instructions p
Once Docker is configured to use GPUs, you can run docTR Docker containers with GPU support:

```shell
docker run --it --gpus all ghcr.io/mindee/doctr:tf-py3.8.18-v0.7.1 bash
docker run --it --gpus all ghcr.io/mindee/doctr:tf-py3.8.18-gpu-2023-09 bash
```

#### Available Tags

The Docker images for docTR follow a specific tag nomenclature: `<framework>-py<python_version>-<doctr_version|YYYY-MM>`. Here's a breakdown of the tag structure:
The Docker images for docTR follow a specific tag nomenclature: `<framework>-py<python_version>-<system>-<doctr_version|YYYY-MM>`. Here's a breakdown of the tag structure:

- `<framework>`: `tf` (TensorFlow) or `torch` (PyTorch).
- `<python_version>`: `3.8.18`, `3.9.18`, or `3.10.13`.
- `<system>`: `cpu` or `gpu`
- `<doctr_version>`: a tag >= `v0.7.1`
- `<YYYY-MM>`: e.g. `2023-10`
- `<YYYY-MM>`: e.g. `2023-09`

Here are examples of different image tags:

| Tag | Description |
|----------------------------|---------------------------------------------------|
| `tf-py3.8.18-v0.7.1` | TensorFlow version `3.8.18` with docTR `v0.7.1`. |
| `torch-py3.9.18-2023-10`| PyTorch version `3.9.18` with a monthly build from `2023-10`. |
| `tf-py3.8.18-cpu-v0.7.1` | TensorFlow version `3.8.18` with docTR `v0.7.1`. |
| `torch-py3.9.18-gpu-2023-09`| PyTorch version `3.9.18` with GPU support and a monthly build from `2023-09`. |

#### Building Docker Images Locally

Expand Down

0 comments on commit 9f7c649

Please sign in to comment.