[Code Roast] IDT Feedback

[lebrice]

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

[lebrice]

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

[lebrice]

• "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?

[lebrice]

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

[lebrice]

• 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?

[semihcanturk]

• 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?

I think it would be nice to disentangle the dependencies of the template from those of the example projects. Several straightforward reasons:

• I don't like the idea of the template automatically installing packages that only pertain to the examples and I will never use in the project (e.g. I don't use Jax, but even if I toggle off the Jax-related examples the uvx copier command will install Jax in my venv regardless), leading to bloated venvs.
• Our own project dependencies etc. may require different versions/combinations of these pre-installed packages.
• The current dependencies make it impossible to use this template locally on a macOS system because the venv creation fails due to incompatibilities wrt Jax & macOS (I believe because jax-cuda12-plugin is listed as a dependency, the wheels for which of course isn't available on macOS). I understand that this template is mostly intended to be used on the Mila cluster, but I'm just stating it here to demonstrate that installing these example-project-related packages may have some unintended consequences.

Having optional groups for dependencies is an excellent idea, but there also needs to be a 'minimal dependency' option where none of the packages associated only with the examples are installed automatically.