Add test cov and docker images

.github/workflows/build-latest-images.yml

@@ -0,0 +1,40 @@
+name: Build latest images automatically
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    strategy:
+        fail-fast: true
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    # Build docker images
+    -
+      name: Set up QEMU
+      uses: docker/setup-qemu-action@v2
+    -
+      name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v2
+    -
+      name: Login to DockerHub
+      uses: docker/login-action@v2
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_TOKEN }}
+    -
+      name: Build and push
+      id: docker_build_latest
+      uses: docker/build-push-action@v4
+      with:
+        context: .
+        platforms: linux/amd64,linux/arm64/v8
+        file: ./docker/Dockerfile
+        push: true
+        tags: ${{ secrets.DOCKERHUB_USERNAME }}/sdgx:latest

.github/workflows/docker-image.yml

@@ -0,0 +1,33 @@
+name: Testing docker image build
+
+on:
+  pull_request:
+    branches: [ "master", "main" ]
+
+jobs:
+  deploy:
+    strategy:
+        fail-fast: true
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    # Build docker images
+    -
+      name: Set up QEMU
+      uses: docker/setup-qemu-action@v2
+    -
+      name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v2
+    -
+      name: Build image
+      id: docker_build_test
+      uses: docker/build-push-action@v4
+      with:
+        context: .
+        platforms: linux/amd64,linux/arm64/v8
+        file: ./docker/Dockerfile
+        push: false
+        tags: build

.github/workflows/docker-publish.yml

@@ -0,0 +1,39 @@
+name: Release docker image
+
+on:
+  workflow_dispatch: {}
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    -
+      name: Set up QEMU
+      uses: docker/setup-qemu-action@v2
+    -
+      name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v2
+    -
+      name: Login to DockerHub
+      uses: docker/login-action@v2
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_TOKEN }}
+    -
+      name: Build and push
+      id: docker_build_release
+      uses: docker/build-push-action@v4
+      with:
+        context: .
+        platforms: linux/amd64,linux/arm64/v8
+        file: ./docker/Dockerfile
+        push: true
+        tags: ${{ secrets.DOCKERHUB_USERNAME }}/sdgx:${{ github.ref_name }}

.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-name: Upload Python Package and Build Image
+name: Upload Python Package
 
 on:
   release:
@@ -37,39 +37,3 @@ jobs:
         file_glob: true
         tag: ${{ github.ref }}
         overwrite: true
-    # Build docker images
-
-    # TODO: currently we don't provide official images
-    # -
-    #   name: Set up QEMU
-    #   uses: docker/setup-qemu-action@v2
-    # -
-    #   name: Set up Docker Buildx
-    #   uses: docker/setup-buildx-action@v2
-    # -
-    #   name: Login to DockerHub
-    #   uses: docker/login-action@v2
-    #   with:
-    #     username: ${{ secrets.DOCKERHUB_USERNAME }}
-    #     password: ${{ secrets.DOCKERHUB_TOKEN }}
-    # -
-    #   name: Build and push image
-    #   id: docker_build
-    #   uses: docker/build-push-action@v4
-    #   with:
-    #     context: .
-    #     file: ./docker/Dockerfile
-    #     push: true
-    #     tags: ${{ secrets.DOCKERHUB_USERNAME }}/sdgx:${{  github.ref_name }}
-
-    # # Build latest if release
-    # -
-    #   name: Build and push release
-    #   if: '!github.event.release.prerelease'
-    #   id: docker_build_release
-    #   uses: docker/build-push-action@v4
-    #   with:
-    #     context: .
-    #     file: ./docker/Dockerfile
-    #     push: true
-    #     tags: ${{ secrets.DOCKERHUB_USERNAME }}/sdgx:latest

.github/workflows/python-package.yml

@@ -27,4 +27,9 @@ jobs:
         python -m pip install -e .[test]
     - name: Test with pytest
       run: |
-        pytest -vv
+        pytest -vv --cov=sdgx
+    - name: Install dependencies for building
+      run: |
+        pip install build twine hatch
+    - name: Test building
+      run: python -m build

README.md

@@ -36,6 +36,14 @@ High-quality synthetic data can also be used in various fields such as data open
 
 ## 🔛 Quick Start
 
+### Pre-build image
+
+You can use pre-built images to quickly experience the latest features.
+
+```bash
+docker pull idsteam/sdgx:latest
+```
+
 ### Local Install (Recommended)
 
 At present, the code of this project is updated very quickly. We recommend that you use SDG by installing it through the source code.

README_ZH_CN.md

@@ -33,6 +33,14 @@
 
 ## 🔛 快速开始
 
+### 预构建镜像
+
+您可以使用预构建的镜像来快速体验最新功能。
+
+```bash
+docker pull idsteam/sdgx:latest
+```
+
 ### 从本地安装（目前推荐）
 
 目前本项目的代码更新速度快，我们推荐您通过源码进行安装的方式使用SDG。

docker/Dockerfile

@@ -0,0 +1,12 @@
+FROM python:3.10.12-slim-bookworm as builder
+
+RUN pip install build twine hatch
+COPY . /source
+WORKDIR /source
+RUN python -m build
+
+FROM pytorch/pytorch:2.1.0-cuda12.1-cudnn8-runtime
+
+COPY --from=builder /source/dist/*.whl /tmp/
+
+RUN pip install --no-cache-dir /tmp/*.whl

pyproject.toml

@@ -33,7 +33,7 @@ classifiers = [
 ]
 
 [project.optional-dependencies]
-test = ["pytest"]
+test = ["pytest", "pytest-cov"]
 docs = ["Sphinx<=7.2.4", "sphinx-rtd-theme", "sphinx-click", "autodoc_pydantic"]