Updated version, badge info (#1)

First github actions are working (building and testing), and github-pages are enabled.

.github/workflows/Tests.yml

@@ -24,6 +24,8 @@ jobs:
       uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
+        cache: 'pip' # caching pip dependencies 
+        cache-dependency-path: 'setup.py'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

README.md

@@ -1,9 +1,10 @@
 # Establishing Quantified Uncertainty in Neural Networks 
 <p align="center"><img src="assets/equine_full_logo.svg" width="720"\></p>
 
-[![Build Status](https://github.com/mit-ll-responsible-ai/equine/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/mit-ll-responsible-ai/equine/actions/workflows/python-package.yml)
+
+[![Build Status](https://github.com/mit-ll-responsible-ai/equine/actions/workflows/Tests.yml/badge.svg?branch=main)](https://github.com/mit-ll-responsible-ai/equine/actions/workflows/Tests.yml)
 ![python_passing_tests](https://img.shields.io/badge/Tests%20Passed-100%25-green)
-![python_coverage](https://img.shields.io/badge/Coverage-91%25-green)
+![python_coverage](https://img.shields.io/badge/Coverage-90%25-green)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Tested with Hypothesis](https://img.shields.io/badge/hypothesis-tested-brightgreen.svg)](https://hypothesis.readthedocs.io/)
 
@@ -19,7 +20,7 @@ EQUINE was created to simplify two kinds of uncertainty quantification for super
 2) An in-distribution score, indicating whether any of the model's known labels should be trusted.
 
 Dive into our [documentation examples](https://mit-ll-responsible-ai.github.io/equine/)
-to get started. Additionally, we provide a companion web application (tbd).
+to get started. Additionally, we provide a [companion web application](https://mit-ll-responsible-ai.github.io/equine-webapp/).
 
 ## Installation
 Users are recommended to install a virtual environment such as Anaconda, as is also recommended

docs/index.md

@@ -1,7 +1,7 @@
 # Establishing Quantified Uncertainty in Neural Networks 
 <p align="center"><img src="assets/equine_full_logo.svg" width="720"\></p>
 
-[![Build Status](https://github.com/mit-ll-responsible-ai/equine/workflows/Tests/badge.svg)](https://github.com/mit-ll-responsible-ai/equine/actions?query=workflow%3ATests+branch%3Amain)
+[![Build Status](https://github.com/mit-ll-responsible-ai/equine/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/mit-ll-responsible-ai/equine/actions/workflows/Tests.yml)
 ![python_passing_tests](https://img.shields.io/badge/Tests%20Passed-100%25-green)
 ![python_coverage](https://img.shields.io/badge/Coverage-91%25-green)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
@@ -17,9 +17,7 @@ test data belongs to any known labels.
 EQUINE was created to simplify two kinds of uncertainty quantification for supervised labeling problems:
 1) Calibrated probabilities for each predicted label
 2) An in-distribution score, indicating whether any of the model's known labels should be trusted.
-
-Dive into our [documentation examples](https://mit-ll-responsible-ai.github.io/equine/)
-to get started. Additionally, we provide a companion web application (tbd).
+Additionally, we provide a [companion web application](https://github.com/mit-ll-responsible-ai/equine-webapp).
 
 ## Installation
 Users are recommended to install a virtual environment such as Anaconda, as is also recommended

pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "equine"
+dynamic = ["version"]
+authors = [
+    { name = "Allan Wollaber"},
+    { name = "Steven Jorgensen"},
+    { name = "John Holodnak" },
+    { name = "Jensen Dempsey" },
+    { name = "Harry Li" },
+]
+description = "EQUINE^2: Establishing Quantified Uncertainty for Neural Networks"
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+        "torch >= 1.10.0",
+        "torchmetrics >= 0.6.0",
+        "numpy",
+        "tqdm",
+        "typeguard<3.0",
+        "icontract",
+        "scikit-learn",  # TODO: remove dependency on train_test_split
+        "scipy",         # TODO: remove dependency on gaussian_kde
+] 
+license = { file = "LICENSE.md" }
+keywords = ["machine learning", "robustness", "pytorch", "responsible", "AI"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering",
+    "Programming Language :: Python :: 3 :: Only",
+]
+
+[project.optional-dependencies]
+tests = [
+    "pytest >= 3.8",
+    "hypothesis >= 6.41.0, < 6.49.0",
+    "pre-commit >= 2.19",
+]
+
+docs = [
+    "mkdocs>=1.3",
+    "mkdocs-material",
+    "mkdocstrings-python",
+    "mkdocs-jupyter",
+    "mkdocs-literate-nav",
+    "mkdocs-gen-files",
+    "mkdocs-section-index",
+]
+
+[project.urls]
+"Homepage" = "https://mit-ll-responsible-ai.github.io/equine/"
+"Bug Tracker" = "https://github.com/mit-ll-responsible-ai/equine/issues"
+"Source" = "https://github.com/mit-ll-responsible-ai/equine"
+
+[tool.setuptools.dynamic]
+version = {attr = "equine.__version__"}

setup.cfg

@@ -2,14 +2,6 @@
 python_files=test_*.py
 testpaths=tests
 
-# Remove the following [versioneer] block if your project is not using versioneer.
-# [versioneer]
-# VCS = git
-# style = pep440
-# versionfile_source = src/equine/_version.py
-# versionfile_build = equine/_version.py
-# tag_prefix = v
-
 [tox:tox]
 envlist = py39, coverage, bandit, owasp-depcheck
 toxworkdir = build/tox

src/equine/__init__.py

@@ -13,7 +13,7 @@
     generate_support,
 )
 
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 
 __all__ = [
     "Equine",