Git Product home page Git Product logo

virny's Introduction

Virny Software Library

CI Pipeline documentation pypi bsd_3_license code_size last_commit

๐Ÿ“œ Description

Virny is a Python library for in-depth profiling of model performance across overall and disparity dimensions. In addition to its metric computation capabilities, the library provides an interactive tool called VirnyView to streamline responsible model selection and generate nutritional labels for ML models. The Virny library was developed based on three fundamental principles:

  1. easy extensibility of model analysis capabilities;

  2. compatibility to user-defined/custom datasets and model types;

  3. simple composition of disparity metrics based on the context of use.

Virny decouples model auditing into several stages, including: subgroup metric computation, disparity metric composition, and metric visualization. This gives data scientists more control and flexibility to use the library for model development and monitoring post-deployment.

For quickstart, look at use case examples, an interactive demo, and a demonstrative Jupyter notebook.

๐Ÿ›  Installation

Virny supports Python 3.8 and 3.9 and can be installed with pip:

pip install virny

๐Ÿ“’ Documentation

๐Ÿ’ก Features

  • Entire pipeline for profiling model accuracy, stability, uncertainty, and fairness
  • Ability to analyze non-binary sensitive attributes and their intersections
  • Compatibility with pre-, in-, and post-processors for fairness enhancement from AIF360
  • Convenient metric computation interfaces: an interface for multiple models, an interface for multiple test sets, and an interface for saving results into a user-defined database
  • An error_analysis computation mode to analyze model stability and confidence for correct and incorrect prodictions broken down by groups
  • Metric static and interactive visualizations
  • Data loaders with subsampling for popular fair-ML benchmark datasets
  • User-friendly parameters input via config yaml files
  • Check out our documentation for a comprehensive overview

๐Ÿ“– Library Overview

Virny_Architecture

The software framework decouples the process of model profiling into several stages, including subgroup metric computation, disparity metric composition, and metric visualization. This separation empowers data scientists with greater control and flexibility in employing the library, both during model development and for post-deployment monitoring. The above figure demonstrates how the library constructs a pipeline for model analysis. Inputs to a user interface are shown in green, pipeline stages are shown in blue, and the output of each stage is shown in purple.

๐Ÿค— Affiliations

NYU-UCU-Logos

๐Ÿ“ License

Virny is free and open-source software licensed under the 3-clause BSD license.

virny's People

Contributors

denysgerasymuk799 avatar dmytro-omelian avatar proc1v avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.