![version](https://img.shields.io/badge/version-0.4.0-green) [![Tests](https://github.com/trustyai-python/module/actions/workflows/workflow.yml/badge.svg)](https://github.com/trustyai-python/examples/actions/workflows/workflow.yml)
# python-trustyai
Python bindings to [TrustyAI](https://kogito.kie.org/trustyai/)'s explainability library.
## Setup
### PyPi
Install from PyPi with
```shell
pip install trustyai
```
To install additional experimental features, also use
```shell
pip install trustyai[extras]
```
### Local
The minimum dependencies can be installed (from the root directory) with
```shell
pip install .
```
If running the examples or developing, also install the development dependencies:
```shell
pip install '.[dev]'
```
### Docker
Alternatively create a container image and run it using
```shell
$ docker build -f Dockerfile -t python-trustyai:latest .
$ docker run --rm -it -p 8888:8888 python-trustyai:latest
```
The Jupyter server will be available at `localhost:8888`.
### Binder
You can also run the example Jupyter notebooks
using `mybinder.org`: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/trustyai-python/trustyai-explainability-python-examples/main?labpath=examples)
## Documentation
Check out the [ReadTheDocs page](https://trustyai-explainability-python.readthedocs.io/en/latest/) for API references
and examples.
## Getting started
### Examples
There are several working examples available in the [examples](https://github.com/trustyai-explainability/trustyai-explainability-python-examples/tree/main/examples) repository.
## Contributing
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for instructions on how to contribute to this project.
Raw data
{
"_id": null,
"home_page": "",
"name": "trustyai",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "trustyai,xai,explainability,ml",
"author": "",
"author_email": "Rui Vieira <rui@redhat.com>",
"download_url": "https://files.pythonhosted.org/packages/3b/ee/3175faf20750224a1e65c03b9019d68653e7a0e986550f5843a6249ae9a7/trustyai-0.5.0.tar.gz",
"platform": null,
"description": "![version](https://img.shields.io/badge/version-0.4.0-green) [![Tests](https://github.com/trustyai-python/module/actions/workflows/workflow.yml/badge.svg)](https://github.com/trustyai-python/examples/actions/workflows/workflow.yml)\n\n# python-trustyai\n\nPython bindings to [TrustyAI](https://kogito.kie.org/trustyai/)'s explainability library.\n\n## Setup\n\n### PyPi\n\nInstall from PyPi with\n\n```shell\npip install trustyai\n```\n\nTo install additional experimental features, also use\n\n```shell\npip install trustyai[extras]\n```\n\n### Local\n\nThe minimum dependencies can be installed (from the root directory) with\n\n```shell\npip install .\n```\n\nIf running the examples or developing, also install the development dependencies:\n\n```shell\npip install '.[dev]'\n```\n\n### Docker\n\nAlternatively create a container image and run it using\n\n```shell\n$ docker build -f Dockerfile -t python-trustyai:latest .\n$ docker run --rm -it -p 8888:8888 python-trustyai:latest\n```\n\nThe Jupyter server will be available at `localhost:8888`.\n\n### Binder\n\nYou can also run the example Jupyter notebooks\nusing `mybinder.org`: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/trustyai-python/trustyai-explainability-python-examples/main?labpath=examples)\n\n## Documentation\n\nCheck out the [ReadTheDocs page](https://trustyai-explainability-python.readthedocs.io/en/latest/) for API references\nand examples.\n\n## Getting started\n\n### Examples\n\nThere are several working examples available in the [examples](https://github.com/trustyai-explainability/trustyai-explainability-python-examples/tree/main/examples) repository.\n\n## Contributing\n\nPlease see the [CONTRIBUTING.md](CONTRIBUTING.md) file for instructions on how to contribute to this project.\n",
"bugtrack_url": null,
"license": "Apache License Version 2.0",
"summary": "Python bindings to the TrustyAI explainability library.",
"version": "0.5.0",
"project_urls": {
"documentation": "https://trustyai-explainability-python.readthedocs.io/en/latest/",
"homepage": "https://github.com/trustyai-explainability/trustyai-explainability-python",
"repository": "https://github.com/trustyai-explainability/trustyai-explainability-python"
},
"split_keywords": [
"trustyai",
"xai",
"explainability",
"ml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bee25a964f7eef45b185c20536aab4a8c47cf45dba7da1f4598b6105eb54b97d",
"md5": "d354b06366a452a10cb165b0b952bb48",
"sha256": "ae3a8a964cbe1a9fd60af8a3af23128f7ad11f59864e44e6f442f245ff9338ab"
},
"downloads": -1,
"filename": "trustyai-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d354b06366a452a10cb165b0b952bb48",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 21015300,
"upload_time": "2024-02-02T13:31:39",
"upload_time_iso_8601": "2024-02-02T13:31:39.965140Z",
"url": "https://files.pythonhosted.org/packages/be/e2/5a964f7eef45b185c20536aab4a8c47cf45dba7da1f4598b6105eb54b97d/trustyai-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3bee3175faf20750224a1e65c03b9019d68653e7a0e986550f5843a6249ae9a7",
"md5": "34b9bc0e2e6e79fea51028b1136a2288",
"sha256": "5e7a9dfe1bcaa10d1192fcd08bee66c7903cafc3ae2f5b2ceadf90cbeecbeb25"
},
"downloads": -1,
"filename": "trustyai-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "34b9bc0e2e6e79fea51028b1136a2288",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21007264,
"upload_time": "2024-02-02T13:31:44",
"upload_time_iso_8601": "2024-02-02T13:31:44.130615Z",
"url": "https://files.pythonhosted.org/packages/3b/ee/3175faf20750224a1e65c03b9019d68653e7a0e986550f5843a6249ae9a7/trustyai-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-02 13:31:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "trustyai-explainability",
"github_project": "trustyai-explainability-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "JPype1",
"specs": [
[
"==",
"1.4.1"
]
]
},
{
"name": "matplotlib",
"specs": [
[
"==",
"3.6.3"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"1.2.5"
]
]
},
{
"name": "pyarrow",
"specs": [
[
"==",
"14.0.1"
]
]
},
{
"name": "jupyter-bokeh",
"specs": [
[
"~=",
"3.0.5"
]
]
}
],
"lcname": "trustyai"
}