Client for Xaipient Explainability REST API
Project description
Powering your AI with human friendly explanations
Xaipient API Client (xac)
Status: Alpha, Version: 0.3.0
Documentation: https://xaipient.github.io/xaipient-docs/
Requirements
Python 3.6+
Installation
$ pip install xac
Python API
from xac import Explainer
Explainer.login('user@domain.com')
with Explainer() as german_explainer:
german_explainer.from_config('tests/sample/configs/german-keras.yaml')
global_imps = german_explainer.get_global_importances()
global_aligns = german_explainer.get_global_alignments()
global_rules = german_explainer.get_global_rules()
local_attrs = german_explainer.get_local_attributions(feature_row=4)
local_rules = german_explainer.get_global_rules(feature_row=4)
counterfactuals = german_explainer.get_counterfactuals(feature_row=4)
print(global_imps)
print(global_aligns)
print(global_rules)
print(local_attrs)
print(local_rules)
print(counterfactuals)
See Documentation for more details
Commandline interface
$ xac login --email user@domain.com
$ xac session init -f german-keras.yaml -n german_credit
$ xac job submit -s <SESSION_ID> -e local_attributions -e global_importances --start 4 --end 5
$ xac job output <JOB_ID> -o /tmp/explns.json
Commands:
config Generate Xaipient YAML config files for customization
info Display key information about API
job Manage and Generate Explanations with Xaipient API
jobs List explanation jobs.
login Login with email and password.
logout Logout and purge any tokens.
session Manage and Create Sessions for Explanations
sessions List all created sessions.
version Display current version of client and API.
See Documentation for more details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
xac-0.3.0.tar.gz
(35.0 kB
view details)
Built Distribution
xac-0.3.0-py3-none-any.whl
(43.1 kB
view details)
File details
Details for the file xac-0.3.0.tar.gz
.
File metadata
- Download URL: xac-0.3.0.tar.gz
- Upload date:
- Size: 35.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.10 CPython/3.7.9 Darwin/20.1.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28177eed228ee5ef262b41c9b32f2e1d0b29e58b3f9f46ebaa0953f00eed5024 |
|
MD5 | 69ed88da7cbf73f4fa798717439883eb |
|
BLAKE2b-256 | 7d0cc8ea4f772c43a46f4faff9db86cee1b16d87cc76e84420e8bb10d2378f06 |
File details
Details for the file xac-0.3.0-py3-none-any.whl
.
File metadata
- Download URL: xac-0.3.0-py3-none-any.whl
- Upload date:
- Size: 43.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.0.10 CPython/3.7.9 Darwin/20.1.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5ad74491889ae545a9447c6ff7b9ceddf72db3a9eed311ba0f4e88b13b1a1db |
|
MD5 | bbf8b1dcac76752279e972d026aa13d8 |
|
BLAKE2b-256 | e7d17433243651bb55cc857a4cad114bc4623a59314f5cbc18fc041930256403 |