deel-ai / deel-lip

Build and train Lipschitz constrained networks: TensorFlow implementation of k-Lipschitz layers
https://deel-ai.github.io/deel-lip/
MIT License
89 stars 10 forks source link

Getting-started with deel-lip #78

Closed Sharing-Sam-Work closed 4 months ago

Sharing-Sam-Work commented 1 year ago

I have created two new tutorial notebooks specifically tailored for professionals in industrial sectors who want to swiftly grasp the practical applications of the package. These tutorials offer a concise introduction to utilizing the package for producing and training robust 1-Lipschitz deep learning models.

The focus here is on practical implementation rather than delving deeply into theoretical aspects. We provide practical suggestions to enhance user-friendliness and usability, making these tutorials ideal for those aiming for a practical working knowledge of the library and its functionalities, rather than an exhaustive theoretical exploration.

I have tested the changes with: tox -e py310-lint I have also visualized the changes with: mkdocs serve

If the changes are validated, the google collab link will need to be changed in docs/index.md, so that they come from the deel-lip repository as opposed to mine (Sharing-Sam-Work), as in the below: | Getting started 1 - Creating a 1-Lipschitz neural network | Open In Colab |

cofri commented 1 year ago

Thanks @Sharing-Sam-Work for your contribution! Some unit tests are failing but they are fixed in the pending PR #76. When #76 will be merged, just rebase your branch to make unit tests pass.

thib-s commented 1 year ago

Thank you @Sharing-Sam-Work for this great work 👍 In order to fully integrate this work we need to :

My suggestion is to merge this PR in a temporary branch here in this repo so we can take care of this without requiring @Sharing-Sam-Work to do it.

Sharing-Sam-Work commented 1 year ago

I have taken into account the comments.

cofri commented 4 months ago

The two Getting Started notebooks were merged into master. I suggest to close this PR