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

[Code Roast] IDT Feedback #77

Open

3 of 4 tasks

lebrice opened this issue Oct 31, 2024 · 4 comments

Collaborator

lebrice commented Oct 31, 2024 •

edited

Loading

This issue is a safe space where you can rant / roast the codebase or the documentation as you wish!

Comments so far:

Beaucoup de trucs, les gens vont juste assumer que le reste fonctionne
Manque de contexte: Who is the target audience?
Add more links to relevant docs
Installation instructions are out of sync between docs and README.md #84
Readme link to Examples is broken (404) #88
[docs] Supervised Example doesn't have any text
Weird [gpu] optional dependency group, why? #89

Collaborator Author

lebrice commented Oct 31, 2024 •

edited

Loading

"Create a new project" section: "Click here" isn't obvious enough, maybe a green button or something? (someone saw it though)

Collaborator Author

lebrice commented Oct 31, 2024

"Installing UV" section: curl-ing some script from the internet can make some people feel uneasy.
- Perhaps we could use brew install uv and uv self update for MacOS instead?

Collaborator Author

lebrice commented Oct 31, 2024 •

edited

Loading

#78 and #79 are making it impossible to run uv run python project/main.py --help

Collaborator Author

lebrice commented Oct 31, 2024

Lots of dependencies. Are these required?
- Perhaps we can have an optional group for each example? (RL, NLP, Jax, etc)
Weird [gpu] optional dependency group, why?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment