Provide more "real-life" example in README - Githubissues

cooper-org / cooper

A general-purpose, deep learning-first library for constrained optimization in PyTorch

https://cooper.readthedocs.io/

MIT License

106 stars 10 forks source link

Provide more "real-life" example in README #60

Closed gallego-posada closed 1 year ago

gallego-posada commented 1 year ago

Enhancement

Modify README to include a more comprehensive example of how to use Cooper for machine learning problems. Some features to cover include:

Integration with torch.nn.Module
Using CUDA acceleration
Data loaders and mini-batching

We could to have two versions:

One with "off-the-shelf Cooper": no explicit user-defined closure
One with explicit closure definition, which enables the use of advanced features like extrapolation optimizers

Maybe only include the first one in the README, and keep the second version for the docs.

gallego-posada commented 1 year ago

Closed by #62