Skip to main content

Testing for models confirming to the scikit-learn api

Project description

ML Testing

The goal of this module is to create a flexible and easy to use module for testing machine learning models, specifically those in scikit-learn.

The tests will be readable enough that anyone can extend them to other frameworks and APIs with the major notions kept the same, but more or less the ideas will be extended, no work will be taken in this library to extend passed the scikit-learn API.

You can read the docs for a more detailed explaination.

A video explaining the idea behind the framework

Documentation Status CircleCI Version Number Downloads Per Month codecov

Tests Covered

  • Testing Against Metrics
    • Classification Tests
      • Rule Based Testing:
        • precision lower boundary
        • recall lower boundary
        • f1 score lower boundary
        • AUC lower boundary
        • precision lower boundary per class
        • recall lower boundary per class
        • f1 score lower boundary per class
        • AUC lower boundary per class
      • Decision Based Testing:
        • precision fold below average
        • recall fold below average
        • f1 fold below average
        • AUC fold below average
        • precision fold below average per class
        • recall fold below average per class
        • f1 fold below average per class
        • AUC fold below average per class
      • Against New Predictions
        • proportion of predictions per class
        • class imbalance tests
        • probability distribution similarity tests
        • calibration tests
      • environmental impact tests
    • Regression Tests
      • Rule Based Testing:
        • Mean Squared Error upper boundary
        • Median Absolute Error upper boundary
      • Decision Based Testing:
        • Mean Squared Error fold above average
        • Median Absolute Error fold above average
  • Testing Against Run Time Performance
    • prediction run time for simulated samples of size X
  • Testing Against Input Data
  • Memoryful Tests
    • cluster testing - this is about the overall structure of the data If the number of clusters increases or decreases substantially that should be an indicator that the data has changed enough that things should possibly be rerun
    • correlation testing - this is about ensuring that the correlation for a given column with previous data collected in the past does not change very much. If the data does change then the model should possibly be rerun.
    • shape testing - this is about ensuring the general shape of for the given column does not change much over time. The idea here is the same as the correlation tests.

Possible Issues

Some known issues with this, any machine learning tests are going to require human interaction because of type 1 and type 2 error for statistical tests. Additionally, one simply needs to interrogate models from a lot of angles. It can't be from just one angle. So please use with care!

Future Features

References

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

drifter_ml-0.26.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

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

drifter_ml-0.26-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

Details for the file drifter_ml-0.26.tar.gz.

File metadata

  • Download URL: drifter_ml-0.26.tar.gz
  • Upload date:
  • Size: 22.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for drifter_ml-0.26.tar.gz
Algorithm Hash digest
SHA256 e1b36a13425b5dd50c2cfa5b1c5beeea0f3e3392d2c8d4e0d9928202fa1702f1
MD5 831cb7d04a5af42ff55616cb4ead91ec
BLAKE2b-256 77733d79106c0a41ca2557748328f7d11989cc2c1e8173790da7691f7c019d86

See more details on using hashes here.

File details

Details for the file drifter_ml-0.26-py3-none-any.whl.

File metadata

  • Download URL: drifter_ml-0.26-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for drifter_ml-0.26-py3-none-any.whl
Algorithm Hash digest
SHA256 d82b7d13cd225bebb946a0b72366a9f9cefd9464a71f71ffe03b2a3e730f0af5
MD5 b339fc206fd9becfecb50fa4d03517f8
BLAKE2b-256 8432b71438fcffb7ca9e1328b1a56ed9068c72b6d8f9d8ca527a3758b2809e39

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