Skip to main content

Client for Xaipient Explainability REST API

Project description

xac

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


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 hashes)

Uploaded Source

Built Distribution

xac-0.3.0-py3-none-any.whl (43.1 kB view hashes)

Uploaded Python 3

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