rules-extraction


Namerules-extraction JSON
Version 0.1.0 PyPI version JSON
download
home_page
SummaryRules extraction for eXplainable AI
upload_time2024-01-17 08:52:49
maintainer
docs_urlNone
author
requires_python>=3.8.1
license3-Clause BSD License
keywords machine learning xai
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Rules extraction ![Python checks](https://github.com/HES-XPLAIN/rules-extraction/actions/workflows/build.yml/badge.svg)

Rules extraction for eXplainable AI

* [Documentation](https://hes-xplain.github.io/rules-extraction/docs/)
* [Coverage](https://hes-xplain.github.io/rules-extraction/cov/)

## Contribution

### Install dependencies

#### Using pip

```shell
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.lock
```

#### Using Rye

- Install [Rye](https://rye-up.com/) and [add shims](https://rye-up.com/guide/installation/) to your PATH.

Ensure `rye` is accessible in the `$PATH` environment variable.
Rye will automatically download the suitable Python toolchain as needed.

To check the installation, check the following commands return an output:

```shell
rye --version
```

Install python dependencies and activate the virtualenv:

```shell
rye sync
rye shell
```

### Install Pre-commit hooks

Git hooks are used to ensure quality checks are run by all developers every time
before a 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": "",
    "name": "rules-extraction",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8.1",
    "maintainer_email": "",
    "keywords": "machine learning,xai",
    "author": "",
    "author_email": "Arthur Babey <arthur.babey@heig-vd.ch>",
    "download_url": "https://files.pythonhosted.org/packages/12/90/30db0336a830691769a16efcd4cf1769555367d8fc8e65bdd4f670aba6f2/rules_extraction-0.1.0.tar.gz",
    "platform": null,
    "description": "# Rules extraction ![Python checks](https://github.com/HES-XPLAIN/rules-extraction/actions/workflows/build.yml/badge.svg)\n\nRules extraction for eXplainable AI\n\n* [Documentation](https://hes-xplain.github.io/rules-extraction/docs/)\n* [Coverage](https://hes-xplain.github.io/rules-extraction/cov/)\n\n## Contribution\n\n### Install dependencies\n\n#### Using pip\n\n```shell\npython -m venv .venv\nsource .venv/bin/activate\npip install -r requirements.lock\n```\n\n#### Using Rye\n\n- Install [Rye](https://rye-up.com/) and [add shims](https://rye-up.com/guide/installation/) to your PATH.\n\nEnsure `rye` is accessible in the `$PATH` environment variable.\nRye will automatically download the suitable Python toolchain as needed.\n\nTo check the installation, check the following commands return an output:\n\n```shell\nrye --version\n```\n\nInstall python dependencies and activate the virtualenv:\n\n```shell\nrye sync\nrye shell\n```\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\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.0",
    "project_urls": null,
    "split_keywords": [
        "machine learning",
        "xai"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0f735eef0df0575c1da795cc8f43670e011df0c649758d23e3ac5f0320c37b98",
                "md5": "966e0a2e2ce793d037a48be0426834f8",
                "sha256": "b3a24702c58f9cc953586be606ffdea3cecb1de8ef441c0b115619864c195f02"
            },
            "downloads": -1,
            "filename": "rules_extraction-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "966e0a2e2ce793d037a48be0426834f8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.1",
            "size": 11234,
            "upload_time": "2024-01-17T08:52:48",
            "upload_time_iso_8601": "2024-01-17T08:52:48.044643Z",
            "url": "https://files.pythonhosted.org/packages/0f/73/5eef0df0575c1da795cc8f43670e011df0c649758d23e3ac5f0320c37b98/rules_extraction-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "129030db0336a830691769a16efcd4cf1769555367d8fc8e65bdd4f670aba6f2",
                "md5": "921756029ed8a50adf889065aa8b35c4",
                "sha256": "80667d2b5561096794ae274ef96fd4c3a24f8c33e02c9afecba08c0b8a5866a5"
            },
            "downloads": -1,
            "filename": "rules_extraction-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "921756029ed8a50adf889065aa8b35c4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.1",
            "size": 16889,
            "upload_time": "2024-01-17T08:52:49",
            "upload_time_iso_8601": "2024-01-17T08:52:49.639419Z",
            "url": "https://files.pythonhosted.org/packages/12/90/30db0336a830691769a16efcd4cf1769555367d8fc8e65bdd4f670aba6f2/rules_extraction-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-17 08:52:49",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "rules-extraction"
}
Elapsed time: 0.16522s