Skip to content

trustyai-explainability/trustyai-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TrustyAI SDK

Ruff Tests

A Python SDK for TrustyAI, providing tools for explaining, evaluating, and enhancing AI models.

Installation

Standard Installation

Install the package with core functionality and CLI:

pip install .

After installation, you can use both the Python API and CLI:

trustyai --help
trustyai info
trustyai model list
trustyai eval list-providers

Full Installation

To install everything including evaluation support:

pip install .[all]

This includes all core, CLI, and evaluation dependencies.

Additional Optional Dependencies

Evaluation Support

For model evaluation capabilities:

pip install .[eval]

Development Dependencies

For development, testing, and linting:

pip install .[dev]

Usage

Python API

import numpy as np
from trustyai.core.model import TrustyModel
from trustyai.core.providers import ProviderRegistry

# Create a trusty model
model = TrustyModel(name="MyModel")

# Get explanations
X = np.random.rand(10, 5)
explanations = model.explain(X)
print(explanations)

Command Line Interface

The CLI is available by default after installation:

# Display help
trustyai --help

# Show version information
trustyai --version

# Show general information
trustyai info

# List available models
trustyai model list

# List evaluation providers
trustyai eval list-providers

Development

This project uses:

  • pytest for testing
  • Ruff for linting and formatting
  • mypy for type checking
# Install development dependencies
pip install .[dev]

# Run tests
make test

# Run linting
make lint

# Format code
make format

License

Apache License 2.0

About

The TrustyAI SDK

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages