Documentation

[nicholas-leonard]

Each function should be documented in the README, instead of just inline. There should also be a link for each optimization function to the original paper.

[scabi]

Made some small progress on documentation. Let me know what you think and what is missing.

[nicholas-leonard]

@scabi That looks awesome! Wouldn't call it small.

[scabi]

Thanks! It was mostly copy paste from the code though. Any more ideas to improve the documentation? I am willing to help in the next few months.

[nicholas-leonard]

@scabi The next thing would be more examples. You could add an examples/ folder and put some concrete examples in there.

[scabi]

I think some iTorch notebooks would be the best option for examples. Torch roadmap document says "Tutorials: provide guidelines and basic framework/standard to write and publish tutorials?" Is there any progress on this?

[nicholas-leonard]

Nope. Which means you can pretty much do it as you want, subject to the constraint that your PR gets merged XD

[scabi]

Got it. I'll look into it.