Metadata-Version: 2.2
Name: equine_webapp
Version: 0.1.dev81
Summary: Companion web application for EQUINE^2: Establishing Quantified Uncertainty for Neural Networks
Author: Allan Wollaber, Steven Jorgensen, Harry Li
Maintainer: Allan Wollaber, Steven Jorgensen, Harry Li
License: MIT
Project-URL: Homepage, https://mit-ll-responsible-ai.github.io/equine-webapp/
Project-URL: Bug Tracker, https://github.com/mit-ll-responsible-ai/equine-webapp/issues
Project-URL: Source, https://github.com/mit-ll-responsible-ai/equine-webapp
Keywords: machine learning,robustness,pytorch,responsible,AI
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: ariadne
Requires-Dist: equine>=0.1.5
Requires-Dist: flask
Requires-Dist: flask-cors
Requires-Dist: numpy
Requires-Dist: scikit-learn
Requires-Dist: torch
Requires-Dist: torchvision
Requires-Dist: umap-learn
Requires-Dist: waitress
Requires-Dist: zadu==0.1.1
Provides-Extra: tests
Requires-Dist: pytest>=3.8; extra == "tests"
Requires-Dist: hypothesis<6.113.0,>=6.105.0; extra == "tests"
Requires-Dist: pre-commit>=2.19; extra == "tests"
Requires-Dist: codespell; extra == "tests"
Provides-Extra: docs
Requires-Dist: mkdocs>=1.3; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocstrings-python; extra == "docs"
Requires-Dist: mkdocs-jupyter; extra == "docs"
Requires-Dist: mkdocs-literate-nav; extra == "docs"
Requires-Dist: mkdocs-gen-files; extra == "docs"
Requires-Dist: mkdocs-section-index; extra == "docs"

# EQUINE Webapp

<p align="center">
  <img width="500" src="client/public/EQUI(NE)^2_Full_Logo.svg">
</p>

![TypeScript](https://badgen.net/badge/-/TypeScript/blue?icon=typescript&label)
<p align="center">
  This is a web application utilizing EQUINE for neural network uncertainty quantification through a visual user interface. The webapp allows you to upload your own model and data, and let the server retrain the model with EQUINE. The visualization dashboard also allows you to analyze your samples and view uncertainty quantification visualizations to explain model uncertainty.
</p>

<p align="center">
  The EQUINE repository is here https://github.com/mit-ll-responsible-ai/equine
</p>

## ScatterUQ at IEEE VIS 2023
We presented ScatterUQ at IEEE VIS 2023: https://ieeexplore.ieee.org/document/10360884

Our data and analysis script can be found in this release: https://github.com/mit-ll-responsible-ai/equine-webapp/releases/tag/ScatterUQ-VIS-2023-Data

## React Frontend

### ScatterUQ Static Demo
We deployed the frontend application to GitHub pages. You can view a static demo of ScatterUQ here:

https://mit-ll-responsible-ai.github.io/equine-webapp/demo

[![ScatterUQ Out of Distribution Example](client/public/ood.png)](https://mit-ll-responsible-ai.github.io/equine-webapp/demo)

### Development Frontend Server Setup
1. Install node packages
```
cd client
npm i
```

2. Start the development server
```
npm run dev
```


## Python Flask Server

### Development Flask Server Setup
1. Create a new Anaconda environment
```
conda create --name equine-webapp python=3.10
```

2. Activate your new environment
```
conda activate equine-webapp
```

3. Install the necessary packages from pip
```
pip install -r requirements.txt
```

4. Start the Flask server
```
python start_dev_server.py
```

### Flask Testing
If you'd like to run our flask tests:
1. Install pytest
```
pip install pytest
```

2. Run pytest
```
python -m pytest
```

## Bibliography

```
@INPROCEEDINGS{10360884,
  author={Li, Harry X. and Jorgensen, Steven and Holodnak, John and Wollaber, Allan B.},
  booktitle={2023 IEEE Visualization and Visual Analytics (VIS)}, 
  title={ScatterUQ: Interactive Uncertainty Visualizations for Multiclass Deep Learning Problems}, 
  year={2023},
  volume={},
  number={},
  pages={246-250},
  keywords={Deep learning;Dimensionality reduction;Training;Uncertainty;Visual analytics;Soft sensors;Interactive systems;Uncertainty quantification;Machine learning;Dimensionality reduction;Visualization;Explainable AI},
  doi={10.1109/VIS54172.2023.00058}}
```

## Disclaimer

DISTRIBUTION STATEMENT A. Approved for public release. Distribution is unlimited.

© 2023 MASSACHUSETTS INSTITUTE OF TECHNOLOGY

- Subject to FAR 52.227-11 – Patent Rights – Ownership by the Contractor (May 2014)
- SPDX-License-Identifier: MIT

This material is based upon work supported by the Under Secretary of Defense for Research and Engineering under Air Force Contract No. FA8702-15-D-0001. Any opinions, findings, conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the Under Secretary of Defense for Research and Engineering.

The software/firmware is provided to you on an As-Is basis.
