# kedro-softfail-runner
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
This file will become your README and also the index of your
documentation.
## Install
``` sh
pip install kedro_softfail_runner
```
## How to use
Fill me in please! Don’t forget code examples:
`kedro run --runner=kedro_softfail_runner.SoftFailRunner`
# Why is it useful?
> The team created a soft-fail runner to transform errors into warnings,
> allowing the pipeline to continue executing to the best of its ability
> while providing a report of any nodes that failed, so that data issues
> can be addressed. At that point, the pipeline run can be finalised by
> executing only those missing nodes separately, using appropriate Kedro
> syntax. https://kedro.org/blog/build-a-custom-kedro-runner
It’s most useful in two different scenarios: 1. Development - you want
to detect all problematic nodes in one go 2. Deployment - you want to
run as much node as you can before the Kedro pipeline is stopped.
# Why is it not in Kedro yet?
Note that the
[`SoftFailRunner`](https://noklam.github.io/kedro-softfail-runner/core.html#softfailrunner)
does not return anything, that is `result = session.run()` normally
returns a dictionary of free output, but it will be always `None` for
[`SoftFailRunner`](https://noklam.github.io/kedro-softfail-runner/core.html#softfailrunner)
due to implementation problem.
Other than that, there are no other known issues yet. In order to merge
this into the core library, this problem need to be fixed and the runner
should be test thoroughly.
Raw data
{
"_id": null,
"home_page": "https://github.com/noklam/kedro-softfail-runner",
"name": "kedro-softfail-runner",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python",
"author": "noklam",
"author_email": "mediumnok@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/bb/26/03a21bec18821d254cc625814df3aac694b075b2e670dc48cae85d06e4e4/kedro-softfail-runner-0.0.3.tar.gz",
"platform": null,
"description": "# kedro-softfail-runner\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\nThis file will become your README and also the index of your\ndocumentation.\n\n## Install\n\n``` sh\npip install kedro_softfail_runner\n```\n\n## How to use\n\nFill me in please! Don\u2019t forget code examples:\n\n`kedro run --runner=kedro_softfail_runner.SoftFailRunner`\n\n# Why is it useful?\n\n> The team created a soft-fail runner to transform errors into warnings,\n> allowing the pipeline to continue executing to the best of its ability\n> while providing a report of any nodes that failed, so that data issues\n> can be addressed. At that point, the pipeline run can be finalised by\n> executing only those missing nodes separately, using appropriate Kedro\n> syntax. https://kedro.org/blog/build-a-custom-kedro-runner\n\nIt\u2019s most useful in two different scenarios: 1. Development - you want\nto detect all problematic nodes in one go 2. Deployment - you want to\nrun as much node as you can before the Kedro pipeline is stopped.\n\n# Why is it not in Kedro yet?\n\nNote that the\n[`SoftFailRunner`](https://noklam.github.io/kedro-softfail-runner/core.html#softfailrunner)\ndoes not return anything, that is `result = session.run()` normally\nreturns a dictionary of free output, but it will be always `None` for\n[`SoftFailRunner`](https://noklam.github.io/kedro-softfail-runner/core.html#softfailrunner)\ndue to implementation problem.\n\nOther than that, there are no other known issues yet. In order to merge\nthis into the core library, this problem need to be fixed and the runner\nshould be test thoroughly.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "A custom implemnetion of Kedro Runner to support softfailing",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/noklam/kedro-softfail-runner"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ab9ab82f6fefd2699fcb617f8976170b1da6896583f900e0102e0a8e0dc55bbe",
"md5": "bf1efc124f64ede4b9a97cfe75ec189a",
"sha256": "3a8cc99d15089ccf43c25d915d841d1e5748785c4663e9e7912185cf74f1c147"
},
"downloads": -1,
"filename": "kedro_softfail_runner-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf1efc124f64ede4b9a97cfe75ec189a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9793,
"upload_time": "2023-11-21T07:09:41",
"upload_time_iso_8601": "2023-11-21T07:09:41.180666Z",
"url": "https://files.pythonhosted.org/packages/ab/9a/b82f6fefd2699fcb617f8976170b1da6896583f900e0102e0a8e0dc55bbe/kedro_softfail_runner-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb2603a21bec18821d254cc625814df3aac694b075b2e670dc48cae85d06e4e4",
"md5": "f508d94d1a150bfde0cfe7d27289e7f4",
"sha256": "b339a58b83e34c894ffff8df7e716e8e48ceacf733461db9af1904329b7abcc9"
},
"downloads": -1,
"filename": "kedro-softfail-runner-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "f508d94d1a150bfde0cfe7d27289e7f4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9945,
"upload_time": "2023-11-21T07:09:42",
"upload_time_iso_8601": "2023-11-21T07:09:42.920473Z",
"url": "https://files.pythonhosted.org/packages/bb/26/03a21bec18821d254cc625814df3aac694b075b2e670dc48cae85d06e4e4/kedro-softfail-runner-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-21 07:09:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "noklam",
"github_project": "kedro-softfail-runner",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kedro-softfail-runner"
}
JSON
