Update starter tempalte (#12)

* Simplified starter * Template * Latest * Steps * Works until inference pipeline * Works until inference pipeline * Run py cleaned * Fixing * Updated * Updated * new notebook * new notebook * new notebook * Images * Cleaned up and finalized for alexej * Initial changes * Removed some copier options * Compared with e2e template * Removed templateized ipynb * Many things in this commit - Formatted, darglinted, added complex promotion logic, added two trainins runs etc * Latest changes * README * New readme * LatesT * LatesT * Woot * took out final comment * Notebook cleaned * Further cleanup, fix caching and artifact version fetching, move random sate * readme update * Fixed non-rendering visualizations * Updated * Updated * new CTA * new CTA * Updated * add image optimizer * Optimised images with calibre/image-actions * imporve ci * fix ci * fix ci/tests * vscode * remove mlflow reqs * fix tests * add `--no-cache` * use SafeLoader * fix img paths * YAML requirements fixed --------- Co-authored-by: Hamza Tahir <[email protected]> Co-authored-by: Alexej Penner <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
zenml-io · Dec 20, 2023 · 928bc41 · 928bc41
1 parent 59f1687
commit 928bc41
Show file tree

Hide file tree

Showing 62 changed files with 2,440 additions and 1,918 deletions.
diff --git a/.github/actions/starter_template_test/action.yml b/.github/actions/starter_template_test/action.yml
@@ -69,7 +69,7 @@ runs:
     - name: Concatenate requirements
       shell: bash
       run: |
-        zenml integration export-requirements -o ./local_checkout/integration-requirements.txt sklearn mlflow s3 kubernetes kubeflow slack evidently
+        zenml integration export-requirements -o ./local_checkout/integration-requirements.txt sklearn
         cat ./local_checkout/requirements.txt ./local_checkout/test-requirements.txt ./local_checkout/integration-requirements.txt >> ./local_checkout/all-requirements.txt
 
     - name: Install requirements

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,7 +2,25 @@ name: CI
 
 on:
   workflow_dispatch:
+    inputs:
+      ref-template:
+        description: 'Branch or tag ref to check out for template'
+        type: string
+        required: false
+      ref-zenml:
+        description: 'Branch or tag ref to check out for ZenML'
+        type: string
+        required: false
   workflow_call:
+    inputs:
+      ref-template:
+        description: 'Branch or tag ref to check out for template'
+        type: string
+        required: false
+      ref-zenml:
+        description: 'Branch or tag ref to check out for ZenML'
+        type: string
+        required: false
   push:
     branches: ["main", "develop"]
     paths-ignore: ["README.md"]
@@ -19,6 +37,7 @@ jobs:
   run-tests:
     runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
         stack-name: [local]
         os: [windows-latest, ubuntu-latest, macos-latest]
@@ -36,3 +55,5 @@ jobs:
         with:
           stack-name: ${{ matrix.stack-name }}
           python-version: ${{ matrix.python-version }}
+          ref-zenml: ${{ inputs.ref-zenml || 'feature/update-quickstart-from-template' }}
+          ref-template: ${{ inputs.ref-template || github.ref }}
diff --git a/.github/workflows/image-optimizer.yml b/.github/workflows/image-optimizer.yml
@@ -0,0 +1,26 @@
+name: Compress Images
+on:
+  pull_request:
+    # Run Image Actions when JPG, JPEG, PNG or WebP files are added or changed.
+    # See https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onpushpull_requestpaths for reference.
+    paths:
+      - '**.jpg'
+      - '**.jpeg'
+      - '**.png'
+      - '**.webp'
+jobs:
+  build:
+    # Only run on non-draft PRs within the same repository.
+    if: github.event.pull_request.head.repo.full_name == github.repository && github.event.pull_request.draft == false
+    name: calibreapp/image-actions
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+
+      - name: Compress Images
+        uses: calibreapp/image-actions@main
+        with:
+          # The `GITHUB_TOKEN` is automatically generated by GitHub and scoped only to the repository that is currently running the action. By default, the action can’t update Pull Requests initiated from forked repositories.
+          # See https://docs.github.com/en/actions/reference/authentication-in-a-workflow and https://help.github.com/en/articles/virtual-environments-for-github-actions#token-permissions
+          githubToken: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -98,6 +98,9 @@ __pypackages__/
 celerybeat-schedule
 celerybeat.pid
 
+# PyCharm Stuff
+.idea
+
 # SageMath parsed files
 *.sage.py
 
@@ -127,3 +130,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+*.zen
+.vscode
diff --git a/README.md b/README.md
@@ -1,15 +1,16 @@
 # 📜 ZenML Project Templates
 
-This repository contains a collection of templates from which a ZenML project
-can be generated: a collection of steps, pipelines, stack configurations and
+This repository contains a starter template from which a simple ZenML project
+can be generated easily. It contains a collection of steps, pipelines, stack configurations and
 other artifacts and useful resources that can get you started with ZenML.
 
-🔥 **Do you have a personal project powered by ZenML that you would like to see here?** At
-ZenML, we are looking for design partnerships and collaboration to help us
+🔥 **Do you have a personal project powered by ZenML that you would like to see here?** 
+
+At ZenML, we are looking for design partnerships and collaboration to help us
 better understand the real-world scenarios in which MLOps is being used and to
 build the best possible experience for our users. If you are interested in
 sharing all or parts of your project with us in the form of a ZenML project
-template, please [join our Slack](https://zenml.io/slack-invite/) and leave us a
+template, please [join our Slack](https://zenml.io/slack/) and leave us a
 message!
 
 ## 📦 Prerequisites
@@ -18,7 +19,7 @@ To use the templates, you need to have Zenml and its `templates` extras
 installed: 
 
 ```bash
-pip install zenml[templates]
+pip install "zenml[templates]"
 ```
 
 ## 🚀 Generate a ZenML Project
@@ -35,7 +36,7 @@ library and a set of Jinja2 templates to generate the project. So you may also
 interact with Copier directly to generate a project, e.g.:
 
 ```bash
-copier gh:zenml-io/zenml-project-templates <directory>
+copier gh:zenml-io/template-starter <directory>
 ```
 
 You will be prompted to select the project template and enter various values for
@@ -47,11 +48,5 @@ the same command again. If you want to skip the prompts to use the values you
 already entered and overwrite all files in the existing project, you can run:
 
 ```bash
-copier -wf gh:zenml-io/zenml-project-templates <directory>
-```
-
-## 📃 List of Project Templates
-
-| Project Template | Tags     | Description                                                                       |
-|------------------|----------|-----------------------------------------------------------------------------------|
-| [ZenML Starter](https://github.com/zenml-io/zenml-project-templates/tree/main/starter) | basic scikit-learn | All the basic ML ingredients you need to get you started with ZenML: parameterized steps, a model training pipeline, a flexible configuration and a simple CLI. All created around a representative and versatile model training use-case implemented with the scikit-learn library. |
+copier -wf gh:zenml-io/template-starter <directory>
+```
diff --git a/copier.yaml b/copier.yaml
@@ -1,12 +1,4 @@
 --- # GLOBAL PROMPT --------------------------------
-
-template:
-    type: str
-    help: >-
-        The project template you would like to use
-    choices:
-        ZenML Starter: starter
-    default: starter
 project_name:
     type: str
     help: Short name for your project
@@ -40,70 +32,10 @@ email:
         The email of the person/entity holding the copyright
     default: [email protected]
     when: "{{ open_source_license }}"
-auto_format:
-    type: bool
-    help: "Auto-format the generated code with black, ruff and autoflake? \n   (NOTE: you need to have these tools installed in your environment)"
-    default: false
-
-# SUB-TEMPLATE PROMPT [starter] ---------------------
-use_step_params:
-    type: bool
-    help: "Would you like to see step parameters being used in the generated \n   ZenML steps?"
-    default: true
-    when: "{{ template == 'starter' }}"
-use_custom_artifacts:
-    type: bool
-    help: "Would you like to see custom artifact data types and materializers \n   being used in the generated ZenML steps and pipelines?"
-    default: true
-    when: "{{ template == 'starter' }}"
-configurable_dataset:
-    type: bool
-    help: "Would you like to be able to select the dataset used in model training\n   at runtime through the CLI and as a data loader step parameter?"
-    default: true
-    when: "{{ template == 'starter' and use_step_params }}"
-sklearn_dataset_name:
-    type: str
-    help: "The generated ZenML project will be populated with some example code
-    \n   featuring one of the UCI ML datasets from scikit-learn. \n   Which
-    dataset would you like to see being used in the generated code?"
-    choices:
-        UCI Wine Data Set (classification): wine
-        UCI Iris Data Set (classification): iris
-        UCI Breast Cancer Wisconsin (Diagnostic) Data Set (classification): breast_cancer
-    default: wine
-    when: "{{ template == 'starter' }}"
-configurable_model:
-    type: bool
-    help: "Would you like to be able to select the type of model used in model \n
-    training at runtime through the CLI and as a model trainer step \n
-    parameter?"
-    default: true
-    help: >-
-        Would you like to be able to select the type of model used in model
-        training at runtime through the CLI and as a model trainer step
-        parameter ?
-    default: true
-    when: "{{ template == 'starter' and use_step_params }}"
-sklearn_model_name:
-    type: str
-    help: "The generated ZenML project will be populated with some example code
-    \n   featuring one of the scikit-learn classifier models. \n   Which model class would you like to see being used in the generated code?"
-    choices:
-        Logistic Regression: LogisticRegression
-        C-Support Vector Classification: SVC
-        Linear Support Vector Classification: LinearSVC
-        Random Forest Classifier: RandomForestClassifier
-        K-Nearest Neighbors Classifier: KNeighborsClassifier
-        Gaussian Naive Bayes: GaussianNB
-        Linear Perceptron Classifier: Perceptron
-        Stochastic Gradient Descent Linear Classifier: SGDClassifier
-        Decision Tree Classifier: DecisionTreeClassifier
-    default: LogisticRegression
-    when: "{{ template == 'starter' }}"
 
 # CONFIGURATION -------------------------
 _templates_suffix: ""
-_subdirectory: "{{ template }}/template"
+_subdirectory: "./template"
 _exclude:
     - /README.md
 _tasks:

diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,5 @@
-scikit-learn
+scikit-learn<1.3
 copier
 jinja2-time
+zenml[server]>=0.52.0
+notebook
diff --git a/starter/README.md b/starter/README.md