Skip to content

Commit

Permalink
udpates README
Browse files Browse the repository at this point in the history
  • Loading branch information
billbrod committed Aug 21, 2020
1 parent b706e44 commit ff10712
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# plenoptic

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/LabForComputationalVision/plenoptic/blob/master/LICENSE)
![Python version](https://img.shields.io/badge/python-3.6%7C3.7-blue.svg)
[![Build Status](https://travis-ci.com/LabForComputationalVision/plenoptic.svg?branch=master)](https://travis-ci.com/LabForComputationalVision/plenoptic)
[![Documentation Status](https://readthedocs.org/projects/plenoptic/badge/?version=latest)](https://plenoptic.readthedocs.io/en/latest/?badge=latest)
[![stability-alpha](https://img.shields.io/badge/stability-alpha-f4d03f.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#alpha)

In recent years, [adversarial
examples](https://openai.com/blog/adversarial-example-research/) have
demonstrated how difficult it is to understand how complex models process
Expand Down Expand Up @@ -65,6 +71,11 @@ to the papers describing them):
(where for all of these, "identical (resp. different) representation",
stands for small (resp. large) l2-distance in a model's representation space)

# Status

This project is currently in alpha, under heavy development. Not all features
have been implemented, and there will be breaking changes.

# Roadmap

See the [github
Expand All @@ -73,8 +84,7 @@ for a more detailed roadmap, but at the high level:

- Short term:
1. Finalize Portilla-Simoncelli texture statistics
2. Add MAD competition
3. Create `Synthesis` superclass
2. Recreate existing `MADCompetition` examples.
- Medium term:
1. Finalize geodesics
2. Get eigendistortion and geodesics to use `Synthesis` superclass
Expand Down
9 changes: 9 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
.. |license-shield| image:: https://img.shields.io/badge/license-MIT-yellow.svg
:target: https://github.com/LabForComputationalVision/plenoptic/blob/master/LICENSE

.. |python-version-shield| image:: https://img.shields.io/badge/python-3.6%7C3.7-blue.svg

.. |travis| image:: https://travis-ci.com/LabForComputationalVision/plenoptic.svg?branch=master
:target: https://travis-ci.com/LabForComputationalVision/plenoptic


.. plenoptic documentation master file, created by
sphinx-quickstart on Thu Jun 20 15:56:27 2019.
You can adapt this file completely to your liking, but it should at least
Expand Down

0 comments on commit ff10712

Please sign in to comment.