Zenml

> [!IMPORTANT]
> This release has been updated (16th January, 2024)
> A bug was introduced in the helm chart starting from version 0.50.0. All releases from that version have been updated with the fix. More details: https://github.com/zenml-io/zenml/pull/2234

In this release, we introduce key updates aimed at improving user experience and security.
The `ModelConfig` object has been renamed to `ModelVersion` for a more intuitive interface.
Additionally, the release features enhancements such as optimized model hydration for better performance,
alongside a range of bug fixes and contributions from both new and returning community members.

Breaking Change
- We have renamed the `ModelConfig` object to `ModelVersion` with other related changes to the model control plane,
the goal of this is to bring a simplified user-interface experience, so once ModelVersion is configured in
`pipeline` or `step` it will travel into all other user-facing places: step context, client, etc. by avishniakov in [2044](https://github.com/zenml-io/zenml/pull/2044)
- introducing RBAC for server endpoints, ensuring users have appropriate permissions for actions on resources.
Additionally, it improves data handling by dehydrating response models to redact inaccessible information, while
service accounts retain full permissions due to current database constraints. by schustmi in [1999](https://github.com/zenml-io/zenml/pull/1999)
- We have completely reworked our API models. While the request models are mostly the same, now with the new hydration logic, most of
our response models feature a body and a metadata field which allow us to control the responses of our API and optimize the flow for
anyone using it By bcdurak [1971](https://github.com/zenml-io/zenml/pull/1971)
- We also worked on adding a new "Artifacts" tab to our dashboard. With these new changes, it will become much easier to understand
and adjust how ZenML versions your data. Moreover, by using "ExternalArtifacts", you will be able to save and load artifacts manually and
use them in your pipelines. By fa9r [1943](https://github.com/zenml-io/zenml/pull/1943)

Enhancements
- Improve alembic migration safety by fa9r in [2073](https://github.com/zenml-io/zenml/pull/2073)
- Model Link Filtering by Artifact / Run Name by fa9r in [2074](https://github.com/zenml-io/zenml/pull/2074)

Bug Fixes
- Fix tag<>resource ID generator to fix the issue of manipulating migrated tags properly [2056](https://github.com/zenml-io/zenml/pull/2056)
- Fixes for `k3d` deployments via `mlstacks` using the ZenML CLI wrapper [2059](https://github.com/zenml-io/zenml/pull/2059)
- Fix some filter options for pipeline runs by schustmi [2078](https://github.com/zenml-io/zenml/pull/2078)
- Fix Label Studio image annotation example by strickvl [2010](https://github.com/zenml-io/zenml/pull/2010)
- Alembic migration fix for databases with scheduled pipelines with 2+ runs by bcdurak [2072](https://github.com/zenml-io/zenml/pull/2072)
- Model version endpoint fixes by schustmi in [2060](https://github.com/zenml-io/zenml/pull/2060)

ZenML Helm Chart Changes
- Make helm chart more robust to accidental secret deletions by stefannica in [2053](https://github.com/zenml-io/zenml/pull/2053)
- Separate helm hook resources from regular resources by stefannica in [2055](https://github.com/zenml-io/zenml/pull/2055)

Other Changes
* Connectors docs small fixes by strickvl in https://github.com/zenml-io/zenml/pull/2050
* Feature/configurable service account for seldon predictor service by Johnyz21 in https://github.com/zenml-io/zenml/pull/1725
* Adding NLP Template Example by safoinme in https://github.com/zenml-io/zenml/pull/2051
* Fix CI by fa9r in https://github.com/zenml-io/zenml/pull/2069
* Depaginate step runs to allow running pipelines with arbitrary step count by schustmi in https://github.com/zenml-io/zenml/pull/2068
* Remove user name from orchestrator run name by schustmi in https://github.com/zenml-io/zenml/pull/2067
* Artifacts Tab by fa9r in https://github.com/zenml-io/zenml/pull/1943
* Add warnings/updates to Huggingface Spaces deployment docs by strickvl in https://github.com/zenml-io/zenml/pull/2052
* Nightly builds by strickvl in https://github.com/zenml-io/zenml/pull/2031
* Allow for custom disk size and type when using VertexAI Step Operator by strickvl in https://github.com/zenml-io/zenml/pull/2054
* Set nightly builds to run at half-past the hour by strickvl in https://github.com/zenml-io/zenml/pull/2077
* Set DCP template tag by avishniakov in https://github.com/zenml-io/zenml/pull/2076
* Add missing dehydration in get_service_connector endpoint by schustmi in https://github.com/zenml-io/zenml/pull/2080
* Replace `black` with `ruff format` / bump `mypy` by strickvl in https://github.com/zenml-io/zenml/pull/2082
* ModelVersion in pipeline context to pass in steps by avishniakov in https://github.com/zenml-io/zenml/pull/2079
* Pin `bcrypt` by strickvl in https://github.com/zenml-io/zenml/pull/2083

New Contributors
* Johnyz21 made their first contribution in https://github.com/zenml-io/zenml/pull/1725

**Full Changelog**: https://github.com/zenml-io/zenml/compare/0.47.0...0.50.0

This release fixes a bug that was introduced in 0.46.1 where the default user
was made inaccessible and was inadvertently duplicated. This release rescues
the original user and renames the duplicate.

UPDATE: a breaking update to one of our dependencies means that you should run the following update after installing this version of `zenml`:

shell
pip install 'bcrypt==4.0.1'


What's Changed
* Create tags table by avishniakov in https://github.com/zenml-io/zenml/pull/2036
* Bring dashboard back to the release by avishniakov in https://github.com/zenml-io/zenml/pull/2046
* Fix duplicate default user by stefannica in https://github.com/zenml-io/zenml/pull/2045


**Full Changelog**: https://github.com/zenml-io/zenml/compare/0.46.1...0.47.0

The 0.46.1 release introduces support for Service Accounts and API Keys that
can be used to authenticate with the ZenML server from environments that do not
support the web login flow, such as CI/CD environments, for example.

Also included in this release are some documentation updates and bug fixes,
notably moving the database migration logic deployed with the Helm chart out of
the init containers and into a Kubernetes Job, which makes it possible to scale
out the ZenML server deployments without the risk of running into database
migration conflicts.

What's Changed
* Small improvements to Hub docs page by strickvl in https://github.com/zenml-io/zenml/pull/2015
* Pin OpenAI integration to `<1.0.0` by strickvl in https://github.com/zenml-io/zenml/pull/2027
* Make error message nicer for when two artifacts that share a prefix are found by strickvl in https://github.com/zenml-io/zenml/pull/2023
* Move db-migration to `job` instead of `init-container` to allow replicas by safoinme in https://github.com/zenml-io/zenml/pull/2021
* Fix stuck/broken CI by strickvl in https://github.com/zenml-io/zenml/pull/2032
* Increase `step.source_code` Cut-Off Limit by fa9r in https://github.com/zenml-io/zenml/pull/2025
* Improve artifact linkage logging in MCP by avishniakov in https://github.com/zenml-io/zenml/pull/2016
* Upgrade feast so apidocs don't fail no mo by AlexejPenner in https://github.com/zenml-io/zenml/pull/2028
* Remove NumPy Visualizations for 2D Arrays by fa9r in https://github.com/zenml-io/zenml/pull/2033
* Fix user activation bug by stefannica in https://github.com/zenml-io/zenml/pull/2037
* Remove `create_new_model_version` arg of `ModelConfig` by avishniakov in https://github.com/zenml-io/zenml/pull/2030
* Extend the wait period in between PyPi package publication and Docker image building for releases by strickvl in https://github.com/zenml-io/zenml/pull/2029
* Make `zenml up` prefill username when launching dashboard by strickvl in https://github.com/zenml-io/zenml/pull/2024
* Add warning when artifact store cannot be loaded by strickvl in https://github.com/zenml-io/zenml/pull/2011
* Add extra config to `Kaniko` docs by safoinme in https://github.com/zenml-io/zenml/pull/2019
* ZenML API Keys and Service Accounts by stefannica in https://github.com/zenml-io/zenml/pull/1840


**Full Changelog**: https://github.com/zenml-io/zenml/compare/0.46.0...0.46.1

UPDATE: a breaking update to one of our dependencies means that you should run the following update after installing this version of `zenml`:

shell
pip install 'bcrypt==4.0.1'


This release brings some upgrades, documentation updates and bug fixes. Notably,
our `langchain` integration now supports more modern versions and has been
upgraded to a new version at the lower edge of supported packages on account of
a security vulnerability.

Other fixes related to the Model Control Plane which was updated to support the
deletion of model versions via the CLI, for example.

Breaking Change

We removed the `llama_index` integration in this release. This related to
unsolvable dependency clashes that relate to `sqlmodel` and our database. We
expect these clashes to be resolved in the future and then we will add our
integration back in. If you were using the `llama_index` materializer that was
part of the integration, you will have to use a custom materializer in the
meanwhile. We apologize for the inconvenience.

What's Changed
* MCP-driven E2E template by avishniakov in https://github.com/zenml-io/zenml/pull/2004
* Model scoped endpoints by avishniakov in https://github.com/zenml-io/zenml/pull/2003
* Delete model version in cli by avishniakov in https://github.com/zenml-io/zenml/pull/2006
* Add latest version to model list response by avishniakov in https://github.com/zenml-io/zenml/pull/2007
* Fix `gcs bucket` docs error message by safoinme in https://github.com/zenml-io/zenml/pull/2018
* Fix `Skypilot` docs configuration by safoinme in https://github.com/zenml-io/zenml/pull/2017
* Bump `langchain`, disable `llama_index`, and fix Vector Store materializer by strickvl in https://github.com/zenml-io/zenml/pull/2013
* Fix Build Options of `GCPImageBuilder` by fa9r in https://github.com/zenml-io/zenml/pull/1992
* Fix the stack component describe CLI output by stefannica in https://github.com/zenml-io/zenml/pull/2001


**Full Changelog**: https://github.com/zenml-io/zenml/compare/0.45.6...0.46.0

UPDATE: a breaking update to one of our dependencies means that you should run the following update after installing this version of `zenml`:

shell
pip install 'bcrypt==4.0.1'


This release brings an array of enhancements and refinements. Notable improvements include
allowing for `disconnecting` service connectors from stack components, adding connector support to the
sagemaker step operator, turning synchronous mode on by default for all orchestrators, and enabling
server-side component config validation.

What's Changed
* Updating `README.md` and update images by znegrin in https://github.com/zenml-io/zenml/pull/1986
* Always set the active workspace to be the default workspace server side by stefannica in https://github.com/zenml-io/zenml/pull/1989
* Update outdated CLI docs by strickvl in https://github.com/zenml-io/zenml/pull/1990
* Turn synchronous mode on by default for all orchestrators by stefannica in https://github.com/zenml-io/zenml/pull/1991
* Use docker credentials in the skypilot orchestrator by stefannica in https://github.com/zenml-io/zenml/pull/1983
* Add missing space to `step` warning message by strickvl in https://github.com/zenml-io/zenml/pull/1994
* Fix sagemaker orchestrator and step operator env vars and other minor bugs by stefannica in https://github.com/zenml-io/zenml/pull/1993
* fix: `BasePyTorchMaterliazer` -> `Materializer` by cameronraysmith in https://github.com/zenml-io/zenml/pull/1969
* allow calling old base pytorch materilizzer by safoinme in https://github.com/zenml-io/zenml/pull/1997
* Add connector support to sagemaker step operator. by stefannica in https://github.com/zenml-io/zenml/pull/1996
* Server-Side Component Config Validation by fa9r in https://github.com/zenml-io/zenml/pull/1988
* Allow disconnecting service-connector from stack component by safoinme in https://github.com/zenml-io/zenml/pull/1864

New Contributors
* znegrin made their first contribution in https://github.com/zenml-io/zenml/pull/1986

**Full Changelog**: https://github.com/zenml-io/zenml/compare/0.45.5...0.45.6

UPDATE: a breaking update to one of our dependencies means that you should run the following update after installing this version of `zenml`:

shell
pip install 'bcrypt==4.0.1'


This minor release contains bugfixes and documentation improvements. Notably,
our `sqlmodel` dependency has been pinned to 0.0.8 which fixes installation
errors following the release of 0.0.9.

What's Changed
* Add a 'how do I...' section into docs by strickvl in https://github.com/zenml-io/zenml/pull/1953
* Bump `mypy`, `ruff` and `black` by strickvl in https://github.com/zenml-io/zenml/pull/1963
* Fix double slashes in weblogin by schustmi in https://github.com/zenml-io/zenml/pull/1972
* SQLModel docs backport fixes by strickvl in https://github.com/zenml-io/zenml/pull/1975
* Updated quickstart command in cloud quickstart by AlexejPenner in https://github.com/zenml-io/zenml/pull/1977
* Make sure vertex job id is only lower case letter, number or dash by AlexejPenner in https://github.com/zenml-io/zenml/pull/1978
* Fix DB initialization when using external authentication by schustmi in https://github.com/zenml-io/zenml/pull/1965
* Pin SQLModel dependency to `0.0.8` by strickvl in https://github.com/zenml-io/zenml/pull/1973
* Source code repository type not included in resolve source by safoinme in https://github.com/zenml-io/zenml/pull/1982
* Prepare release 0.45.5 by strickvl in https://github.com/zenml-io/zenml/pull/1981


**Full Changelog**: https://github.com/zenml-io/zenml/compare/0.45.4...0.45.5