ffcv icon indicating copy to clipboard operation
ffcv copied to clipboard

Published 20 hours ago • verified publisher icon libffcv

Improving Documentation

Open andrewilyas opened this issue 1 year ago • 2 comments

Putting this issue here for general documentation improvements. Will add to this issue as more things come up and cross things out as they get done, but pull requests are (very) welcome!

  • More examples of FFCV for different applications;
  • FFCV v1.0 now has a much more powerful Pipeline system that allows for applications like contrastive learning out-of-the-box, but these features are currently undocumented;
  • More robust installation instructions would be helpful, as well as a troubleshooting guide

andrewilyas avatar Mar 03 '23 00:03 andrewilyas

Willing to contribute (examples and perhaps installation?), but I have a lot of things going on rn so will need a few weeks to start working

numpee avatar Mar 03 '23 19:03 numpee

My current research largely uses contrastive learning, I'll happily contribute to documentation as I mainly use FFCVs now

tavisshore avatar May 17 '23 14:05 tavisshore