Docker Publish & Test #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Copyright 2025 The HuggingFace Inc. team. All rights reserved. | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| # This workflow handles Docker image publishing & testing. | |
| name: Docker Publish & Test | |
| permissions: | |
| contents: read | |
| on: | |
| # Allows running this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Runs at 02:00 | |
| schedule: | |
| - cron: "0 2 * * *" | |
| # Sets up the environment variables | |
| env: | |
| UV_VERSION: "0.8.0" | |
| PYTHON_VERSION: "3.12" | |
| DOCKER_IMAGE_NAME_CPU: huggingface/lerobot-cpu:latest | |
| DOCKER_IMAGE_NAME_GPU: huggingface/lerobot-gpu:latest | |
| # Ensures that only the latest commit is built, canceling older runs. | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| jobs: | |
| # This job builds a CPU image for testing & distribution | |
| build-docker-cpu: | |
| name: Build CPU Docker | |
| runs-on: | |
| group: aws-general-8-plus | |
| if: github.repository == 'huggingface/lerobot' | |
| outputs: | |
| image_tag: ${{ env.DOCKER_IMAGE_NAME_CPU }} | |
| steps: | |
| - name: Install Git LFS | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install git-lfs | |
| git lfs install | |
| - uses: actions/checkout@v6 | |
| with: | |
| lfs: true | |
| persist-credentials: false | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v3 # zizmor: ignore[unpinned-uses] | |
| with: | |
| cache-binary: false | |
| - name: Login to Docker Hub | |
| uses: docker/login-action@v3 # zizmor: ignore[unpinned-uses] | |
| with: | |
| username: ${{ secrets.DOCKERHUB_LEROBOT_USERNAME }} | |
| password: ${{ secrets.DOCKERHUB_LEROBOT_PASSWORD }} | |
| - name: Build and push Docker image CPU | |
| uses: docker/build-push-action@v6 # zizmor: ignore[unpinned-uses] | |
| with: | |
| context: . | |
| file: ./docker/Dockerfile.user | |
| push: true | |
| tags: ${{ env.DOCKER_IMAGE_NAME_CPU }} | |
| # This job builds a GPU image for testing & distribution | |
| build-docker-gpu: | |
| name: Build GPU Docker | |
| runs-on: | |
| group: aws-general-8-plus | |
| if: github.repository == 'huggingface/lerobot' | |
| outputs: | |
| image_tag: ${{ env.DOCKER_IMAGE_NAME_GPU }} | |
| steps: | |
| - name: Install Git LFS | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install git-lfs | |
| git lfs install | |
| - uses: actions/checkout@v6 | |
| with: | |
| lfs: true | |
| persist-credentials: false | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v3 # zizmor: ignore[unpinned-uses] | |
| with: | |
| cache-binary: false | |
| - name: Login to Docker Hub | |
| uses: docker/login-action@v3 # zizmor: ignore[unpinned-uses] | |
| with: | |
| username: ${{ secrets.DOCKERHUB_LEROBOT_USERNAME }} | |
| password: ${{ secrets.DOCKERHUB_LEROBOT_PASSWORD }} | |
| - name: Build and push Docker image GPU | |
| uses: docker/build-push-action@v6 # zizmor: ignore[unpinned-uses] | |
| with: | |
| context: . | |
| file: ./docker/Dockerfile.internal | |
| push: true | |
| tags: ${{ env.DOCKER_IMAGE_NAME_GPU }} | |
| # This job runs the E2E tests + pytest with all extras in the CPU image | |
| cpu-tests: | |
| name: CPU Tests | |
| needs: [build-docker-cpu] | |
| runs-on: | |
| group: aws-g6-4xlarge-plus | |
| env: | |
| HF_HOME: /home/user_lerobot/.cache/huggingface | |
| HF_LEROBOT_HOME: /home/user_lerobot/.cache/huggingface/lerobot | |
| TORCH_HOME: /home/user_lerobot/.cache/torch | |
| TRITON_CACHE_DIR: /home/user_lerobot/.cache/triton | |
| HF_USER_TOKEN: ${{ secrets.LEROBOT_HF_USER }} | |
| container: | |
| image: ${{ needs.build-docker-cpu.outputs.image_tag }} # zizmor: ignore[unpinned-images] | |
| options: --shm-size "16gb" | |
| credentials: | |
| username: ${{ secrets.DOCKERHUB_LEROBOT_USERNAME }} | |
| password: ${{ secrets.DOCKERHUB_LEROBOT_PASSWORD }} | |
| defaults: | |
| run: | |
| shell: bash | |
| working-directory: /lerobot | |
| steps: | |
| - name: Login to Hugging Face | |
| if: env.HF_USER_TOKEN != '' | |
| run: | | |
| hf auth login --token "$HF_USER_TOKEN" --add-to-git-credential | |
| hf auth whoami | |
| - name: Run pytest on CPU | |
| run: pytest tests -vv --maxfail=10 | |
| - name: Run end-to-end tests | |
| run: make test-end-to-end | |
| # This job runs the E2E tests + pytest with all extras in the GPU image | |
| gpu-tests: | |
| name: GPU Tests | |
| needs: [build-docker-gpu] | |
| runs-on: | |
| group: aws-g6-4xlarge-plus | |
| env: | |
| HF_HOME: /home/user_lerobot/.cache/huggingface | |
| HF_LEROBOT_HOME: /home/user_lerobot/.cache/huggingface/lerobot | |
| TORCH_HOME: /home/user_lerobot/.cache/torch | |
| TRITON_CACHE_DIR: /home/user_lerobot/.cache/triton | |
| HF_USER_TOKEN: ${{ secrets.LEROBOT_HF_USER }} | |
| container: | |
| image: ${{ needs.build-docker-gpu.outputs.image_tag }} # zizmor: ignore[unpinned-images] | |
| options: --gpus all --shm-size "16gb" | |
| credentials: | |
| username: ${{ secrets.DOCKERHUB_LEROBOT_USERNAME }} | |
| password: ${{ secrets.DOCKERHUB_LEROBOT_PASSWORD }} | |
| defaults: | |
| run: | |
| shell: bash | |
| working-directory: /lerobot | |
| steps: | |
| - name: Login to Hugging Face | |
| if: env.HF_USER_TOKEN != '' | |
| run: | | |
| hf auth login --token "$HF_USER_TOKEN" --add-to-git-credential | |
| hf auth whoami | |
| - name: Run pytest on GPU | |
| run: pytest tests -vv --maxfail=10 | |
| - name: Run end-to-end tests | |
| run: make test-end-to-end | |
| # This job runs multi-GPU training tests with 4 GPUs | |
| multi-gpu-tests: | |
| name: Multi-GPU Tests | |
| needs: [build-docker-gpu] | |
| runs-on: | |
| group: aws-g4dn-12xlarge # Instance with 4 GPUs | |
| env: | |
| HF_HOME: /home/user_lerobot/.cache/huggingface | |
| HF_LEROBOT_HOME: /home/user_lerobot/.cache/huggingface/lerobot | |
| TORCH_HOME: /home/user_lerobot/.cache/torch | |
| TRITON_CACHE_DIR: /home/user_lerobot/.cache/triton | |
| CUDA_VISIBLE_DEVICES: "0,1,2,3" | |
| HF_USER_TOKEN: ${{ secrets.LEROBOT_HF_USER }} | |
| container: | |
| image: ${{ needs.build-docker-gpu.outputs.image_tag }} # zizmor: ignore[unpinned-images] | |
| options: --gpus all --shm-size "16gb" | |
| credentials: | |
| username: ${{ secrets.DOCKERHUB_LEROBOT_USERNAME }} | |
| password: ${{ secrets.DOCKERHUB_LEROBOT_PASSWORD }} | |
| defaults: | |
| run: | |
| shell: bash | |
| working-directory: /lerobot | |
| steps: | |
| - name: Login to Hugging Face | |
| if: env.HF_USER_TOKEN != '' | |
| run: | | |
| hf auth login --token "$HF_USER_TOKEN" --add-to-git-credential | |
| hf auth whoami | |
| - name: Verify GPU availability | |
| run: | | |
| nvidia-smi | |
| python -c "import torch; print(f'PyTorch CUDA available: {torch.cuda.is_available()}'); print(f'Number of GPUs: {torch.cuda.device_count()}')" | |
| - name: Run multi-GPU training tests | |
| run: pytest -vv tests/training/ |