chore: add run use case example to GH workflow

.github/workflows/run_use_cases_examples.yaml

@@ -0,0 +1,126 @@
+name: Run Use Case Examples
+on:
+  push:
+  # workflow_dispatch: 
+  # schedule:
+  #   - cron: '0 0 * * MON'  # Scheduled trigger every Monday at midnight
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  ACTION_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+
+jobs:
+  start-runner-linux:
+    name: Start EC2 runner
+    runs-on: ubuntu-20.04
+    outputs:
+      label-38: ${{ steps.start-ec2-runner-38.outputs.label }}
+      ec2-instance-id-38: ${{ steps.start-ec2-runner-38.outputs.ec2-instance-id || '' }}
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@8c3f20df09ac63af7b3ae3d7c91f105f857d8497
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ secrets.AWS_REGION }}
+
+      - name: Start EC2 runner python 38
+        id: start-ec2-runner-38
+        uses: machulav/ec2-github-runner@4e0303de215db88e1c489e07a15ca4d867f488ea
+        with:
+          mode: start
+          github-token: ${{ secrets.EC2_RUNNER_BOT_TOKEN }}
+          ec2-image-id: ${{ secrets.AWS_EC2_AMI }}
+          ec2-instance-type: "m6i.metal"
+          subnet-id: ${{ secrets.AWS_EC2_SUBNET_ID }}
+          security-group-id: ${{ secrets.AWS_EC2_SECURITY_GROUP_ID }}
+
+  run-use-case-examples:
+    needs: [start-runner-linux]
+    runs-on: ${{ needs.start-runner-linux.outputs.label-38 }}
+    container:
+      image: ubuntu:20.04
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: Set up Environment
+        run: |
+          # Setup commands if any, for example, installing dependencies, etc.
+          apt-get update && apt-get install -y python3-venv make && apt install git git-lfs -y
+
+      - name: Run Use Case Examples Script
+        run: |
+          chmod +x ./script/make_utils/run_use_case_examples.sh
+          ./script/make_utils/run_use_case_examples.sh
+
+  stop-runner-linux:
+    name: Stop EC2 runner
+    needs: [run-use-case-examples, start-runner-linux]
+    runs-on: ubuntu-20.04
+    if: ${{ always() && (needs.start-runner-linux.result != 'skipped') }}
+    steps:
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@8c3f20df09ac63af7b3ae3d7c91f105f857d8497
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ secrets.AWS_REGION }}
+
+      - name: Stop EC2 runner python 38
+        uses: machulav/ec2-github-runner@4e0303de215db88e1c489e07a15ca4d867f488ea
+        if: ${{ always() && needs.start-runner-linux.outputs.ec2-instance-id-38 }}
+        with:
+          github-token: ${{ secrets.EC2_RUNNER_BOT_TOKEN }}
+          label: ${{ needs.start-runner-linux.outputs.label-38 }}
+          ec2-instance-id: ${{ needs.start-runner-linux.outputs.ec2-instance-id-38 }}
+          mode: stop
+
+  send-report:
+    if: ${{ always() }}
+    needs:
+      [
+        start-runner-linux,
+        run-use-case-examples,
+        stop-runner-linux,
+      ]
+    name: Send Slack notification
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2 # Update to the latest stable version
+
+      - name: Prepare whole job status
+        if: ${{ always() }}
+        continue-on-error: true
+        env:
+          NEEDS_JSON: ${{ toJSON(needs) }}
+        run: |
+          echo "${NEEDS_JSON}" > /tmp/needs_context.json
+          JOB_STATUS=$(python3 ./script/actions_utils/actions_combine_status.py \
+          --needs_context_json /tmp/needs_context.json)
+          echo "JOB_STATUS=${JOB_STATUS}" >> "$GITHUB_ENV"
+
+      - name: Slack Notification
+        if: ${{ always() }}
+        continue-on-error: true
+        uses: rtCamp/action-slack-notify@b24d75fe0e728a4bf9fc42ee217caa686d141ee8
+        env:
+          SLACK_CHANNEL: ${{ secrets.SLACK_CHANNEL }}
+          SLACK_ICON: https://pbs.twimg.com/profile_images/1274014582265298945/OjBKP9kn_400x400.png
+          SLACK_COLOR: ${{ env.JOB_STATUS || 'failure' }}
+          SLACK_MESSAGE: "Full run of use case examples finished with status ${{ env.JOB_STATUS || 'failure' }} \
+            (${{ env.ACTION_RUN_URL }})\n\
+            - start-runner-linux: ${{ needs.start-runner-linux.result || 'Did not run.'}}\n\n\
+            - run-use-case-examples: ${{ needs.run-use-case-examples.result || 'Did not run.' }}\n\n\
+            - stop-runner-linux: ${{ needs.stop-runner-linux.result || 'Did not run.'}}"
+          SLACK_USERNAME: ${{ secrets.BOT_USERNAME }}
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

Makefile

@@ -830,7 +830,7 @@ clean_sklearn_cache:
 
 .PHONY: run_one_use_case_example # Run one use-case example (USE_CASE, eg use_case_examples/hybrid_model)
 run_one_use_case_example:
-	./script/make_utils/run_use_case_examples.sh
+	USE_CASE=$(USE_CASE) ./script/make_utils/run_use_case_examples.sh
 
 .PHONY: run_all_use_case_examples # Run all use-case examples
 run_all_use_case_examples:

script/make_utils/run_use_case_examples.sh

@@ -1,129 +1,113 @@
 #!/usr/bin/env bash
 set -e
 
-DIR=$(dirname "$0")
-
-# shellcheck disable=SC1090,SC1091
-source "${DIR}/detect_docker.sh"
-
-if isDocker; then
-    echo "Can not run in docker -> this script needs to install new virtualenvs"
-    exit 1
-fi
+current_dir=$(pwd)
+use_case_dir_name="use_case_examples"
+use_case_dir="${current_dir}/${use_case_dir_name}"
+
+check_directory_exists() {
+    if [ ! -d "$1" ]; then
+        echo "Error: '$use_case_dir_name' directory must be present in the Concrete ML source root."
+        exit 1
+    fi
+}
+
+check_clean_git_status() {
+    if git ls-files --others --exclude-standard | grep -q "$1"; then
+        echo "Error: This script must be run in a clean clone of the Concrete ML repo."
+        echo "Untracked files detected in $1."
+        echo "List untracked files with: git ls-files --others --exclude-standard | grep $1"
+        echo "Remove untracked files with: git clean -fdx $1"
+        exit 1
+    fi
+}
+
+setup_virtualenv() {
+    local venv_path="/tmp/virtualenv_$1"
+    echo "Setting up virtual environment for $1..."
+    rm -rf "$venv_path"  # Ensure a clean environment
+    python3 -m venv "$venv_path"
+    source "${venv_path}/bin/activate"
+    echo "Virtual environment created at $venv_path."
+}
+
+install_concrete_ml() {
+    pip install -U pip setuptools wheel
+    pip install -e . || return 1
+    echo "Concrete ML installed."
+}
+
+install_requirements() {
+    if [ -f "requirements.txt" ]; then
+        pip install -r requirements.txt || return 1
+        echo "Requirements installed."
+    fi
+}
 
+run_example() {
+    local example_dir=$1
+    local example_name=$(basename "$example_dir")
 
-CML_DIR=$(pwd)
-USE_CASE_REL_DIR="use_case_examples"
-USE_CASE_DIR="${CML_DIR}/${USE_CASE_REL_DIR}"
+    if [ ! -f "${example_dir}/Makefile" ]; then
+        return
+    fi
 
-if [ ! -d "$USE_CASE_DIR" ]; then
-    echo "This script must be run in the Concrete ML source root where the '$USE_CASE_REL_DIR' directory is present"
-    exit 1
-fi
+    echo "*** Processing example $example_name ***"
+    setup_virtualenv "$example_name"
+    cd "$current_dir" || return
+    install_concrete_ml || return
+    cd "$example_dir" || return
+    install_requirements || return
 
-echo "Refreshing notebooks with PIP installed Concrete ML"
+    set +e
+    USE_CASE_DIR=$use_case_dir make 3>&2 2>&1 1>&3- | tee /dev/tty | perl -pe 's/\e[^\[\]]*\[.*?[a-zA-Z]|\].*?\a//g'
+    local result="${PIPESTATUS[0]}"
+    set -e
+    if [ "$result" -ne 0 ]; then
+        echo "Error while running example $example_name."
+        failed_examples+=("$example_name")
+    else
+        success_examples+=("$example_name")
+    fi
+    deactivate
+    rm -rf "/tmp/virtualenv_$example_name"
+}
 
-# shellcheck disable=SC2143
-if [[ $(git ls-files --others --exclude-standard | grep ${USE_CASE_REL_DIR}) ]]; then
-    echo "This script must be run in a clean clone of the Concrete ML repo"
-    echo "This directory has untracked files in ${USE_CASE_REL_DIR}"
-    echo "You can LIST all untracked files using: "
+print_summary() {
     echo
-    # shellcheck disable=SC2028
-    echo "   git ls-files --others --exclude-standard | grep ${USE_CASE_REL_DIR}"
-    echo
-    echo "You can REMOVE all untracked files using: "
-    echo
-    # shellcheck disable=SC2028
-    echo "   git ls-files --others --exclude-standard | grep ${USE_CASE_REL_DIR} | xargs -0 -d '\n' --no-run-if-empty rm"
-    echo
-    exit 1
-fi
-
-if [[ -z "${USE_CASE}" ]]; then
-  # shellcheck disable=SC2207
-  LIST_OF_USE_CASES=($(find "$USE_CASE_DIR/" -mindepth 1 -maxdepth 2 -type d | grep -v checkpoints))
-else
-  LIST_OF_USE_CASES=("${USE_CASE}")
-  if [ ! -d "${USE_CASE}" ]; then 
-    echo "The use case specified to be executed, ${USE_CASE}, does not exist"
-    exit 1
-  fi
-fi
-
-if [ ! "$(docker images -q zamafhe/concrete-ml:latest 2> /dev/null)" ]; then
-    # BUILD THE DOCKER IMAGE
-    echo "Building docker image"
-    poetry build && mkdir -p pkg && cp dist/* pkg/ && make release_docker
-    docker tag concrete-ml-release:latest zamafhe/concrete-ml:latest
-fi
-
-# shellcheck disable=SC2068
-for EXAMPLE in ${LIST_OF_USE_CASES[@]}
-do
-    EXAMPLE_NAME=$(basename "${EXAMPLE}")
-
-    if [ -f "${EXAMPLE}/Makefile" ]; then
-        echo "*** Processing example ${EXAMPLE_NAME}"
+    echo "Summary:"
+    echo "Successes: ${#success_examples[@]}"
+    for example in "${success_examples[@]}"; do
+        echo "  - $example"
+    done
+    echo "Failures: ${#failed_examples[@]}"
+    for example in "${failed_examples[@]}"; do
+        echo "  - $example"
+    done
+}
+
+main() {
+    check_directory_exists "$use_case_dir"
+    check_clean_git_status "$use_case_dir_name"
+
+    declare -a success_examples
+    declare -a failed_examples
+
+    if [[ -z "${USE_CASE}" ]]; then
+        LIST_OF_USE_CASES=($(find "$use_case_dir/" -mindepth 1 -maxdepth 2 -type d | grep -v checkpoints | sort))
     else
-        continue
+        LIST_OF_USE_CASES=("${use_case_dir}/${USE_CASE}")
     fi
 
-    # Setup a new venv
-    VENV_PATH="/tmp/virtualenv_${EXAMPLE_NAME}"
-    if [ -d "$VENV_PATH" ]; then
-        echo " - VirtualEnv already exists, deleting the old one"
-        rm -rf "$VENV_PATH"
-    fi
-    virtualenv -q "$VENV_PATH"
-    echo " - VirtualEnv created at $VENV_PATH"
-    # shellcheck disable=SC1090,SC1091
-    source "${VENV_PATH}/bin/activate"
-    # Install Concrete ML
-    set +e
-    cd "$CML_DIR"
-    pip install -e . &> "/tmp/log_cml_pip_${EXAMPLE_NAME}"
-    hresult=$?
-    if [ $hresult -ne 0 ]; then
-        echo "Could not install Concrete ML in the virtualenv, see /tmp/log_cml_pip_${EXAMPLE_NAME}"
-        rm -rf "$VENV_PATH"
-        continue
-    fi
-    set -e
-    echo " - Concrete ML installed in $VENV_PATH"
+    for use_case in "${LIST_OF_USE_CASES[@]}"; do
+        run_example "$use_case"
+    done
 
-    # Install example requirements
-    cd "$EXAMPLE"
-    if [ -f "requirements.txt" ]; then
-        set +e
-        pip install -r requirements.txt &> "/tmp/log_reqs_${EXAMPLE_NAME}"
-        hresult=$?
-        set -e
-        if [ $hresult -ne 0 ]; then
-            echo "Could not install Concrete ML in the virtualenv, see /tmp/log_reqs_${EXAMPLE_NAME}"
-            rm -rf "$VENV_PATH"
-            continue
-        fi     
-        echo " - Requirements installed in $VENV_PATH"
-    fi
-
-    set +e
-    # Strip colors from the error output before piping to the log files
-    # Swap stderr and stdout, all output of jupyter execution is in stderr
-    # The information about time spent running the notebook is in stdout
-    # The following will pipe the stderr to the regex so that it 
-    # ends up in the log file.
-    # The timing shows in the terminal
-    USE_CASE_DIR=$USE_CASE_DIR make 3>&2 2>&1 1>&3- | perl -pe 's/\e([^\[\]]|\[.*?[a-zA-Z]|\].*?\a)//g' > "/tmp/log_${EXAMPLE_NAME}"
-
-    # Neet to check the result of execution of the make command (ignore the results 
-    # of the other commands in the pipe)
-    hresult="${PIPESTATUS[0]}"
-    if [ "$hresult" -ne 0 ]; then
-        echo "Error while running example ${EXAMPLE_NAME} see /tmp/log_${EXAMPLE_NAME}"
+    print_summary
+
+    if [ ${#failed_examples[@]} -ne 0 ]; then
+        exit 1
     fi
-    set -e             
+}
 
-    # Remove the virtualenv
-    rm -rf "$VENV_PATH"
-done
+main "$@"

use_case_examples/cifar/cifar_brevitas_training/Makefile

@@ -2,7 +2,7 @@
 export LC_ALL=en_US.UTF-8
 export LANG=en_US.UTF-8
 
-EXAMPLE_NAME=cifar_brevitas_finetuning
+EXAMPLE_NAME=cifar_brevitas_training
 JUPYTER_RUN=jupyter nbconvert --to notebook --inplace --execute
 TIME_NB="${USE_CASE_DIR}/time_notebook_execution.sh"
 

use_case_examples/credit_scoring/Makefile

@@ -0,0 +1,12 @@
+# Useful for jupyter notebooks
+export LC_ALL=en_US.UTF-8
+export LANG=en_US.UTF-8
+
+EXAMPLE_NAME=credit_scoring
+JUPYTER_RUN=jupyter nbconvert --to notebook --inplace --execute
+TIME_NB="${USE_CASE_DIR}/time_notebook_execution.sh"
+
+run_example: one
+
+one:
+	@$(TIME_NB) CreditScoring.ipynb