Skip to main content

No project description provided

Project description

DeepBridge

Documentation Status CI PyPI version

DeepBridge is a comprehensive Python library for advanced machine learning model validation, distillation, and performance analysis. It provides powerful tools to manage experiments, validate models, create more efficient model versions, and conduct in-depth performance evaluations.

Installation

You can install DeepBridge using pip:

pip install deepbridge

Or install from source:

git clone https://github.com/DeepBridge-Validation/DeepBridge.git
cd deepbridge
pip install -e .

Key Features

  • Model Validation

    • Experiment tracking and management
    • Comprehensive model performance analysis
    • Advanced metric tracking
    • Model versioning support
  • Model Distillation

    • Knowledge distillation across multiple model types
    • Advanced configuration options
    • Performance optimization
    • Probabilistic model compression
  • Advanced Analytics

    • Detailed performance metrics
    • Distribution analysis
    • Visualization of model performance
    • Precision-recall trade-off analysis

Quick Start

Model Distillation

from deepbridge.model_distiller import ModelDistiller

# Create and train distilled model
distiller = ModelDistiller(model_type="gbm")
distiller.fit(X=features, probas=predictions)

# Make predictions
predictions = distiller.predict(X_new)

Automated Distillation

from deepbridge.auto_distiller import AutoDistiller
from deepbridge.db_data import DBDataset

# Create dataset
dataset = DBDataset(
    data=df,
    target_column='target',
    features=features,
    prob_cols=['prob_class_0', 'prob_class_1']
)

# Run automated distillation
distiller = AutoDistiller(
    dataset=dataset,
    output_dir='results',
    test_size=0.2,
    n_trials=10
)
results = distiller.run(use_probabilities=True)

Command-Line Interface

# Create experiment
deepbridge validation create my_experiment --path ./experiments

# Train distilled model
deepbridge distill train gbm predictions.csv features.csv -s ./models

Requirements

  • Python 3.8+
  • Key Dependencies:
    • numpy
    • pandas
    • scikit-learn
    • xgboost
    • scipy
    • matplotlib

Documentation

Full documentation available at: DeepBridge Documentation

Contributing

We welcome contributions! Please see our contribution guidelines for details on how to submit pull requests, report issues, and contribute to the project.

  1. Fork the repository
  2. Create your feature branch
  3. Commit your changes
  4. Push to the branch
  5. Open a Pull Request

Recent Fixes

  • 2025-05-15: Fixed static report chart URLs to properly use relative paths with ./ prefix for improved portability across different environments

Development Setup

# Clone the repository
git clone https://github.com/DeepBridge-Validation/DeepBridge.git
cd deepbridge

# Create virtual environment
python -m venv venv
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

Running Tests

pytest tests/

License

MIT License

Citation

If you use DeepBridge in your research, please cite:

@software{deepbridge2025,
  title = {DeepBridge: Advanced Model Validation and Distillation Library},
  author = {Gustavo Haase, Paulo Dourado},
  year = {2025},
  url = {https://github.com/DeepBridge-Validation/DeepBridge}
}

Contact

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

deepbridge-0.1.39.tar.gz (909.3 kB view details)

Uploaded Source

Built Distribution

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

deepbridge-0.1.39-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file deepbridge-0.1.39.tar.gz.

File metadata

  • Download URL: deepbridge-0.1.39.tar.gz
  • Upload date:
  • Size: 909.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.5 Linux/5.15.167.4-microsoft-standard-WSL2

File hashes

Hashes for deepbridge-0.1.39.tar.gz
Algorithm Hash digest
SHA256 d6a65e76cd6c18bf76377df24ea5b45812416a047ad34a64407e9996a65aed9b
MD5 a359817414f4bf0e8ff4edb49e62917c
BLAKE2b-256 8a7b7945b24280ca3d8cf73a79a84628d073165725c5c1c0ba9d6475112c1f86

See more details on using hashes here.

File details

Details for the file deepbridge-0.1.39-py3-none-any.whl.

File metadata

  • Download URL: deepbridge-0.1.39-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.5 Linux/5.15.167.4-microsoft-standard-WSL2

File hashes

Hashes for deepbridge-0.1.39-py3-none-any.whl
Algorithm Hash digest
SHA256 e3095585435dc84423f14311a00c70c063498f3cd078be0dba77f04d39c9f49c
MD5 5ce3dfcf515f1a44fe93074ac17f9987
BLAKE2b-256 02292576b1a4eb4506b426663eaf5a40879eab61d7c44fb8ba94844e803b425c

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