| Name | mlxplain JSON |
| Version |
1.0.4
JSON |
| download |
| home_page | None |
| Summary | An open platform for accelerating the development of eXplainable AI systems |
| upload_time | 2024-09-04 13:59:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9.0 |
| license | 3-Clause BSD License |
| keywords |
machine learning
xai
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MLxplain 
An open platform for accelerating the development of eXplainable AI systems
* [Documentation](https://hes-xplain.github.io/mlxplain/)
## Installation
```
pip install mlxplain
```
## Contribution
### Install Python
Install [Python](https://www.python.org/), version 3.9 or newer (3.11 recommended):
* **Linux, macOS, Windows/WSL**: Use your package manager to install `python3` and `python3-dev`
* **Windows**: `winget install Python.Python.3.11`
> [!WARNING]
> On Windows, avoid installing Python through the Microsoft Store as the package has additional permission restrictions.
### Install dependencies
Using pip
```shell
python -m venv .venv
source .venv/bin/activate
pip install .
```
> [!NOTE]
> On Windows, use `.venv\Scripts\activate` instead.
### Work with virtualenv
To activate the virtualenv, use the standard methods:
* Unix: `source .venv/bin/activate`
* Windows: `.venv\Scripts\activate`
To leave the virtualenv, use `deactivate`.
### Install Pre-commit hooks
Git hooks are used to ensure quality checks are run by all developers every time
before a commit.
Install with `pip install pre-commit`.
To enable pre-commit:
```shell
pre-commit install
```
Pre-commit hooks can be run manually with:
```shell
pre-commit run --all-files
```
## Release
To publish the package on [PyPI](https://pypi.org/project/mlxplain/), refer to [RELEASE](RELEASE.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "mlxplain",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": null,
"keywords": "machine learning, xai",
"author": null,
"author_email": "Arthur Babey <arthur.babey@heig-vd.ch>, Jean-Marc Boutay <jean-marc.boutay@heige.ch>, R\u00e9my Marquis <remy.marquis@heig-vd.ch>",
"download_url": "https://files.pythonhosted.org/packages/21/30/a27f48f356ef98138d8ad0d46427ec29c571b07ab321748710b351852a51/mlxplain-1.0.4.tar.gz",
"platform": null,
"description": "# MLxplain \nAn open platform for accelerating the development of eXplainable AI systems\n\n* [Documentation](https://hes-xplain.github.io/mlxplain/)\n\n## Installation\n\n```\npip install mlxplain\n```\n\n## Contribution\n\n### Install Python\n\nInstall [Python](https://www.python.org/), version 3.9 or newer (3.11 recommended):\n\n* **Linux, macOS, Windows/WSL**: Use your package manager to install `python3` and `python3-dev`\n* **Windows**: `winget install Python.Python.3.11`\n\n> [!WARNING]\n> On Windows, avoid installing Python through the Microsoft Store as the package has additional permission restrictions.\n\n### Install dependencies\n\nUsing pip\n\n```shell\npython -m venv .venv\nsource .venv/bin/activate\npip install .\n```\n\n> [!NOTE]\n> On Windows, use `.venv\\Scripts\\activate` instead.\n\n### Work with virtualenv\n\nTo activate the virtualenv, use the standard methods:\n\n* Unix: `source .venv/bin/activate`\n* Windows: `.venv\\Scripts\\activate`\n\nTo leave the virtualenv, use `deactivate`.\n\n### Install Pre-commit hooks\n\nGit hooks are used to ensure quality checks are run by all developers every time\nbefore a commit.\n\nInstall with `pip install pre-commit`.\n\nTo enable pre-commit:\n\n```shell\npre-commit install\n```\n\nPre-commit hooks can be run manually with:\n\n```shell\npre-commit run --all-files\n```\n\n## Release\n\nTo publish the package on [PyPI](https://pypi.org/project/mlxplain/), refer to [RELEASE](RELEASE.md).\n",
"bugtrack_url": null,
"license": "3-Clause BSD License",
"summary": "An open platform for accelerating the development of eXplainable AI systems",
"version": "1.0.4",
"project_urls": null,
"split_keywords": [
"machine learning",
" xai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a534b510d554417c57775aa380aea4fafffa4647d71cc0910eb74cbe67c7764d",
"md5": "54f7c586fe9a7818076679c4215d37d0",
"sha256": "c9938ad0a03c333a2513d8405d9b911a8e4ec5de8a0e6ed06f161799ff8327ea"
},
"downloads": -1,
"filename": "mlxplain-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "54f7c586fe9a7818076679c4215d37d0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 20493,
"upload_time": "2024-09-04T13:59:01",
"upload_time_iso_8601": "2024-09-04T13:59:01.961520Z",
"url": "https://files.pythonhosted.org/packages/a5/34/b510d554417c57775aa380aea4fafffa4647d71cc0910eb74cbe67c7764d/mlxplain-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2130a27f48f356ef98138d8ad0d46427ec29c571b07ab321748710b351852a51",
"md5": "012dbee59c18ad959f27af47ed5c000b",
"sha256": "543c1ff2a295df7713c4d4b6b55b022cb21d984ece5204b60682289098f64990"
},
"downloads": -1,
"filename": "mlxplain-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "012dbee59c18ad959f27af47ed5c000b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 1857032,
"upload_time": "2024-09-04T13:59:03",
"upload_time_iso_8601": "2024-09-04T13:59:03.451474Z",
"url": "https://files.pythonhosted.org/packages/21/30/a27f48f356ef98138d8ad0d46427ec29c571b07ab321748710b351852a51/mlxplain-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-04 13:59:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mlxplain"
}
