# Rules extraction 
Rules extraction for eXplainable AI
* [Documentation](https://hes-xplain.github.io/rules-extraction/)
## Installation
```
pip install rules-extraction
```
## Contribution
### Install Python
Install [Python](https://www.python.org/), version 3.9 or newer (3.11 recommanded):
* **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.
#### Add dependencies
To add new dependencies to the project, add them to the `pyproject.toml` file.
To add them to the virtualenv, use:
```
pip install .
```
### 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/rules-extraction/), refer to [RELEASE](RELEASE.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "rules-extraction",
"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>",
"download_url": "https://files.pythonhosted.org/packages/47/32/3c00d19f637b43686fc5cb0d231aa7bfa9af3f3cc7fe71133decdb59bf51/rules_extraction-0.1.4.tar.gz",
"platform": null,
"description": "# Rules extraction \n\nRules extraction for eXplainable AI\n\n* [Documentation](https://hes-xplain.github.io/rules-extraction/)\n\n## Installation\n\n```\npip install rules-extraction\n```\n\n## Contribution\n\n### Install Python\n\nInstall [Python](https://www.python.org/), version 3.9 or newer (3.11 recommanded):\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#### Add dependencies\n\nTo add new dependencies to the project, add them to the `pyproject.toml` file.\nTo add them to the virtualenv, use:\n\n```\npip install .\n```\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/rules-extraction/), refer to [RELEASE](RELEASE.md).\n",
"bugtrack_url": null,
"license": "3-Clause BSD License",
"summary": "Rules extraction for eXplainable AI",
"version": "0.1.4",
"project_urls": null,
"split_keywords": [
"machine learning",
" xai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be3403e0956c694cf6c750bdc577003a968899e2fe7c01e55b273d7d4ee9499d",
"md5": "96f74d287e8dea62d98479509fb1a31e",
"sha256": "dc56f8e7441c0d4912a80577c6778ab03b31e40b4c135e6489c40e1d5ab2e1d4"
},
"downloads": -1,
"filename": "rules_extraction-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "96f74d287e8dea62d98479509fb1a31e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 11659,
"upload_time": "2024-08-29T12:39:22",
"upload_time_iso_8601": "2024-08-29T12:39:22.880272Z",
"url": "https://files.pythonhosted.org/packages/be/34/03e0956c694cf6c750bdc577003a968899e2fe7c01e55b273d7d4ee9499d/rules_extraction-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "47323c00d19f637b43686fc5cb0d231aa7bfa9af3f3cc7fe71133decdb59bf51",
"md5": "b6b4bfce75146995cd3b86363d7dcddf",
"sha256": "fbea5318af575f76c03c3b273609d1bb2643838112d11312a1347bd0f4d1d01e"
},
"downloads": -1,
"filename": "rules_extraction-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "b6b4bfce75146995cd3b86363d7dcddf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 16949,
"upload_time": "2024-08-29T12:39:23",
"upload_time_iso_8601": "2024-08-29T12:39:23.895760Z",
"url": "https://files.pythonhosted.org/packages/47/32/3c00d19f637b43686fc5cb0d231aa7bfa9af3f3cc7fe71133decdb59bf51/rules_extraction-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-29 12:39:23",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "rules-extraction"
}
JSON