Skip to main content

AI made Xplainable

Project description

Welcome to AntakIA !

Hi!

AntakIA is THE tool to explain an ML model or replace it with a collection of basic explainable models.

AntakIA can be used for many purposes: it may help you understand the truths your ML model has learned, or it can assist you in converting an ML model into multiple simple rule-based algorithms.

It achieves this by dividing a given ML model into smaller regions. Hence its name: Antakia is an ancient city famous for its mosaics (and IA is AI in French).

Here is a quick overview on AntakIA: AntakIA demo

See full video on Youtube.

Install

AntakIA is available on PyPI :

pip install antakia

Running example notebooks

Once you've installed antakia, you can download some of our notebook examples from our repo here.

Then, launch a Jupyter server from the notebook file (.ipynb) location :

jupyter notebook # or jupyter lab

You'll find a complete tutorial for our California housing example here : https://doc.antakia.ai

[!IMPORTANT] If you're using a virtual env, it's handy to be able to chose it from Jupyter's kernel list. Do the following :

python -m ipykernel install --user --name your_venv_name --display-name "My great virtual env"

Online demo

You can give antakia a try online : https://demo.antakia.ai

Log as demo with password antakia. Note it runs on a simple server and may be busy.

Run with Docker

[!IMPORTANT] Be sure to have a Docker engine running on your computer (ie. launch Docker Desktop)

docker build -t antakia .
docker run -p 8888:8888 antakia

In your Terminal, click on the http://127.0.0.1:8888/lab?token=WHATEVER_YOUR_TOKEN_IS URL link.

Logs

antakia is our open-source project. We plan to learn a lot from it to build our SaaS product, and earn our living. By default, antakia sends anonymous usage logs to our server. With this data, we cannot discover who you are, what you do, or what data you work on. It only tells us how people use the software. However, if you don't want us to receive this data, just create a .env file at the root of your project folder with the following line SEND_ANONYMOUS_LOGS=false

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

antakia-0.4.6.tar.gz (22.9 MB view details)

Uploaded Source

Built Distribution

antakia-0.4.6-py3-none-any.whl (23.5 MB view details)

Uploaded Python 3

File details

Details for the file antakia-0.4.6.tar.gz.

File metadata

  • Download URL: antakia-0.4.6.tar.gz
  • Upload date:
  • Size: 22.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.2 Darwin/23.4.0

File hashes

Hashes for antakia-0.4.6.tar.gz
Algorithm Hash digest
SHA256 59152f8ef4b77c1bf8c9acc06f4ad6b0ac69f1144db9b5e6cffd6c8c4a114382
MD5 c30301160da6a523cbcbe668e28e5003
BLAKE2b-256 d1ba6e48829d7e8f7d7b7764b427e1b24f94e15e0255cbbbd298db9b8e3da409

See more details on using hashes here.

File details

Details for the file antakia-0.4.6-py3-none-any.whl.

File metadata

  • Download URL: antakia-0.4.6-py3-none-any.whl
  • Upload date:
  • Size: 23.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.2 Darwin/23.4.0

File hashes

Hashes for antakia-0.4.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5e1e7df4b67b7ae4671f7aae179956b63a6b84b09634a708bba47592e379875d
MD5 5c832355a167469b2099321528fb886f
BLAKE2b-256 f7c288968b4f6b0d84636000400cc0f7c0686c62543cfa38de021a9025073db6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page