Repository navigation
Conversation
…cs into rework/guides-overview
| - [Launch many jobs using SLURM job arrays](examples/good_practices/slurm_job_arrays/index.md) | ||
| - [Advanced Examples](examples/advanced/index.md) | ||
| - [Multi-Node / Multi-GPU ImageNet Training](examples/advanced/imagenet/index.md) | ||
| - [Track Experiments with Weights & Biases (WandB)](userguides/wandb.md) |
There was a problem hiding this comment.
Should the Track Experiments with Weights & Biases (WandB) be moved in the Prepare section (or maybe Execute) ? Setting up wandb in your code should be something to do before running jobs to have metrics.
There was a problem hiding this comment.
Hmm... I understand this choice, but am not sure how I feel about it.
It needs steps before (so executively, it is on Execute - Write code), but it is data that are used after (so mentally, it is on Iterate).
Maybe could we add a warning somewhere? (in the beginning of Execute or Prepare)? (Note that Wandb setup is also mentioned in the Minimal Examples -> Good practices)
| - [Manage Python Dependencies with uv](userguides/python_uv.md) | ||
| - [Share data with ACLs](userguides/sharing_data.md) | ||
| - Execute | ||
| - [Minimal Examples](examples/index.md) |
There was a problem hiding this comment.
Should Launch jobs appear before Minimal Examples in the navbar ?
There was a problem hiding this comment.
Regarding this comment, I reworked (commit 97d7a97) a little bit the navigation bar so that it looks like this:
with "Write code" mentioning the Minimal examples and Research project templates.
I think that in the "working process", you write the code before launching it. In our case, we don't have a lot of global advices to write code except in the minimal examples for now (good practices such as checkpointing are in there). Thus, I would mention them before "Launch jobs". But we can obviously discuss it! :)
| - [Minimal Examples](examples/index.md) | ||
| - [Software Setup](examples/frameworks/index.md) | ||
| - [PyTorch Setup](examples/frameworks/pytorch_setup/index.md) | ||
| - [Jax Setup](examples/frameworks/jax_setup/index.md) | ||
| - [Jax](examples/frameworks/jax/index.md) | ||
| - [Flash Attention Setup](examples/frameworks/flash_attn_setup/index.md) | ||
| - [Distributed Training](examples/distributed/index.md) | ||
| - [Single GPU Job](examples/distributed/single_gpu/index.md) | ||
| - [Multi-GPU Job](examples/distributed/multi_gpu/index.md) | ||
| - [Multi-node Job](examples/distributed/multi_node/index.md) | ||
| - [Good Practices](examples/good_practices/index.md) | ||
| - [Checkpointing](examples/good_practices/checkpointing/index.md) | ||
| - [Weights & Biases (wandb) setup](examples/good_practices/wandb_setup/index.md) | ||
| - [Launch many jobs from same shell script](examples/good_practices/launch_many_jobs/index.md) | ||
| - [Hyperparameter Optimization with Orion](examples/good_practices/hpo_with_orion/index.md) | ||
| - [Launch many tasks on the same GPU](examples/good_practices/many_tasks_per_gpu/index.md) | ||
| - [Launch many jobs using SLURM job arrays](examples/good_practices/slurm_job_arrays/index.md) | ||
| - [Advanced Examples](examples/advanced/index.md) | ||
| - [Multi-Node / Multi-GPU ImageNet Training](examples/advanced/imagenet/index.md) |
There was a problem hiding this comment.
Est-ce que les Minimal Examples sont maintenant trop "caché" / pas assez mis en évidence ? Avant ils avaient une section dédiée mais maintenant ils sont tous regroupés en dessous d'un seul élément.
There was a problem hiding this comment.
Bon point ! C'est corrigé dans le commit 97d7a97
| <a class="wf2-step wf2-s3" href="compute_utilization_guidelines/"> | ||
| <!--<span class="wf2-num">06</span>--> | ||
| <span class="wf2-icon"> | ||
| <svg xmlns="http://www.w3.org/2000/svg" height="26" width="26" viewBox="0 0 640 640"><!--!Font Awesome Free v7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2026 Fonticons, Inc.--><path d="M128 128C128 110.3 113.7 96 96 96C78.3 96 64 110.3 64 128L64 464C64 508.2 99.8 544 144 544L544 544C561.7 544 576 529.7 576 512C576 494.3 561.7 480 544 480L144 480C135.2 480 128 472.8 128 464L128 128zM534.6 214.6C547.1 202.1 547.1 181.8 534.6 169.3C522.1 156.8 501.8 156.8 489.3 169.3L384 274.7L326.6 217.4C314.1 204.9 293.8 204.9 281.3 217.4L185.3 313.4C172.8 325.9 172.8 346.2 185.3 358.7C197.8 371.2 218.1 371.2 230.6 358.7L304 285.3L361.4 342.7C373.9 355.2 394.2 355.2 406.7 342.7L534.7 214.7z"/></svg> | ||
| </span> | ||
| <div class="wf2-text"> | ||
| <span class="wf2-title">Monitor</span> | ||
| <span class="wf2-desc">Job status & performance</span> | ||
| </div> | ||
| <span class="wf2-chevron"></span> | ||
| </a> |
There was a problem hiding this comment.
Maybe the Monitor step should redirect to the wandb guide Track Experiments with Weights & Biases (WandB)?
There was a problem hiding this comment.
I updated that. I also moved the subtexts (Metrics & enhancement / Job status & performance). Did you want to switch them?
| <a class="wf2-step wf2-s3" href="wandb/"> | ||
| <!--<span class="wf2-num">07</span>--> | ||
| <span class="wf2-icon"> | ||
| <svg xmlns="http://www.w3.org/2000/svg" height="26" width="26" viewBox="0 0 640 640"><!--!Font Awesome Free v7.3.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2026 Fonticons, Inc.--><path d="M434.8 54.1C446.7 62.7 451.1 78.3 445.7 91.9L367.3 288L512 288C525.5 288 537.5 296.4 542.1 309.1C546.7 321.8 542.8 336 532.5 344.6L244.5 584.6C233.2 594 217.1 594.5 205.2 585.9C193.3 577.3 188.9 561.7 194.3 548.1L272.7 352L128 352C114.5 352 102.5 343.6 97.9 330.9C93.3 318.2 97.2 304 107.5 295.4L395.5 55.4C406.8 46 422.9 45.5 434.8 54.1z"/></svg> | ||
| </span> | ||
| <div class="wf2-text"> | ||
| <span class="wf2-title">Optimize</span> | ||
| <span class="wf2-desc">Metrics & enhancement</span> | ||
| </div> | ||
| <span class="wf2-chevron"></span> | ||
| </a> |
There was a problem hiding this comment.
And the Optimize step could redirect to Compute utilization at Mila ?
Co-authored-by: hvdbm <hugo.vandenbroucke-menu@mila.quebec>
…cs into rework/guides-overview
This branch has not been deployed
2 participants
The idea is to give an "Ariana thread" to the userguide parts.
The "userguides home page" would be something like:
And maybe we would gather the different guides by sections.