Skip to main content

A Python package for easy analysis of tabular data for inference models, focusing on model-agnostic diagnostics using predictions.

Project description

tab-right

PyPI - Python Version version License OS OS OS Tests Code Checks codecov Ruff Last Commit

Overview

tab-right is a Python package designed to simplify the analysis of tabular data for inference models—both machine learning and non-ML. The core philosophy is that most analyses, such as segmentation strength, drift analysis, and feature predictive value, can be performed using model predictions alone, without direct access to the model itself. This approach enables powerful, model-agnostic diagnostics and interpretability, making the package easy to implement and use.

Key Features

  • Segmentation Analysis: Analyze prediction strength across different data segments to uncover model biases and subgroup performance
  • Feature Analysis: Assess feature predictive power and value to inference, using techniques like feature importance, partial dependence, and more
  • Drift Detection: Perform drift analysis and monitor changes in data or prediction distributions over time
  • Rich Visualizations: Generate comprehensive visualization reports for all analyses, supporting both interactive and static outputs
  • Model-Agnostic: Focus on data and predictions, not model internals, for maximum flexibility and simplicity

Installation

# Install from PyPI
pip install tab-right

# For development version
pip install git+https://github.com/DanielAvdar/tab-right.git

Quick Start

Here's a simple example to get you started with tab-right:

import pandas as pd
import numpy as np
from tab_right.segmentations import calc_seg

# Load your data
data = pd.DataFrame({
    'feature_1': np.random.normal(0, 1, 1000),
    'feature_2': np.random.normal(0, 1, 1000),
    'predictions': np.random.uniform(0, 1, 1000)
})

# Perform segmentation analysis
segments = calc_seg(
    df=data,
    target_col='predictions',
    max_depth=3
)

# Print segmentation results
print(segments)

Documentation

For detailed documentation and examples, visit our documentation site.

The documentation includes:

  • Comprehensive API reference
  • In-depth tutorials
  • Example notebooks
  • Best practices guide

Use Cases

  • Model Evaluation: Compare model performance across different data segments
  • Model Monitoring: Track model drift and data distribution changes over time
  • Feature Engineering: Identify which features contribute most to predictions
  • Bias Detection: Uncover potential biases in model predictions across subgroups

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

See CONTRIBUTING.md for contribution guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Citation

If you use tab-right in a research paper, please cite it as:

@software{tab-right,
  author = {Avdar, Daniel},
  title = {tab-right: Model-Agnostic Analysis for Tabular Data},
  year = {2023},
  url = {https://github.com/DanielAvdar/tab-right}
}

Support

For questions, issues, or feature requests, please use the GitHub issue tracker.

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

tab_right-0.0.2b0.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tab_right-0.0.2b0-py3-none-any.whl (33.6 kB view details)

Uploaded Python 3

File details

Details for the file tab_right-0.0.2b0.tar.gz.

File metadata

  • Download URL: tab_right-0.0.2b0.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.3

File hashes

Hashes for tab_right-0.0.2b0.tar.gz
Algorithm Hash digest
SHA256 f35c09f6fd95a5dfa3670ce1b592ca1de4e4c218cb75d50303e180788651af76
MD5 0d2f87aa693e444c22bb06f6c3eb7f6f
BLAKE2b-256 0c8bba091c0f58bc833136fc6634240890b54e9761e708dc95669a29697754d3

See more details on using hashes here.

File details

Details for the file tab_right-0.0.2b0-py3-none-any.whl.

File metadata

File hashes

Hashes for tab_right-0.0.2b0-py3-none-any.whl
Algorithm Hash digest
SHA256 fba0294d355ba8402b14dd4d99b6eeeba6b34ebc39de529f7c53470b1813e21a
MD5 de868095e9f98bcbb3f087c3de2eaa13
BLAKE2b-256 051dc2d5232a52bbee4931e7fe52fe23674e60f234b043e610c1127cfcb4da25

See more details on using hashes here.

Supported by

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