Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improving Documentation #295

Open
andrewilyas opened this issue Mar 3, 2023 · 2 comments
Open

Improving Documentation #295

andrewilyas opened this issue Mar 3, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@andrewilyas
Copy link
Contributor

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 andrewilyas added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Mar 3, 2023
@numpee
Copy link
Contributor

numpee commented Mar 3, 2023

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

@andrewilyas andrewilyas mentioned this issue Mar 31, 2023
Open
@tavisshore
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@andrewilyas @numpee @tavisshore