Skip to content

EpiSci/SafeAI

Repository files navigation

SafeAI: Predictive Uncertainty DL Models

EpiSci CircleCI Maintainability Test Coverage
python tensorflow PyPI version shields.io GitHub

Reusable, easy-to-use tensorflow uncertainty module package.
Under active development.

Predictive Uncertainty in Deep Learning Models:

Considering deep learning workflow, uncertainty plays a critical role when applying in real applications and is essential property in a safety issue. Autonomous driving, robotics, or critical decision-making, for instance, such domains are especially caring for safety which is uncertainty in deep learning.

Recently, plenty of researches related to uncertainty is actively ongoing. In this project, we leverage TensorFlow to additionally model uncertainty in standard deep learning architectures. Essentially, we focus on reusability and easy-to-use that only least numbers of parameters are necessary to run target functions.

Installation

# Install using pip
$ pip install safeai

# Or, install from source:
$ git clone https://github.com/EpiSci/SafeAI &&\
$ cd SafeAI && pip install -e .

Tensorflow, Python version

Currently, SafeAI is being developed and tested with tensorflow version 1.10, under both python version 3.6 and 2.7.

SafeAI models

SafeAI models are implemented -- [introducing overall concept of our code.]

import tensorflow as tf
from safeai.models import confident_classifier

MESSAGE = "And Short, intuitive sample code goes here"

Run other examples & test code

Every python code in SafeAI was not meant to be directly run as a single script. Please have them executed as a module, with -m flag for testing and running the examples in the project.
Also they need to be run from project root folder, not at examples/ directory, nor safeai/tests/.

# Clone project, cd into project, install dependencies
$ git clone https://github.com/EpiSci/SafeAI &&\
$ cd SafeAI && pip install -e .

# To run the example:
$ python -m examples.[script name without '.py'] # e.g.) python -m examples.joint_confident

# To execute all tests
$ python -m unittest discover

List of predictive uncertainty models available:

Contribute to project:

We appreciate your interest in this project!
Before making an issue, please consider reading Our contribution guideline.

About

Reusable, Easy-to-use Uncertainty module package built with Tensorflow, Keras

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages