Skip to content

Commit

Permalink
🚀 Bump version and CHANGELOG for release 0.7.5 (#244)
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions authored and Galileo-Galilei committed Sep 21, 2021
1 parent b6ff10c commit 8475853
Show file tree
Hide file tree
Showing 10 changed files with 20 additions and 16 deletions.
14 changes: 9 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@

## [Unreleased]

## [0.7.5] - 2021-09-21

### Added

- :sparkles: Add support for notebook use. When a notebook is opened via a kedro command (e.g. `kedro jupyter notebook`), you can call the `%reload_kedro_mlflow` line magic to setup mlflow configuration automatically. A ``mlflow_client`` to the database is also created available as a global variable ([#124](https://github.com/Galileo-Galilei/kedro-mlflow/issues/124)).
- :memo: Add automatic API documentation through docstrings for better consistency between code and docs ([#110](https://github.com/Galileo-Galilei/kedro-mlflow/issues/110)). All docstrings are not updated yet and it will be a long term work.
- :sparkles: Add support for notebook use. When a notebook is opened via a kedro command (e.g. `kedro jupyter notebook`), you can call the `%reload_kedro_mlflow` line magic to setup mlflow configuration automatically. A `mlflow_client` to the database is also created available as a global variable ([#124](https://github.com/Galileo-Galilei/kedro-mlflow/issues/124)).
- :memo: Add automatic API documentation through docstrings for better consistency between code and docs ([#110](https://github.com/Galileo-Galilei/kedro-mlflow/issues/110)). All docstrings are not updated yet and it will be a long term work.

### Changed

- :recycle: ``KedroMlflowConfig`` was refactored with pydantic for improved type checking when loading configuration, overall robustness and autocompletion. Its keys have changed, but it is not considered as a user facing changes since the public function ``get_mlflow_config()`` and ``KedroMlflowConfig().setup()`` are not modified.
- :recycle: `KedroMlflowConfig` was refactored with pydantic for improved type checking when loading configuration, overall robustness and autocompletion. Its keys have changed, but it is not considered as a user facing changes since the public function `get_mlflow_config()` and `KedroMlflowConfig().setup()` are not modified.

- :wastebasket: The ``kedro.framework.context`` folder is moved to ``kedro.config`` for consistency with the Kedro repo structure: ``get_mlflow_config`` import must change from `from kedro_mlflow.framework.context import get_mlflow_config` to `from kedro_mlflow.config import get_mlflow_config`.
- :wastebasket: The `kedro.framework.context` folder is moved to `kedro.config` for consistency with the Kedro repo structure: `get_mlflow_config` import must change from `from kedro_mlflow.framework.context import get_mlflow_config` to `from kedro_mlflow.config import get_mlflow_config`.

## [0.7.4] - 2021-08-30

Expand Down Expand Up @@ -240,7 +242,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.7.4...HEAD
[Unreleased]: https://github.com/Galileo-Galilei/kedro-mlflow/compare/0.7.5...HEAD

[0.7.5]: https://github.com/Galileo-Galilei/kedro-mlflow/compare/0.7.4...0.7.5

[0.7.4]: https://github.com/Galileo-Galilei/kedro-mlflow/compare/0.7.3...0.7.4

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,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.7.4)](https://github.com/Galileo-Galilei/kedro-mlflow/compare/0.7.4...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.7.5)](https://github.com/Galileo-Galilei/kedro-mlflow/compare/0.7.5...master)|

# What is kedro-mlflow?

Expand Down
4 changes: 2 additions & 2 deletions docs/source/01_introduction/02_motivation.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ Above implementations have the advantage of being very straightforward and *mlfl
|Logging metrics |``catalog.yml`` |``MlflowMetricsDataSet`` |
|Logging Pipeline as model |``hooks.py`` |``KedroPipelineModel`` and ``pipeline_ml_factory``|

In the current version (``kedro_mlflow=0.7.4``), `kedro-mlflow` does not provide interface to set tags outside a Kedro ``Pipeline``. Some of above decisions are subject to debate and design decisions (for instance, metrics are often updated in a loop during each epoch / training iteration and it does not always make sense to register the metric between computation steps, e.g. as a an I/O operation after a node run).
In the current version (``kedro_mlflow=0.7.5``), `kedro-mlflow` does not provide interface to set tags outside a Kedro ``Pipeline``. Some of above decisions are subject to debate and design decisions (for instance, metrics are often updated in a loop during each epoch / training iteration and it does not always make sense to register the metric between computation steps, e.g. as a an I/O operation after a node run).

_**Note:** the version ``0.7.4`` does not need any ``MLProject`` file to use mlflow inside your Kedro project. As seen in the [introduction](./01_introduction.md), this file overlaps with Kedro configuration files._
_**Note:** the version ``0.7.5`` does not need any ``MLProject`` file to use mlflow inside your Kedro project. As seen in the [introduction](./01_introduction.md), this file overlaps with Kedro configuration files._
4 changes: 2 additions & 2 deletions docs/source/02_installation/01_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@ projects. It is developed as part of
the Kedro initiative at QuantumBlack.

Installed plugins:
kedro_mlflow: 0.7.4 (hooks:global,project)
kedro_mlflow: 0.7.5 (hooks:global,project)
```

The version ``0.7.4`` of the plugin is installed and has both global and project commands.
The version ``0.7.5`` of the plugin is installed and has both global and project commands.

That's it! You are now ready to go!

Expand Down
2 changes: 1 addition & 1 deletion docs/source/03_getting_started/01_example_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Create a conda environment and install ``kedro-mlflow`` (this will automatically
```console
conda create -n km_example python=3.6.8 --yes
conda activate km_example
pip install kedro-mlflow==0.7.4
pip install kedro-mlflow==0.7.5
```

## Install the toy project
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Automatic parameters versioning

Parameters versioning is automatic when the ``MlflowNodeHook`` is added to [the hook list of the ``ProjectContext``](https://kedro-mlflow.readthedocs.io/en/latest/source/02_installation/02_setup.html#declaring-kedro-mlflow-hooks). In ``kedro-mlflow==0.7.4``, the `mlflow.yml` configuration file has a parameter called ``flatten_dict_params`` which enables to [log as distinct parameters the (key, value) pairs of a ```Dict`` parameter](../07_python_objects/02_Hooks.md).
Parameters versioning is automatic when the ``MlflowNodeHook`` is added to [the hook list of the ``ProjectContext``](https://kedro-mlflow.readthedocs.io/en/latest/source/02_installation/02_setup.html#declaring-kedro-mlflow-hooks). In ``kedro-mlflow==0.7.5``, the `mlflow.yml` configuration file has a parameter called ``flatten_dict_params`` which enables to [log as distinct parameters the (key, value) pairs of a ```Dict`` parameter](../07_python_objects/02_Hooks.md).

You **do not need any additional configuration** to benefit from parameters versioning.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Setting the `mlflow_tracking_uri` key of `mlflow.yml` to the url of this server

You can refer to [this issue](https://github.com/Galileo-Galilei/kedro-mlflow/issues/15) for further details.

In ``kedro-mlflow==0.7.4`` you must configure these elements by yourself. Further releases will introduce helpers for configuration.
In ``kedro-mlflow==0.7.5`` you must configure these elements by yourself. Further releases will introduce helpers for configuration.

### Can I log an artifact in a specific run?

Expand Down
2 changes: 1 addition & 1 deletion kedro_mlflow/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""kedro-mlflow plugin constants
"""
__version__ = "0.7.4"
__version__ = "0.7.5"
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.7.4
current_version = 0.7.5

[tool:pytest]
addopts = --cov=kedro_mlflow --cov-report=html tests/
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def _parse_requirements(path, encoding="utf-8"):

setup(
name=NAME,
version="0.7.4", # this will be bumped automatically by bump2version
version="0.7.5", # this will be bumped automatically by bump2version
description="A kedro-plugin to use mlflow in your kedro projects",
license="Apache Software License (Apache 2.0)",
long_description=README,
Expand Down

0 comments on commit 8475853

Please sign in to comment.