Interfaces for defining Robust ML models and precisely specifying the threat models under which they claim to be secure.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 8258cf1 May 3, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
robustml Release 0.0.2 Apr 15, 2018
.editorconfig Add editorconfig Apr 13, 2018
.gitignore Initial commit Apr 4, 2018
LICENSE.txt Add license Apr 14, 2018
README.rst Move to HTTPS May 2, 2018
setup.py Initial commit Apr 4, 2018
test.py Initial commit Apr 4, 2018

README.rst

robust-ml

Interfaces for defining Robust ML models and precisely specifying the threat models under which they claim to be secure. Also includes interfaces for specifying attacks and evaluating attacks against models.

The motivation behind this project is to make it easy to make specific, testable claims about the robustness about machine learning models. Read more in the FAQ.

Installation

You can install from PyPI: pip install robustml.

Usage

See this repository for a complete example of implenenting a model, implementing an attack, and evaluating the attack against the model.

If you're implementing a defense, you should implement robustml.model.Model. See here for an example.

If you're implementing an attack against a specific defense, you should implement robustml.attack.Attack. See here for an example.

To evaluate a specific attack against a specific defense, use robustml.evaluate.evaluate(). See here for an example.

Contributing

Do you have ideas on how to improve the robustml package? Have a feature request (such as a specification of a new threat model) or bug report? Great! Please open an issue or submit a pull request.

Before contributing a major change, it's recommended that you open a pull request first and get feedback on the idea before investing time in the implementation.

Packaging

  1. Update version information.
  2. Build the package using python setup.py sdist bdist_wheel.
  3. Sign and upload the package using twine upload -s dist/*.
  4. Create a signed tag in the git repo with the version number that was uploaded to PyPI.