Skip to main content
Library Banner


👋 Welcome to deel-lip documentation!

Controlling the Lipschitz constant of a layer or a whole neural network has many applications ranging from adversarial robustness to Wasserstein distance estimation.

This library provides an efficient implementation of k-Lispchitz layers for keras.

📚 Table of contents

🚀 Quick Start

You can install deel-lip directly from pypi:

pip install deel-lip

In order to use deel-lip, you also need a valid tensorflow installation. deel-lip supports tensorflow versions 2.x.

🔥 Tutorials

Tutorial Name Notebook
Getting Started 1 - Creating a 1-Lipschitz neural network Open In Colab
Wasserstein distance estimation on toy example Open In Colab
HKR Classifier on toy dataset Open In Colab
HKR classifier on MNIST dataset Open In Colab
HKR multiclass and fooling Open In Colab

📦 What's Included

  • k-Lipschitz variant of keras layers such as Dense, Conv2D and Pooling,
  • activation functions compatible with keras,
  • kernel initializers and kernel constraints for keras,
  • loss functions that make use of Lipschitz constrained networks (see our paper for more information),
  • tools to monitor the singular values of kernels during training,
  • tools to convert k-Lipschitz network to regular network for faster inference.

👍 Contributing

To contribute, you can open an issue, or fork this repository and then submit changes through a pull-request. We use black to format the code and follow PEP-8 convention. To check that your code will pass the lint-checks, you can run:

tox -e py36-lint

You need tox in order to run this. You can install it via pip:

pip install tox

👀 See Also

More from the DEEL project:

  • Xplique a Python library exclusively dedicated to explaining neural networks.
  • Influenciae Python toolkit dedicated to computing influence values for the discovery of potentially problematic samples in a dataset.
  • deel-torchlip a Python library for training k-Lipschitz neural networks on PyTorch.
  • DEEL White paper a summary of the DEEL team on the challenges of certifiable AI and the role of data quality, representativity and explainability for this purpose.

🙏 Acknowledgments

DEEL Logo
This project received funding from the French ”Investing for the Future – PIA3” program within the Artificial and Natural Intelligence Toulouse Institute (ANITI). The authors gratefully acknowledge the support of the DEEL project.

🗞️ Citation

This library has been built to support the work presented in the paper Achieving robustness in classification using optimaltransport with Hinge regularization which aim provable and efficient robustness by design.

This work can be cited as:

@misc{2006.06520,
    Author = {Mathieu Serrurier and Franck Mamalet and Alberto González-Sanz and Thibaut Boissin and Jean-Michel Loubes and Eustasio del Barrio},
    Title = {Achieving robustness in classification using optimal transport with hinge regularization},
    Year = {2020},
    Eprint = {arXiv:2006.06520},
}

📝 License

The package is released under MIT license.

Metadata

Release files for deel-lip 1.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for deel-lip 1.5.0
File Size Uploaded Provenance Actions
deel-lip-1.5.0.tar.gz 60.3 kB Without provenance Details for deel-lip-1.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for deel-lip 1.5.0
File Interpreter ABI Platform Actions
deel_lip-1.5.0-py3-none-any.whl Python 3 none any Details for deel_lip-1.5.0-py3-none-any.whl

Total release size: 111.5 kB

Release files / deel-lip-1.5.0.tar.gz

Download URL deel-lip-1.5.0.tar.gz
Size 60.3 kB
Tags Source
SHA-256 checksum
How to use checksums
a3db6e32a7eac23db1e53f6e5cf8ce5cd65a44735909c28264f6fa2cda56b2bb
BLAKE2b-256 checksum
How to use checksums
16fc21562986f2877384b0c2c2162723e486ce7966d700aaa3264984bca9c7c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.12.0

Release files / deel_lip-1.5.0-py3-none-any.whl

Download URL deel_lip-1.5.0-py3-none-any.whl
Size 51.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fe245221a238e21fd11048040684236c3ed3b566dbc2f9eb9506dcc87c091609
BLAKE2b-256 checksum
How to use checksums
c18f64a899ead49d4b7119c595348326eb294c57d12a84fef01b080eefcc3ab0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.12.0

Security for deel-lip 1.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page