Feature/update quickstart from template

.github/workflows/update-templates-to-examples.yml

@@ -136,7 +136,7 @@ jobs:
         with:
           python-version: ${{ inputs.python-version }}
           stack-name: local
-          ref-zenml: 'main'
+          ref-zenml: ${{ github.ref }}
           ref-template: '0.45.0' # Make sure it is aligned with ZENML_PROJECT_TEMPLATES from src/zenml/cli/base.py
 
       - name: Clean-up
@@ -192,4 +192,85 @@ jobs:
               owner: context.repo.owner,
               repo: context.repo.repo,
               body: 'NLP template updates in `examples/nlp-case` have been pushed.'
+            })
+
+
+  update-starter-template-to-examples:
+    name: update-starter-template-to-examples
+    runs-on: ${{ inputs.os }}
+    env:
+      ZENML_DEBUG: 1
+      ZENML_ANALYTICS_OPT_IN: false
+      PYTHONIOENCODING: "utf-8"
+      OBJC_DISABLE_INITIALIZE_FORK_SAFETY: "YES"
+    if: github.event_name == 'pull_request' && ! startsWith(github.event.head_commit.message, 'GitBook:')
+
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+      - name: Run template tests for zenml-io/template-starter
+        uses: zenml-io/template-starter/.github/actions/starter_template_test@main
+        with:
+          python-version: ${{ inputs.python-version }}
+          stack-name: local
+          ref-zenml: ${{ github.ref }}
+          ref-template: '2023.12.18' # Make sure it is aligned with ZENML_PROJECT_TEMPLATES from src/zenml/cli/base.py
+
+      - name: Clean-up
+        run: |
+          rm -rf ./local_checkout
+
+      - name: message-on-error
+        if: failure()
+        run: |
+          echo "::error title=zenml-io/template-starter project template testing failed with new version of 
+            ZenML core!::\
+            Breaking changes affecting templates have been introduced. To mitigate this issue,\
+            please make the code in zenml-io/template-starter compatible with new version of\
+            ZenML core, release it and update release tag in zenml.cli.base.ZENML_PROJECT_TEMPLATES"
+
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      - name: Check-out fresh Starter template
+        run: |
+          rm -rf examples/quickstart
+          mkdir -p examples/quickstart
+          printf 'info@zenml.io' | zenml init --path examples/quickstart --template starter --template-with-defaults
+          bash scripts/format.sh
+
+      - name: Check for changes
+        id: check_changes
+        run: |
+          if git diff --quiet "origin/${{ github.event.pull_request.head.ref }}"; then
+            echo "No active Git changes found."
+            echo "changes=false" >> $GITHUB_OUTPUT
+          else
+            echo "Active Git changes found."
+            echo "changes=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Commit and push template
+        if: steps.check_changes.outputs.changes == 'true'
+        run: |
+          git config --global user.name "GitHub Actions"
+          git config --global user.email "actions@github.com"
+          git add .
+          git commit -am "Auto-update of Starter template"
+          git push origin HEAD:${{ github.event.pull_request.head.ref }}
+
+      - name: Create PR comment
+        if: steps.check_changes.outputs.changes == 'true'
+        uses: actions/github-script@v4
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            github.issues.createComment({
+              issue_number: ${{ github.event.pull_request.number }},
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: 'Quickstart template updates in `examples/quickstart` have been pushed.'
             })

examples/e2e/.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 2023.12.06-4-g1e3edc6
+_commit: 2023.12.12
 _src_path: gh:zenml-io/template-e2e-batch
 data_quality_checks: true
 email: ''

examples/quickstart/.copier-answers.yml

@@ -0,0 +1,8 @@
+# Changes here will be overwritten by Copier
+_commit: 0.43.0-48-g652a614
+_src_path: gh:zenml-io/template-starter
+email: ''
+full_name: ZenML GmbH
+open_source_license: apache
+project_name: ZenML Starter
+version: 0.1.0

examples/quickstart/.dockerignore

@@ -0,0 +1,2 @@
+.venv*
+.requirements*

examples/quickstart/LICENSE

@@ -0,0 +1,15 @@
+Apache Software License 2.0
+
+Copyright (c) ZenML GmbH 2023. 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.

examples/quickstart/configs/feature_engineering.yaml

@@ -0,0 +1,10 @@
+# environment configuration
+settings:
+  docker:
+    required_integrations:
+      - sklearn
+    requirements:
+      - pyarrow
+
+# pipeline configuration
+test_size: 0.35

examples/quickstart/configs/inference.yaml

@@ -0,0 +1,15 @@
+# environment configuration
+settings:
+  docker:
+    required_integrations:
+      - sklearn
+    requirements:
+      - pyarrow
+
+# configuration of the Model Control Plane
+model_version:
+  name: "breast_cancer_classifier"
+  version: "production"
+  license: Apache 2.0
+  description: A breast cancer classifier
+  tags: ["breast_cancer", "classifier"]

examples/quickstart/configs/training_rf.yaml

@@ -0,0 +1,19 @@
+# environment configuration
+settings:
+  docker:
+    required_integrations:
+      - sklearn
+    requirements:
+      - pyarrow
+
+# configuration of the Model Control Plane
+model_version:
+  name: breast_cancer_classifier
+  version: rf
+  license: Apache 2.0
+  description: A breast cancer classifier
+  tags: ["breast_cancer", "classifier"]
+
+# Configure the pipeline
+parameters:
+  model_type: "rf"  # Choose between rf/sgd

examples/quickstart/configs/training_sgd.yaml

@@ -0,0 +1,19 @@
+# environment configuration
+settings:
+  docker:
+    required_integrations:
+      - sklearn
+    requirements:
+      - pyarrow
+
+# configuration of the Model Control Plane
+model_version:
+  name: breast_cancer_classifier
+  version: sgd
+  license: Apache 2.0
+  description: A breast cancer classifier
+  tags: ["breast_cancer", "classifier"]
+
+# Configure the pipeline
+parameters:
+  model_type: "sgd"  # Choose between rf/sgd

examples/quickstart/license

@@ -0,0 +1,15 @@
+Apache Software License 2.0
+
+Copyright (c) ZenML GmbH 2023. 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.

examples/quickstart/license_header

@@ -0,0 +1,16 @@
+Apache Software License 2.0
+# 
+# Copyright (c) ZenML GmbH 2023. 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.
+#