From 5d21ab4ee11bbd93bf3c0c3552903aca81e60e1b Mon Sep 17 00:00:00 2001 From: Hamza Tahir Date: Thu, 11 Mar 2021 18:06:40 +0100 Subject: [PATCH] preparing 0.3.4 --- RELEASE_NOTES.md | 42 ++++++++++++++++++++++++++++++++++++++++++ zenml/VERSION | 2 +- 2 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 RELEASE_NOTES.md diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md new file mode 100644 index 00000000000..715103482da --- /dev/null +++ b/RELEASE_NOTES.md @@ -0,0 +1,42 @@ +# 0.3.4 +This release is a big design change and refactor. It involves a significant change in the Configuration file structure, meaning this is a **breaking upgrade**. +For those upgrading from an older version of ZenML, we ask to please delete their old `pipelines` dir and `.zenml` folders and start afresh with a `zenml init`. + +If only working locally, this is as simple as: + +``` +cd zenml_enabled_repo +rm -rf pipelines/ +rm -rf .zenml/ +``` + +And then another ZenML init: + +``` +pip install --upgrade zenml +cd zenml_enabled_repo +zenml init +``` + +# New Features +* Introduced another higher-level pipeline: The [NLPPipeline](https://github.com/maiot-io/zenml/blob/main/zenml/pipelines/nlp_pipeline.py). This is a generic + NLP pipeline for a text-datasource based training task. Full example of how to use the NLPPipeline can be found [here](https://github.com/maiot-io/zenml/tree/main/examples/nlp) +* Introduced a [BaseTokenizerStep](https://github.com/maiot-io/zenml/blob/main/zenml/steps/tokenizer/base_tokenizer.py) as a simple mechanism to define how to train and encode using any generic +tokenizer (again for NLP-based tasks). + +# Bug Fixes + Refactor +* Significant change to imports: Now imports are way simpler and user-friendly. E.g. Instead of: +```python +from zenml.core.pipelines.training_pipeline import TrainingPipeline +``` + +A user can simple do: + +```python +from zenml.pipelines import TrainingPipeline +``` + +The caveat is of course that this might involve a re-write of older ZenML code imports. + +Note: Future releases are also expected to be breaking. Until announced, please expect that upgrading ZenML versions may cause older-ZenML +generated pipelines to behave unexpectedly. \ No newline at end of file diff --git a/zenml/VERSION b/zenml/VERSION index f0c210e1cf1..448a0fa11cd 100644 --- a/zenml/VERSION +++ b/zenml/VERSION @@ -1 +1 @@ -0.3.4rc0 \ No newline at end of file +0.3.4 \ No newline at end of file