**General informations**
<!-- markdown-link-check-disable -->
[](https://pypi.org/project/kedro-mlflow/) [](https://opensource.org/licenses/Apache-2.0) [](https://github.com/ambv/black)
[](https://semver.org/)
<!-- markdown-link-check-enable -->
----------------------------------------------------------
| Package manager | Software repository | Latest release | Total downloads |
| --------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| ``pip`` | PyPI | [](https://pypi.org/project/kedro-mlflow/) | [](https://pepy.tech/project/kedro-mlflow) |
| ``conda`` | conda-forge | [](https://anaconda.org/search?q=kedro+mlflow) | [](https://anaconda.org/search?q=kedro+mlflow) |
**Code health**
----------------------------------------------------------
| Branch | Tests | Coverage | Links | Documentation | Deployment | Activity |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `master` | [](https://github.com/Galileo-Galilei/kedro-mlflow/actions?query=workflow%3Atest+branch%3Amaster) | [](https://codecov.io/gh/Galileo-Galilei/kedro-mlflow/branch/master) | [](https://github.com/Galileo-Galilei/kedro-mlflow/actions?query=workflow%3Acheck-links+branch%3Amaster) | [](https://kedro-mlflow.readthedocs.io/en/stable/) | [](https://github.com/Galileo-Galilei/kedro-mlflow/actions?query=branch%3Amaster+workflow%3Apublish) | [](https://github.com/Galileo-Galilei/kedro-mlflow/compare/0.13.4...master) |
*If you like the repo, please give it a :star:*
# What is kedro-mlflow?
``kedro-mlflow`` is a [kedro-plugin](https://kedro.readthedocs.io/en/stable/extend_kedro/plugins.html) for lightweight and portable integration of [mlflow](https://mlflow.org/docs/latest/index.html) capabilities inside [kedro](https://kedro.readthedocs.io/en/stable/index.html) projects. It enforces [``Kedro`` principles](https://kedro.org/blog/development-principles-for-opinionated-teams) to make mlflow usage as production ready as possible. Its core functionalities are :
- **versioning**: `kedro-mlflow` intends to enhance reproducibility for machine learning experimentation. With `kedro-mlflow` installed, you can effortlessly register your parameters or your datasets with minimal configuration in a kedro run. Later, you will be able to browse your runs in the mlflow UI, and retrieve the runs you want. This is directly linked to [Mlflow Tracking](https://www.mlflow.org/docs/latest/tracking.html).
- **model packaging**: ``kedro-mlflow`` intends to be be an agnostic machine learning framework for people who want to write portable, production ready machine learning pipelines. It offers a convenient API to convert a Kedro pipeline to a ``model`` in the mlflow sense. Consequently, you can *API-fy* or serve your Kedro pipeline with one line of code, or share a model with without worrying of the preprocessing to be made for further use. This is directly linked to [Mlflow Models](https://www.mlflow.org/docs/latest/models.html).
# How do I install kedro-mlflow?
**Important: ``kedro-mlflow`` is only compatible with ``kedro>=0.16.0`` and ``mlflow>=1.0.0``. If you have a project created with an older version of ``Kedro``, see this [migration guide](https://github.com/quantumblacklabs/kedro/blob/master/RELEASE.md#migration-guide-from-kedro-015-to-016).**
``kedro-mlflow`` is available on PyPI, so you can install it with ``pip``:
```console
pip install kedro-mlflow
```
If you want to use the most up to date version of the package which is under development and not released yet, you can install the package from github:
```console
pip install --upgrade git+https://github.com/Galileo-Galilei/kedro-mlflow.git
```
I strongly recommend to use ``conda`` (a package manager) to create an environment and to read [``kedro`` installation guide](https://kedro.readthedocs.io/en/latest/get_started/install.html).
# Getting started
The documentation contains:
- [A "hello world" example](https://kedro-mlflow.readthedocs.io/en/latest/source/03_getting_started/index.html) which demonstrates how you to **setup your project**, **version parameters** and **datasets**, and browse your runs in the UI.
- A section for [advanced machine learning versioning](https://kedro-mlflow.readthedocs.io/en/latest/source/04_experimentation_tracking/index.html) to show more advanced features (mlflow configuration through the plugin, package and serve a kedro ``Pipeline``...)
- A section to demonstrate how to use `kedro-mlflow` as a [machine learning framework](https://kedro-mlflow.readthedocs.io/en/latest/source/05_framework_ml/index.html) to deliver production ready pipelines and serve them. This section comes with [an example repo](https://github.com/Galileo-Galilei/kedro-mlflow-tutorial) you can clone and try out.
Some frequently asked questions on more advanced features:
- You want to log additional metrics to the run? -> [Try ``MlflowMetricsHistoryDataset``](https://kedro-mlflow.readthedocs.io/en/stable/source/04_experimentation_tracking/05_version_metrics.html) !
- You want to log nice dataviz of your pipeline that you register with ``MatplotlibWriter``? -> [Try ``MlflowArtifactDataset`` to log any local files (.png, .pkl, .csv...) *automagically*](https://kedro-mlflow.readthedocs.io/en/stable/source/04_experimentation_tracking/03_version_datasets.html)!
- You want to create easily an API to share your awesome model to anyone? -> [See if ``pipeline_ml_factory`` can fit your needs](https://github.com/Galileo-Galilei/kedro-mlflow/issues/16)
- You want to do something that is not straigthforward with current implementation? Open an issue, and let's see what happens!
# Release and roadmap
The [release history](https://github.com/Galileo-Galilei/kedro-mlflow/blob/master/CHANGELOG.md) centralizes packages improvements across time. The main features coming in next releases are [listed on github milestones](https://github.com/Galileo-Galilei/kedro-mlflow/milestones). Feel free to upvote/downvote and discuss prioritization in associated issues.
# Disclaimer
This package is still in active development. We use [SemVer](https://semver.org/) principles to version our releases. Until we reach `1.0.0` milestone, breaking changes will lead to `<minor>` version number increment, while releases which do not introduce breaking changes in the API will lead to `<patch>` version number increment.
The user must be aware that we will not reach `1.0.0` milestone before Kedro does (mlflow has already reached `1.0.0`). **That said, the API is considered as stable from 0.8.0 version and user can reliably consider that no consequent breaking change will happen unless necessary for Kedro compatibility (e.g. for minor or major Kedro version).**
If you want to migrate from an older version of `kedro-mlflow` to most recent ones, see the [migration guide](https://kedro-mlflow.readthedocs.io/en/stable/source/02_installation/03_migration_guide.html).
# Can I contribute?
We'd be happy to receive help to maintain and improve the package. Any PR will be considered (from typo in the docs to core features add-on) Please check the [contributing guidelines](https://github.com/Galileo-Galilei/kedro-mlflow/blob/master/CONTRIBUTING.md).
# Main contributors
The following people actively maintain, enhance and discuss design to make this package as good as possible:
- [Yolan Honoré-Rougé](https://github.com/galileo-galilei)
- [Takieddine Kadiri](https://github.com/takikadiri)
Many thanks to [Adrian Piotr Kruszewski](https://github.com/akruszewski) for his past work on the repo.
Raw data
{
"_id": null,
"home_page": "https://github.com/Galileo-Galilei/kedro-mlflow",
"name": "kedro-mlflow",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "kedro-plugin, mlflow, model versioning, model packaging, pipelines, machine learning, data pipelines, data science, data engineering",
"author": "Yolan Honor\u00e9-Roug\u00e9",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/6a/62/384046aea51cb6291486e15c90c8f14823e628011fbd4d10699af2213bce/kedro_mlflow-0.13.4.tar.gz",
"platform": null,
"description": "**General informations**\n<!-- markdown-link-check-disable -->\n[](https://pypi.org/project/kedro-mlflow/) [](https://opensource.org/licenses/Apache-2.0) [](https://github.com/ambv/black)\n[](https://semver.org/)\n<!-- markdown-link-check-enable -->\n\n----------------------------------------------------------\n| Package manager | Software repository | Latest release | Total downloads |\n| --------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| ``pip`` | PyPI | [](https://pypi.org/project/kedro-mlflow/) | [](https://pepy.tech/project/kedro-mlflow) |\n| ``conda`` | conda-forge | [](https://anaconda.org/search?q=kedro+mlflow) | [](https://anaconda.org/search?q=kedro+mlflow) |\n\n**Code health**\n\n----------------------------------------------------------\n| Branch | Tests | Coverage | Links | Documentation | Deployment | Activity |\n| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `master` | [](https://github.com/Galileo-Galilei/kedro-mlflow/actions?query=workflow%3Atest+branch%3Amaster) | [](https://codecov.io/gh/Galileo-Galilei/kedro-mlflow/branch/master) | [](https://github.com/Galileo-Galilei/kedro-mlflow/actions?query=workflow%3Acheck-links+branch%3Amaster) | [](https://kedro-mlflow.readthedocs.io/en/stable/) | [](https://github.com/Galileo-Galilei/kedro-mlflow/actions?query=branch%3Amaster+workflow%3Apublish) | [](https://github.com/Galileo-Galilei/kedro-mlflow/compare/0.13.4...master) |\n\n*If you like the repo, please give it a :star:*\n\n# What is kedro-mlflow?\n\n``kedro-mlflow`` is a [kedro-plugin](https://kedro.readthedocs.io/en/stable/extend_kedro/plugins.html) for lightweight and portable integration of [mlflow](https://mlflow.org/docs/latest/index.html) capabilities inside [kedro](https://kedro.readthedocs.io/en/stable/index.html) projects. It enforces [``Kedro`` principles](https://kedro.org/blog/development-principles-for-opinionated-teams) to make mlflow usage as production ready as possible. Its core functionalities are :\n\n- **versioning**: `kedro-mlflow` intends to enhance reproducibility for machine learning experimentation. With `kedro-mlflow` installed, you can effortlessly register your parameters or your datasets with minimal configuration in a kedro run. Later, you will be able to browse your runs in the mlflow UI, and retrieve the runs you want. This is directly linked to [Mlflow Tracking](https://www.mlflow.org/docs/latest/tracking.html).\n- **model packaging**: ``kedro-mlflow`` intends to be be an agnostic machine learning framework for people who want to write portable, production ready machine learning pipelines. It offers a convenient API to convert a Kedro pipeline to a ``model`` in the mlflow sense. Consequently, you can *API-fy* or serve your Kedro pipeline with one line of code, or share a model with without worrying of the preprocessing to be made for further use. This is directly linked to [Mlflow Models](https://www.mlflow.org/docs/latest/models.html).\n\n# How do I install kedro-mlflow?\n\n**Important: ``kedro-mlflow`` is only compatible with ``kedro>=0.16.0`` and ``mlflow>=1.0.0``. If you have a project created with an older version of ``Kedro``, see this [migration guide](https://github.com/quantumblacklabs/kedro/blob/master/RELEASE.md#migration-guide-from-kedro-015-to-016).**\n\n``kedro-mlflow`` is available on PyPI, so you can install it with ``pip``:\n\n```console\npip install kedro-mlflow\n```\n\nIf you want to use the most up to date version of the package which is under development and not released yet, you can install the package from github:\n\n```console\npip install --upgrade git+https://github.com/Galileo-Galilei/kedro-mlflow.git\n```\n\nI strongly recommend to use ``conda`` (a package manager) to create an environment and to read [``kedro`` installation guide](https://kedro.readthedocs.io/en/latest/get_started/install.html).\n\n# Getting started\n\nThe documentation contains:\n\n- [A \"hello world\" example](https://kedro-mlflow.readthedocs.io/en/latest/source/03_getting_started/index.html) which demonstrates how you to **setup your project**, **version parameters** and **datasets**, and browse your runs in the UI.\n- A section for [advanced machine learning versioning](https://kedro-mlflow.readthedocs.io/en/latest/source/04_experimentation_tracking/index.html) to show more advanced features (mlflow configuration through the plugin, package and serve a kedro ``Pipeline``...)\n- A section to demonstrate how to use `kedro-mlflow` as a [machine learning framework](https://kedro-mlflow.readthedocs.io/en/latest/source/05_framework_ml/index.html) to deliver production ready pipelines and serve them. This section comes with [an example repo](https://github.com/Galileo-Galilei/kedro-mlflow-tutorial) you can clone and try out.\n\nSome frequently asked questions on more advanced features:\n\n- You want to log additional metrics to the run? -> [Try ``MlflowMetricsHistoryDataset``](https://kedro-mlflow.readthedocs.io/en/stable/source/04_experimentation_tracking/05_version_metrics.html) !\n- You want to log nice dataviz of your pipeline that you register with ``MatplotlibWriter``? -> [Try ``MlflowArtifactDataset`` to log any local files (.png, .pkl, .csv...) *automagically*](https://kedro-mlflow.readthedocs.io/en/stable/source/04_experimentation_tracking/03_version_datasets.html)!\n- You want to create easily an API to share your awesome model to anyone? -> [See if ``pipeline_ml_factory`` can fit your needs](https://github.com/Galileo-Galilei/kedro-mlflow/issues/16)\n- You want to do something that is not straigthforward with current implementation? Open an issue, and let's see what happens!\n\n# Release and roadmap\n\nThe [release history](https://github.com/Galileo-Galilei/kedro-mlflow/blob/master/CHANGELOG.md) centralizes packages improvements across time. The main features coming in next releases are [listed on github milestones](https://github.com/Galileo-Galilei/kedro-mlflow/milestones). Feel free to upvote/downvote and discuss prioritization in associated issues.\n\n# Disclaimer\n\nThis package is still in active development. We use [SemVer](https://semver.org/) principles to version our releases. Until we reach `1.0.0` milestone, breaking changes will lead to `<minor>` version number increment, while releases which do not introduce breaking changes in the API will lead to `<patch>` version number increment.\n\nThe user must be aware that we will not reach `1.0.0` milestone before Kedro does (mlflow has already reached `1.0.0`). **That said, the API is considered as stable from 0.8.0 version and user can reliably consider that no consequent breaking change will happen unless necessary for Kedro compatibility (e.g. for minor or major Kedro version).**\n\nIf you want to migrate from an older version of `kedro-mlflow` to most recent ones, see the [migration guide](https://kedro-mlflow.readthedocs.io/en/stable/source/02_installation/03_migration_guide.html).\n\n\n# Can I contribute?\n\nWe'd be happy to receive help to maintain and improve the package. Any PR will be considered (from typo in the docs to core features add-on) Please check the [contributing guidelines](https://github.com/Galileo-Galilei/kedro-mlflow/blob/master/CONTRIBUTING.md).\n\n# Main contributors\n\nThe following people actively maintain, enhance and discuss design to make this package as good as possible:\n\n- [Yolan Honor\u00e9-Roug\u00e9](https://github.com/galileo-galilei)\n- [Takieddine Kadiri](https://github.com/takikadiri)\n\nMany thanks to [Adrian Piotr Kruszewski](https://github.com/akruszewski) for his past work on the repo.\n",
"bugtrack_url": null,
"license": "Apache Software License (Apache 2.0)",
"summary": "A kedro-plugin to use mlflow in your kedro projects",
"version": "0.13.4",
"project_urls": {
"Homepage": "https://github.com/Galileo-Galilei/kedro-mlflow"
},
"split_keywords": [
"kedro-plugin",
" mlflow",
" model versioning",
" model packaging",
" pipelines",
" machine learning",
" data pipelines",
" data science",
" data engineering"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b79f9fd413500b84db010d8fe4eef8c63e0116e3082bdbd03ab6018666a7400d",
"md5": "26b9b76a14e3fc4e9fcc6d059f8b5f58",
"sha256": "721c74a586f93701f0100ec390edf028a99a31582f3134beec40723ca341bb86"
},
"downloads": -1,
"filename": "kedro_mlflow-0.13.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26b9b76a14e3fc4e9fcc6d059f8b5f58",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 52987,
"upload_time": "2024-12-14T20:13:18",
"upload_time_iso_8601": "2024-12-14T20:13:18.395102Z",
"url": "https://files.pythonhosted.org/packages/b7/9f/9fd413500b84db010d8fe4eef8c63e0116e3082bdbd03ab6018666a7400d/kedro_mlflow-0.13.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6a62384046aea51cb6291486e15c90c8f14823e628011fbd4d10699af2213bce",
"md5": "642e3ccebd64e9ef9b45cd8233303610",
"sha256": "62c30ba7bfa6d35a31d823ebb0e0be1332d22ee8dc8876ac7803bde803af0e2b"
},
"downloads": -1,
"filename": "kedro_mlflow-0.13.4.tar.gz",
"has_sig": false,
"md5_digest": "642e3ccebd64e9ef9b45cd8233303610",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 969848,
"upload_time": "2024-12-14T20:13:21",
"upload_time_iso_8601": "2024-12-14T20:13:21.024650Z",
"url": "https://files.pythonhosted.org/packages/6a/62/384046aea51cb6291486e15c90c8f14823e628011fbd4d10699af2213bce/kedro_mlflow-0.13.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-14 20:13:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Galileo-Galilei",
"github_project": "kedro-mlflow",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "kedro",
"specs": [
[
"<",
"0.20.0"
],
[
">=",
"0.19.0"
]
]
},
{
"name": "kedro_datasets",
"specs": []
},
{
"name": "mlflow",
"specs": [
[
"<",
"3.0.0"
],
[
">=",
"1.29.0"
]
]
},
{
"name": "pydantic",
"specs": [
[
"<",
"3.0.0"
],
[
">=",
"1.0.0"
]
]
}
],
"lcname": "kedro-mlflow"
}
JSON
