|MLnext| MLnext Framework
=========================
.. |MLnext| image:: https://raw.githubusercontent.com/PLCnext/MLnext-Framework/main/docs/source/_static/mlnext.png
|pypi| |python| |mypy| |license| |Digital Factory Now| |docs|
.. |pypi| image:: https://badge.fury.io/py/mlnext-framework.svg
:target: https://pypi.org/project/mlnext-framework/
:alt: Latest Version
.. |python| image:: https://img.shields.io/pypi/pyversions/mlnext-framework
:target: https://www.python.org/
:alt: Supported Python Versions
.. |mypy| image:: http://www.mypy-lang.org/static/mypy_badge.svg
:target: http://mypy-lang.org/
:alt: MyPy checked
.. |license| image:: https://img.shields.io/github/license/PLCnext/MLnext-Framework.svg
:target: https://github.com/PLCnext/MLnext-Framework/blob/master/LICENSE
:alt: License
.. |Digital Factory Now| image:: https://img.shields.io/badge/Digital%20Factory-Now-blue.svg
:target: https://www.phoenixcontact.com/online/portal/pi?1dmy&urile=wcm:path:/pien/web/offcontext/insite_landing_pages/176a6497-e932-4acc-87bc-798c7a9f8aad/176a6497-e932-4acc-87bc-798c7a9f8aad
.. |docs| image:: https://readthedocs.org/projects/mlnext-framework/badge/?version=latest
:target: https://mlnext-framework.readthedocs.io/en/latest/?badge=latest
*MLnext Framework* is an open source framework for hardware independent execution of machine learning using *Python* and *Docker*.
It provides machine learning utilities.
The corresponding *Python* package is called *mlnext-framework*.
MLnext Framework belongs to a solution portfolio for the Digital Factory now to realize Data collection, storage, and evaluation.
Digitalization is posing numerous challenges for production --- but above all, it provides countless opportunities for increasing productivity and system availability.
To ensure that you benefit from the advantages of digitalization as quickly as possible, we will provide you with needs-based support --- from installing simple stand-alone solutions to comprehensive digitalization concepts.
The Digital Factory now is based on the following four fields of activity:
- Data collection, storage, and evaluation
- Data transportation
- Data security
- Data usage
The four fields of action provide you with various solutions, from data acquisition to data utilization. Each individual solution will not only be tailored to your particular requirements; the fields of action can also be combined in any way or considered individually.
Regardless of which path you are taking toward the Digital Factory, we will be happy to support you during the next steps.
To help you to meet today's digitalization challenges and implement opportunities profitably, our solutions provide the following added values:
- Scalability --- tailored to your requirements
- Tested and validated --- in our own in-house production facilities
- Ready-to-use --- benefit from the digital transformation today
With target-oriented consultation, we will find the right solution for your Digital Factory together. Let us take on the challenges of digitalization and leverage its opportunities together.
Installation
------------
Install this package using ``pip``\ :
.. code-block:: bash
pip install mlnext-framework
Modules
-------
The *MLnext Framework* consists of 7 modules:
.. code-block:: python
import mlnext.data as data # for data loading and manipulation
import mlnext.io as io # for loading and saving files
import mlnext.pipeline as pipeline # for data preprocessing
import mlnext.plot as plot # for data visualization
import mlnext.score as score # for model evaluation
import mlnext.anomaly as anomaly # for anomaly interpretation
import mlnext.utils as utils # for utility functions
# hint: all functions can also be accessed from the root module
import mlnext
Development
-----------
MLnext uses `rye <https://rye.astral.sh/>`_ to manage the development environment.
Install rye by following the instructions on their website and run ``rye sync`` to setup the development environment.
Furthermore, we use black and ruff to enforce style standards on the codebase.
The formatting is done for you via pre-commit, and is enforced via the ``tox -e lint`` in the CI/CD.
Run ``pre-commit install`` to set up the git hooks;
subsequently, when you git commit, the formatter will be run. If the
changed files are not conformant, the hook will have reformatted them and
you may need to run pre-commit again. You can run ``pre-commit run --all-files``
to manually run the formatters.
Build the documentation by running ``tox -e docs``.
Raw data
{
"_id": null,
"home_page": null,
"name": "mlnext-framework",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "learning, machine, mlnext, utilities",
"author": null,
"author_email": "PHOENIX CONTACT Electronics GmbH <digitalfactorynow@phoenixcontact.com>, Gorden Platz <gplatz@phoenixcontact.com>",
"download_url": "https://files.pythonhosted.org/packages/be/16/8cff904683e47f831084bf188a0b015944abf083f0583ba0a91cba4383b7/mlnext_framework-0.6.1.tar.gz",
"platform": null,
"description": "|MLnext| MLnext Framework\n=========================\n\n.. |MLnext| image:: https://raw.githubusercontent.com/PLCnext/MLnext-Framework/main/docs/source/_static/mlnext.png\n\n|pypi| |python| |mypy| |license| |Digital Factory Now| |docs|\n\n\n.. |pypi| image:: https://badge.fury.io/py/mlnext-framework.svg\n :target: https://pypi.org/project/mlnext-framework/\n :alt: Latest Version\n\n.. |python| image:: https://img.shields.io/pypi/pyversions/mlnext-framework\n :target: https://www.python.org/\n :alt: Supported Python Versions\n\n.. |mypy| image:: http://www.mypy-lang.org/static/mypy_badge.svg\n :target: http://mypy-lang.org/\n :alt: MyPy checked\n\n.. |license| image:: https://img.shields.io/github/license/PLCnext/MLnext-Framework.svg\n :target: https://github.com/PLCnext/MLnext-Framework/blob/master/LICENSE\n :alt: License\n\n.. |Digital Factory Now| image:: https://img.shields.io/badge/Digital%20Factory-Now-blue.svg\n :target: https://www.phoenixcontact.com/online/portal/pi?1dmy&urile=wcm:path:/pien/web/offcontext/insite_landing_pages/176a6497-e932-4acc-87bc-798c7a9f8aad/176a6497-e932-4acc-87bc-798c7a9f8aad\n\n.. |docs| image:: https://readthedocs.org/projects/mlnext-framework/badge/?version=latest\n :target: https://mlnext-framework.readthedocs.io/en/latest/?badge=latest\n\n*MLnext Framework* is an open source framework for hardware independent execution of machine learning using *Python* and *Docker*.\nIt provides machine learning utilities.\nThe corresponding *Python* package is called *mlnext-framework*.\nMLnext Framework belongs to a solution portfolio for the Digital Factory now to realize Data collection, storage, and evaluation.\n\nDigitalization is posing numerous challenges for production --- but above all, it provides countless opportunities for increasing productivity and system availability.\nTo ensure that you benefit from the advantages of digitalization as quickly as possible, we will provide you with needs-based support --- from installing simple stand-alone solutions to comprehensive digitalization concepts.\n\nThe Digital Factory now is based on the following four fields of activity:\n\n- Data collection, storage, and evaluation\n- Data transportation\n- Data security\n- Data usage\n\nThe four fields of action provide you with various solutions, from data acquisition to data utilization. Each individual solution will not only be tailored to your particular requirements; the fields of action can also be combined in any way or considered individually.\nRegardless of which path you are taking toward the Digital Factory, we will be happy to support you during the next steps.\n\nTo help you to meet today's digitalization challenges and implement opportunities profitably, our solutions provide the following added values:\n\n- Scalability --- tailored to your requirements\n- Tested and validated --- in our own in-house production facilities\n- Ready-to-use --- benefit from the digital transformation today\n\nWith target-oriented consultation, we will find the right solution for your Digital Factory together. Let us take on the challenges of digitalization and leverage its opportunities together.\n\n\nInstallation\n------------\n\nInstall this package using ``pip``\\ :\n\n.. code-block:: bash\n\n pip install mlnext-framework\n\nModules\n-------\n\nThe *MLnext Framework* consists of 7 modules:\n\n.. code-block:: python\n\n import mlnext.data as data # for data loading and manipulation\n import mlnext.io as io # for loading and saving files\n import mlnext.pipeline as pipeline # for data preprocessing\n import mlnext.plot as plot # for data visualization\n import mlnext.score as score # for model evaluation\n import mlnext.anomaly as anomaly # for anomaly interpretation\n import mlnext.utils as utils # for utility functions\n\n # hint: all functions can also be accessed from the root module\n import mlnext\n\n\nDevelopment\n-----------\n\nMLnext uses `rye <https://rye.astral.sh/>`_ to manage the development environment.\nInstall rye by following the instructions on their website and run ``rye sync`` to setup the development environment.\n\nFurthermore, we use black and ruff to enforce style standards on the codebase.\nThe formatting is done for you via pre-commit, and is enforced via the ``tox -e lint`` in the CI/CD.\nRun ``pre-commit install`` to set up the git hooks;\nsubsequently, when you git commit, the formatter will be run. If the\nchanged files are not conformant, the hook will have reformatted them and\nyou may need to run pre-commit again. You can run ``pre-commit run --all-files``\nto manually run the formatters.\n\nBuild the documentation by running ``tox -e docs``.\n",
"bugtrack_url": null,
"license": null,
"summary": "Machine learning utilities.",
"version": "0.6.1",
"project_urls": {
"Documentation": "https://mlnext-framework.readthedocs.io/en/latest/",
"Repository": "https://github.com/PLCnext/MLnext-Framework"
},
"split_keywords": [
"learning",
" machine",
" mlnext",
" utilities"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6a32d182a59415100897ca8f1e98ff1fadb71b897f23cdeac81c75b12ff10324",
"md5": "df9b45675435650345dbcabb78ac464e",
"sha256": "4d18938c58507188d7259a6c0c5138085b56f09f0665cd2d7969ada43f54d6ef"
},
"downloads": -1,
"filename": "mlnext_framework-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df9b45675435650345dbcabb78ac464e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 41562,
"upload_time": "2024-11-21T22:19:24",
"upload_time_iso_8601": "2024-11-21T22:19:24.546713Z",
"url": "https://files.pythonhosted.org/packages/6a/32/d182a59415100897ca8f1e98ff1fadb71b897f23cdeac81c75b12ff10324/mlnext_framework-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be168cff904683e47f831084bf188a0b015944abf083f0583ba0a91cba4383b7",
"md5": "91d591941bda1b708c5c7ff6455c48cb",
"sha256": "01a376086058513cfd49597f6d198c0f524bae764bed2e54cbd0d7ee8768c903"
},
"downloads": -1,
"filename": "mlnext_framework-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "91d591941bda1b708c5c7ff6455c48cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 561608,
"upload_time": "2024-11-21T22:19:26",
"upload_time_iso_8601": "2024-11-21T22:19:26.562930Z",
"url": "https://files.pythonhosted.org/packages/be/16/8cff904683e47f831084bf188a0b015944abf083f0583ba0a91cba4383b7/mlnext_framework-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 22:19:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PLCnext",
"github_project": "MLnext-Framework",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "mlnext-framework"
}
JSON
