Skip to content

Commit

Permalink
Merge branch 'main' into bugfix/line-length-fix
Browse files Browse the repository at this point in the history
  • Loading branch information
stefannica authored Feb 8, 2023
2 parents 00f97d3 + 92307e2 commit 9ff3fca
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
13 changes: 9 additions & 4 deletions copier.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,17 @@ auto_format:
use_step_params:
type: bool
help: "Would you like to see step parameters being used in the generated \n ZenML steps?"
default: false
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: false
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: false
default: true
when: "{{ template == 'starter' and use_step_params }}"
sklearn_dataset_name:
type: str
Expand All @@ -77,7 +77,12 @@ configurable_model:
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: false
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
Expand Down
8 changes: 4 additions & 4 deletions starter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ other ML framework.
| Project Version | The version of your project | 0.1.0 |
| Project License | The license under which your project will be released (one of `Apache Software License 2.0`, `MIT license`, `BSD license`, `ISC license`, `GNU General Public License v3` and `Not open source`) | Apache Software License 2.0 |
| Auto-Format | Whether to automatically format and cleanup the generated code with [black](https://black.readthedocs.io/), [ruff](https://beta.ruff.rs/docs/) and [autoflake](https://github.com/PyCQA/autoflake) (yes/no). You also need to have these Python packages installed for this option to take effect. | no |
| Use ZenML Step Params | Whether to showcase using parameters for the ZenML steps in the project (yes/no). If selected, all generated ZenML pipeline steps will be parameterized. | no |
| Use ZenML Materializers | Whether to showcase using custom data types for the ZenML artifacts in the project (yes/no). If selected, the generated code will demonstrate the use of custom artifact data types and materializers in the generated steps and pipelines. | no |
| Use ZenML Step Params | Whether to showcase using parameters for the ZenML steps in the project (yes/no). If selected, all generated ZenML pipeline steps will be parameterized. | yes |
| Use ZenML Materializers | Whether to showcase using custom data types for the ZenML artifacts in the project (yes/no). If selected, the generated code will demonstrate the use of custom artifact data types and materializers in the generated steps and pipelines. | yes |
| UCI Dataset | The name of the UCI provided scikit-learn dataset to use in the project (one of `Iris`, `Breast Cancer` and `Wine`) | Wine |
| Scikit-learn Model | The name of the scikit-learn classifier model to use in the project (one of `Logistic Regression`, `SVC`, `Linear SVC`, `Random Forest`, `KNN`, `Gaussian NB`, `Perceptron`, `SGD Classifier` and `Decision Tree`) | Logistic Regression |
| Runtime Configurable Dataset | Whether to make the dataset a configurable parameter of the data loader step and CLI (yes/no). Only has effect if the step parameters were also selected. | no |
| Runtime Configurable Model | Whether to make the model a configurable parameter of the model trainer step and CLI (yes/no). Only has effect if the step parameters were also selected. | no |
| Runtime Configurable Dataset | Whether to make the dataset a configurable parameter of the data loader step and CLI (yes/no). Only has effect if the step parameters were also selected. | yes |
| Runtime Configurable Model | Whether to make the model a configurable parameter of the model trainer step and CLI (yes/no). Only has effect if the step parameters were also selected. | yes |

## 🚀 Generate a ZenML Project

Expand Down

0 comments on commit 9ff3fca

Please sign in to comment.