Skip to content

Commit

Permalink
Prepare release 0.68.0 (#3139)
Browse files Browse the repository at this point in the history
* Adding the new version to the necessary files.

* update release notes

---------

Co-authored-by: ZenML GmbH <[email protected]>
Co-authored-by: Baris Can Durak <[email protected]>
  • Loading branch information
3 people authored Oct 24, 2024
1 parent 024d612 commit c8c3b12
Show file tree
Hide file tree
Showing 15 changed files with 919 additions and 767 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ the Apache License Version 2.0.
<a href="https://github.com/zenml-io/zenml-projects">Projects Showcase</a>
<br />
<br />
🎉 Version 0.67.0 is out. Check out the release notes
🎉 Version 0.68.0 is out. Check out the release notes
<a href="https://github.com/zenml-io/zenml/releases">here</a>.
<br />
🖥️ Download our VS Code Extension <a href="https://marketplace.visualstudio.com/items?itemName=ZenML.zenml-vscode">here</a>.
Expand Down
129 changes: 129 additions & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,134 @@
<!-- markdown-link-check-disable -->

# 0.68.0

## Highlights

- **Stack Components on the Dashboard:** We're bringing back stack components.
With this release you will get access to the list of your stack components on
the ZenML dashboard. More functionality is going to follow in the next releases.
- **Client-Side Caching:** Implemented client-side computation for cached steps,
significantly reducing time and costs associated with remote orchestrator
spin-up.
- **Streamlined Onboarding Process:** Unified the starter and production setup
into a single sequential flow, providing a more intuitive user experience.
- **BentoML Integration:** Updated to version 1.3.5 with enhanced
containerization support.
- **Artifact Management:** Introduced `register_artifact` function enabling
direct linking of existing data in the artifact store, particularly useful
for tools like PyTorch-Lightning that manage their own checkpoints.
- **Enhanced Error Handling:** Added Error Boundary to visualization components
for improved reliability and user experience.

## Additional Features and Improvements

- Added multiple access points for deleting pipeline runs
- Improved pipeline detail view functionality
- Improved service account handling for Kaniko image builder

## Breaking Changes and Deprecations

- Discontinued Python 3.8 support
- Removed legacy pipeline and step interface
- Removed legacy post execution workflow
- Removed legacy dashboard option
- Removed `zenml stack up/down` CLI commands
- Removed `zenml deploy` and `zenml <stack-component> deploy`
- Removed `StepEnvironment` class
- Removed `ArtifactConfig` class for model version specification
- Removed `ExternalArtifact` class
- Deprecated `Client.list_runs` in favor of `Client.list_pipeline_runs`
- Deprecated `ArtifactVersionResponse.read` in favor of `ArtifactVersionResponse.load`

## Documentation Updates

Added new guides for the following topics:

- Kubernetes per-pod configuration
- Factory generation of artifact names
- Common stacks best practices
- Azure 1-click dashboard deployment
- ZenML server upgrade best practices
- Custom Dataset classes and Materializers
- Comprehensive ZenML Pro documentation
- Image building optimization during pipeline runs
- Enhanced BentoML integration documentation

## What's Changed
* Release 0.67.0 migration testing by @bcdurak in https://github.com/zenml-io/zenml/pull/3050
* Prevent too large requests by @avishniakov in https://github.com/zenml-io/zenml/pull/3048
* Fix Neptune linting after 1.12.0 release by @avishniakov in https://github.com/zenml-io/zenml/pull/3055
* Fix Lightning Orchestrator (remove -y from pip install) by @wjayesh in https://github.com/zenml-io/zenml/pull/3058
* Fix artifact pruning endpoint path by @schustmi in https://github.com/zenml-io/zenml/pull/3052
* Update python versioning in docs by @avishniakov in https://github.com/zenml-io/zenml/pull/3059
* Fix infinite loop while fetching artifact store in logs storage class by @avishniakov in https://github.com/zenml-io/zenml/pull/3061
* Make sync a setting for sagemaker/azureml orchestrator by @schustmi in https://github.com/zenml-io/zenml/pull/3062
* Remove some deprecated features by @schustmi in https://github.com/zenml-io/zenml/pull/2926
* Fix MySQL warning when filtering pipelines by latest run by @schustmi in https://github.com/zenml-io/zenml/pull/3051
* Remove more deprecated stuff by @schustmi in https://github.com/zenml-io/zenml/pull/3063
* Remove log versions from versioned buckets in S3 by @avishniakov in https://github.com/zenml-io/zenml/pull/3060
* add docs on k8s per pod settings by @wjayesh in https://github.com/zenml-io/zenml/pull/3066
* Remove Python 3.8 support by @strickvl in https://github.com/zenml-io/zenml/pull/3034
* `register_artifact ` function by @avishniakov in https://github.com/zenml-io/zenml/pull/3053
* Fix bad link in docs by @avishniakov in https://github.com/zenml-io/zenml/pull/3069
* Fix model linkage for the lazy loading scenarios by @avishniakov in https://github.com/zenml-io/zenml/pull/3054
* Updating template versions after the Python 3.8 changes by @bcdurak in https://github.com/zenml-io/zenml/pull/3070
* Add UUID materializer by @htahir1 in https://github.com/zenml-io/zenml/pull/3073
* Fix pipeline and model URLs for ZenML Pro on-prem deployments by @stefannica in https://github.com/zenml-io/zenml/pull/3083
* Update bentoml integration to 1.3.5 and add containerization by @wjayesh in https://github.com/zenml-io/zenml/pull/3045
* Fix mlflow linting by @schustmi in https://github.com/zenml-io/zenml/pull/3085
* Add docs for factory generation of artifact names by @strickvl in https://github.com/zenml-io/zenml/pull/3084
* Remove unnecessary metadata fields in UUID materializer test by @htahir1 in https://github.com/zenml-io/zenml/pull/3088
* Client-side computation of cached steps by @schustmi in https://github.com/zenml-io/zenml/pull/3068
* Fix Kaniko image builder service account passing by @schustmi in https://github.com/zenml-io/zenml/pull/3081
* Bugfix in GitLab Code Repository integration by @4gt-104 in https://github.com/zenml-io/zenml/pull/3076
* Add docs on common stacks best practices by @strickvl in https://github.com/zenml-io/zenml/pull/3092
* [docs] Update stacks page and add azure 1-click from dashboard docs by @wjayesh in https://github.com/zenml-io/zenml/pull/3082
* Local development how-to section by @strickvl in https://github.com/zenml-io/zenml/pull/3090
* [docs] best practices for upgrading zenml server by @wjayesh in https://github.com/zenml-io/zenml/pull/3087
* Fix S3 ArtifactStore auth issue by @avishniakov in https://github.com/zenml-io/zenml/pull/3086
* Reduce migration testing runtime by @avishniakov in https://github.com/zenml-io/zenml/pull/3078
* [docs] Dedicated docs on how to skip building an image on pipeline run by @wjayesh in https://github.com/zenml-io/zenml/pull/3079
* Fix filtering by tag for pipeline runs by @schustmi in https://github.com/zenml-io/zenml/pull/3097
* Remove deprecated features: `zenml deploy` and `zenml <stack-component> deploy` by @stefannica in https://github.com/zenml-io/zenml/pull/3089
* Do not tag model via `Model` class on creation by @avishniakov in https://github.com/zenml-io/zenml/pull/3098
* Sagemaker add pipeline tags by @htahir1 in https://github.com/zenml-io/zenml/pull/3080
* [docs] Add custom Dataset classes and Materializers in ZenML by @htahir1 in https://github.com/zenml-io/zenml/pull/3091
* Delete Scarf related scripts and workflow files by @htahir1 in https://github.com/zenml-io/zenml/pull/3103
* Add more detailed docs for ZenML Pro by @wjayesh in https://github.com/zenml-io/zenml/pull/3065
* Add missing code hash filter in client method by @schustmi in https://github.com/zenml-io/zenml/pull/3094
* Remove lineage graph and legacy dashboard support by @schustmi in https://github.com/zenml-io/zenml/pull/3064
* Add unittest to cover gitlab CR regex. by @4gt-104 in https://github.com/zenml-io/zenml/pull/3102
* Automating the release process using Github workflows by @bcdurak in https://github.com/zenml-io/zenml/pull/3101
* Bugfix for release automation by @bcdurak in https://github.com/zenml-io/zenml/pull/3107
* Bugfix for new version in the release automation by @bcdurak in https://github.com/zenml-io/zenml/pull/3108
* using the right parent image name by @bcdurak in https://github.com/zenml-io/zenml/pull/3109
* Making the new release automation scripts executable by @bcdurak in https://github.com/zenml-io/zenml/pull/3110
* Fixing the env variables for the release automation by @bcdurak in https://github.com/zenml-io/zenml/pull/3111
* Adding the right Github configuration before using the `gh` CLI to fetch the version by @bcdurak in https://github.com/zenml-io/zenml/pull/3112
* Fixing the outputs of the first step in the release automation by @bcdurak in https://github.com/zenml-io/zenml/pull/3113
* Handling github auth and release notes for release automation by @bcdurak in https://github.com/zenml-io/zenml/pull/3114
* Fixing the cloudbuild call for release automation by @bcdurak in https://github.com/zenml-io/zenml/pull/3116
* Fixing the update tenant call in the script by @bcdurak in https://github.com/zenml-io/zenml/pull/3118
* Release automation with the new redeploy logic by @bcdurak in https://github.com/zenml-io/zenml/pull/3120
* Fixing the automation triggers for other branches by @bcdurak in https://github.com/zenml-io/zenml/pull/3125
* Update link for `llm-complete-guide` repository.- Updated link to poi… by @htahir1 in https://github.com/zenml-io/zenml/pull/3128
* Fixing the migration testing for the release branches by @bcdurak in https://github.com/zenml-io/zenml/pull/3127
* Update pipeline deletion docs by @strickvl in https://github.com/zenml-io/zenml/pull/3123
* Disabling the cache for the quickstart tests by @bcdurak in https://github.com/zenml-io/zenml/pull/3133
* Update Argilla integration for v2.x SDK by @sdiazlor in https://github.com/zenml-io/zenml/pull/2915
* Using pip instead of `gh` CLI in the migration tests by @bcdurak in https://github.com/zenml-io/zenml/pull/3136
* Adapting tags to work with older versions of Sagemaker by @bcdurak in https://github.com/zenml-io/zenml/pull/3135
* Manual trigger for the `release_finalize` workflow by @bcdurak in https://github.com/zenml-io/zenml/pull/3137
* Fixing the prepare trigger for the release automation by @bcdurak in https://github.com/zenml-io/zenml/pull/3138

## New Contributors
* @4gt-104 made their first contribution in https://github.com/zenml-io/zenml/pull/3076
* @sdiazlor made their first contribution in https://github.com/zenml-io/zenml/pull/2915

**Full Changelog**: https://github.com/zenml-io/zenml/compare/0.67.0...0.68.0


# 0.67.0

## Highlights
Expand Down
2 changes: 1 addition & 1 deletion examples/quickstart/configs/training_aws.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ enable_cache: True
# Environment configuration
settings:
docker:
parent_image: "715803424590.dkr.ecr.eu-central-1.amazonaws.com/zenml-public-pipelines:quickstart-0.67.0-py3.11-aws"
parent_image: "715803424590.dkr.ecr.eu-central-1.amazonaws.com/zenml-public-pipelines:quickstart-0.68.0-py3.11-aws"
skip_build: True # If you switch this to False remove the parent_image
requirements: requirements.txt
orchestrator.sagemaker:
Expand Down
2 changes: 1 addition & 1 deletion examples/quickstart/configs/training_azure.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ enable_cache: True
# Environment configuration
settings:
docker:
parent_image: "zenmldocker/zenml-public-pipelines:quickstart-0.67.0-py3.11-azure"
parent_image: "zenmldocker/zenml-public-pipelines:quickstart-0.68.0-py3.11-azure"
skip_build: True
requirements: requirements.txt
# Uncomment the following lines to specify the accelerator for your azureml orchestrator
Expand Down
2 changes: 1 addition & 1 deletion examples/quickstart/configs/training_gcp.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ enable_cache: True
# Environment configuration
settings:
docker:
parent_image: "zenmldocker/zenml-public-pipelines:quickstart-0.67.0-py3.11-gcp"
parent_image: "zenmldocker/zenml-public-pipelines:quickstart-0.68.0-py3.11-gcp"
skip_build: True
requirements: requirements.txt
# Uncomment the following two lines to specify the accelerator for your vertex orchestrator
Expand Down
Loading

0 comments on commit c8c3b12

Please sign in to comment.