From e0033c5072c929a4c26cfaeaf61fcedf93d36522 Mon Sep 17 00:00:00 2001 From: github-actions Date: Tue, 19 Dec 2023 16:40:03 +0000 Subject: [PATCH] :rocket: Bump version and CHANGELOG for release 0.12.0 (#508) --- CHANGELOG.md | 42 ++++++++++--------- README.md | 2 +- .../source/02_installation/01_installation.md | 4 +- .../03_getting_started/01_example_project.md | 2 +- kedro_mlflow/__init__.py | 2 +- pyproject.toml | 2 +- setup.py | 2 +- 7 files changed, 30 insertions(+), 26 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3ccee6b9..1db7dc67 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,33 +2,35 @@ ## [Unreleased] +## [0.12.0] - 2023-12-19 + ### Added -- :sparkles: Add support for python 3.11 ([#450, rxm7706](https://github.com/Galileo-Galilei/kedro-mlflow/pull/450)) -- :sparkles: :arrow_up: Add support for pydantic v2 ([#476](https://github.com/Galileo-Galilei/kedro-mlflow/pull/476)) -- :sparkles: :arrow_up: Add support for ``kedro==0.19.X`` ([#](https://github.com/Galileo-Galilei/kedro-mlflow/pull/)) +- :sparkles: Add support for python 3.11 ([#450, rxm7706](https://github.com/Galileo-Galilei/kedro-mlflow/pull/450)) +- :sparkles: :arrow_up: Add support for pydantic v2 ([#476](https://github.com/Galileo-Galilei/kedro-mlflow/pull/476)) +- :sparkles: :arrow_up: Add support for `kedro==0.19.X` ([#](https://github.com/Galileo-Galilei/kedro-mlflow/pull/)) ### Changed -- :boom: ::arrow_up:: Drop support for ``kedro==0.18.X`` series. -- :boom: :sparkles: Change default ``copy_mode`` to ``"assign"`` in ``KedroPipelineModel`` because this is the most efficient setup (and usually the desired one) when serving a Kedro ``Pipeline`` as a Mlflow model. This is different from Kedro's default which is to deepcopy the dataset ([#463](https://github.com/Galileo-Galilei/kedro-mlflow/pull/463)). -- :boom: :recycle: ``MlflowArtifactDataset.__init__`` method ``data_set`` argument is renamed ``dataset`` to match new Kedro conventions ([#391](https://github.com/Galileo-Galilei/kedro-mlflow/pull/391)). -- :boom: :recycle: Rename the following ``DataSets`` with the ``Dataset`` suffix (without capitalized ``S``) to match new kedro conventions from ``kedro>=0.19`` and onwards ([#439, ShubhamZoro](https://github.com/Galileo-Galilei/kedro-mlflow/pull/439)): - - ``MlflowArtifactDataSet``->``MlflowArtifactDataset`` - - ``MlflowAbstractModelDataSet``->``MlflowAbstractModelDataset`` - - ``MlflowModelRegistryDataSet``->``MlflowModelRegistryDataset`` - - ``MlflowMetricDataSet``->``MlflowMetricDataset`` - - ``MlflowMetricHistoryDataSet``->``MlflowMetricHistoryDataset`` -- :boom: :recycle: Rename the following ``DataSets`` to make their use more explicit, and use the ``Dataset`` suffix: - - ``MlflowModelLoggerDataSet``->``MlflowModelTrackingDataset`` ([#391](https://github.com/Galileo-Galilei/kedro-mlflow/pull/391)) - - ``MlflowModelSaverDataSet``->``MlflowModelLocalFileSystemDataset`` ([#391](https://github.com/Galileo-Galilei/kedro-mlflow/pull/391)) - - ``MlflowMetricsDataSet``->``MlflowMetricsHistoryDataset`` ([#440](https://github.com/Galileo-Galilei/kedro-mlflow/pull/440)) +- :boom: ::arrow_up:: Drop support for `kedro==0.18.X` series. +- :boom: :sparkles: Change default `copy_mode` to `"assign"` in `KedroPipelineModel` because this is the most efficient setup (and usually the desired one) when serving a Kedro `Pipeline` as a Mlflow model. This is different from Kedro's default which is to deepcopy the dataset ([#463](https://github.com/Galileo-Galilei/kedro-mlflow/pull/463)). +- :boom: :recycle: `MlflowArtifactDataset.__init__` method `data_set` argument is renamed `dataset` to match new Kedro conventions ([#391](https://github.com/Galileo-Galilei/kedro-mlflow/pull/391)). +- :boom: :recycle: Rename the following `DataSets` with the `Dataset` suffix (without capitalized `S`) to match new kedro conventions from `kedro>=0.19` and onwards ([#439, ShubhamZoro](https://github.com/Galileo-Galilei/kedro-mlflow/pull/439)): + - `MlflowArtifactDataSet`->`MlflowArtifactDataset` + - `MlflowAbstractModelDataSet`->`MlflowAbstractModelDataset` + - `MlflowModelRegistryDataSet`->`MlflowModelRegistryDataset` + - `MlflowMetricDataSet`->`MlflowMetricDataset` + - `MlflowMetricHistoryDataSet`->`MlflowMetricHistoryDataset` +- :boom: :recycle: Rename the following `DataSets` to make their use more explicit, and use the `Dataset` suffix: + - `MlflowModelLoggerDataSet`->`MlflowModelTrackingDataset` ([#391](https://github.com/Galileo-Galilei/kedro-mlflow/pull/391)) + - `MlflowModelSaverDataSet`->`MlflowModelLocalFileSystemDataset` ([#391](https://github.com/Galileo-Galilei/kedro-mlflow/pull/391)) + - `MlflowMetricsDataSet`->`MlflowMetricsHistoryDataset` ([#440](https://github.com/Galileo-Galilei/kedro-mlflow/pull/440)) ## [0.11.10] - 2023-10-03 ### Fixed -- :bug: Avoid error when using ``kedro==0.18.1`` with `TemplatedConfigLoader` and no `mlflow.yml` configuration file ([#452, sami-sweng](https://github.com/Galileo-Galilei/kedro-mlflow/issues/452)) +- :bug: Avoid error when using `kedro==0.18.1` with `TemplatedConfigLoader` and no `mlflow.yml` configuration file ([#452, sami-sweng](https://github.com/Galileo-Galilei/kedro-mlflow/issues/452)) ## [0.11.9] - 2023-07-23 @@ -340,7 +342,7 @@ - :zap: `get_mlflow_config` now uses the Kedro `ProjectContext` `ConfigLoader` to get configs ([#66](https://github.com/Galileo-Galilei/kedro-mlflow/issues/66)). This indirectly solves the following issues: - `get_mlflow_config` now works in interactive mode if `load_context` is called with a path different from the working directory ([#30](https://github.com/Galileo-Galilei/kedro-mlflow/issues/30)) - - ``kedro_mlflow`` now works fine with ``kedro jupyter notebook`` independently of the working directory ([#64](https://github.com/Galileo-Galilei/kedro-mlflow/issues/64)) + - `kedro_mlflow` now works fine with `kedro jupyter notebook` independently of the working directory ([#64](https://github.com/Galileo-Galilei/kedro-mlflow/issues/64)) - You can use global variables in `mlflow.yml` which is now properly parsed if you use a `TemplatedConfigLoader` ([#72](https://github.com/Galileo-Galilei/kedro-mlflow/issues/72)) - :bug: `MlflowMetricsHistoryDataset` now saves in the specified `run_id` instead of the current one when the prefix is not specified ([#62](https://github.com/Galileo-Galilei/kedro-mlflow/issues/62)) - :memo: Other bug fixes and documentation improvements ([#6](https://github.com/Galileo-Galilei/kedro-mlflow/issues/6), [#99](https://github.com/Galileo-Galilei/kedro-mlflow/issues/99)) @@ -449,7 +451,9 @@ - :sparkles: Add `MlflowDataSet` for artifacts autologging - :sparkles: Add `PipelineMl` class and its `pipeline_ml` factory for pipeline packaging and service -[Unreleased]: https://github.com/Galileo-Galilei/kedro-mlflow/compare/0.11.10...HEAD +[Unreleased]: https://github.com/Galileo-Galilei/kedro-mlflow/compare/0.12.0...HEAD + +[0.12.0]: https://github.com/Galileo-Galilei/kedro-mlflow/compare/0.11.10...0.12.0 [0.11.10]: https://github.com/Galileo-Galilei/kedro-mlflow/compare/0.11.9...0.11.10 diff --git a/README.md b/README.md index 98440739..9ddd0f43 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ ---------------------------------------------------------- | Branch | Tests | Coverage | Links | Documentation | Deployment | Activity | | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `master` | [![test](https://github.com/Galileo-Galilei/kedro-mlflow/workflows/test/badge.svg?branch=master)](https://github.com/Galileo-Galilei/kedro-mlflow/actions?query=workflow%3Atest+branch%3Amaster) | [![codecov](https://codecov.io/gh/Galileo-Galilei/kedro-mlflow/branch/master/graph/badge.svg)](https://codecov.io/gh/Galileo-Galilei/kedro-mlflow/branch/master) | [![links](https://github.com/Galileo-Galilei/kedro-mlflow/workflows/check-links/badge.svg?branch=master)](https://github.com/Galileo-Galilei/kedro-mlflow/actions?query=workflow%3Acheck-links+branch%3Amaster) | [![Documentation](https://readthedocs.org/projects/kedro-mlflow/badge/?version=stable)](https://kedro-mlflow.readthedocs.io/en/stable/) | [![publish](https://github.com/Galileo-Galilei/kedro-mlflow/workflows/publish/badge.svg?branch=master)](https://github.com/Galileo-Galilei/kedro-mlflow/actions?query=branch%3Amaster+workflow%3Apublish) | [![commit](https://img.shields.io/github/commits-since/Galileo-Galilei/kedro-mlflow/0.11.10)](https://github.com/Galileo-Galilei/kedro-mlflow/compare/0.11.10...master) | +| `master` | [![test](https://github.com/Galileo-Galilei/kedro-mlflow/workflows/test/badge.svg?branch=master)](https://github.com/Galileo-Galilei/kedro-mlflow/actions?query=workflow%3Atest+branch%3Amaster) | [![codecov](https://codecov.io/gh/Galileo-Galilei/kedro-mlflow/branch/master/graph/badge.svg)](https://codecov.io/gh/Galileo-Galilei/kedro-mlflow/branch/master) | [![links](https://github.com/Galileo-Galilei/kedro-mlflow/workflows/check-links/badge.svg?branch=master)](https://github.com/Galileo-Galilei/kedro-mlflow/actions?query=workflow%3Acheck-links+branch%3Amaster) | [![Documentation](https://readthedocs.org/projects/kedro-mlflow/badge/?version=stable)](https://kedro-mlflow.readthedocs.io/en/stable/) | [![publish](https://github.com/Galileo-Galilei/kedro-mlflow/workflows/publish/badge.svg?branch=master)](https://github.com/Galileo-Galilei/kedro-mlflow/actions?query=branch%3Amaster+workflow%3Apublish) | [![commit](https://img.shields.io/github/commits-since/Galileo-Galilei/kedro-mlflow/0.12.0)](https://github.com/Galileo-Galilei/kedro-mlflow/compare/0.12.0...master) | *If you like the repo, please give it a :star:* diff --git a/docs/source/02_installation/01_installation.md b/docs/source/02_installation/01_installation.md index 9de03021..7737ce82 100644 --- a/docs/source/02_installation/01_installation.md +++ b/docs/source/02_installation/01_installation.md @@ -77,10 +77,10 @@ projects. It is developed as part of the Kedro initiative at QuantumBlack. Installed plugins: -kedro_mlflow: 0.11.10 (hooks:global,project) +kedro_mlflow: 0.12.0 (hooks:global,project) ``` -The version ``0.11.10`` of the plugin is installed and has both global and project commands. +The version ``0.12.0`` of the plugin is installed and has both global and project commands. That's it! You are now ready to go! diff --git a/docs/source/03_getting_started/01_example_project.md b/docs/source/03_getting_started/01_example_project.md index f7a112a2..d5f03212 100644 --- a/docs/source/03_getting_started/01_example_project.md +++ b/docs/source/03_getting_started/01_example_project.md @@ -7,7 +7,7 @@ Create a conda environment and install ``kedro-mlflow`` (this will automatically ```console conda create -n km_example python=3.9 --yes conda activate km_example -pip install kedro-mlflow==0.11.10 +pip install kedro-mlflow==0.12.0 ``` ## Install the toy project diff --git a/kedro_mlflow/__init__.py b/kedro_mlflow/__init__.py index 26af1a9d..a0c906b3 100644 --- a/kedro_mlflow/__init__.py +++ b/kedro_mlflow/__init__.py @@ -1,6 +1,6 @@ """kedro-mlflow plugin constants """ -__version__ = "0.11.10" +__version__ = "0.12.0" import logging diff --git a/pyproject.toml b/pyproject.toml index c68a2583..cc8a517d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,7 +14,7 @@ ignore = ["E501", "PLR0913"] # Black take care off line-too-long exclude = ["/template/"] [tool.bumpversion] -current_version = "0.11.10" +current_version = "0.12.0" [[tool.bumpversion.files]] filename = "setup.py" diff --git a/setup.py b/setup.py index ed5955ae..eb3b8a43 100644 --- a/setup.py +++ b/setup.py @@ -25,7 +25,7 @@ def _parse_requirements(path, encoding="utf-8"): setup( name=NAME, - version="0.11.10", # this will be bumped automatically by bump-my-version + version="0.12.0", # this will be bumped automatically by bump-my-version description="A kedro-plugin to use mlflow in your kedro projects", license="Apache Software License (Apache 2.0)", long_description=README,