You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We should add a HelloWorld.ipynb notebook in the docs folder to provide a step-by-step guide for users to run a full model training using DANRA data. This will improve onboarding and showcase the capabilities of neural-lam.
Proposed notebook contents:
Install Neural-LAM with all dependencies using PDM (+ ipykernel)
Evaluation and visualization using built in maps and charts + wandb
Additional considerations:
Use a small subset of DANRA data for quick execution
Include explanations for each step
Highlight key parameters and their effects
Provide tips for scaling to larger datasets
This addition will significantly enhance the user experience and make it easier for new contributors to get started with neural-lam. Especially now that we offer multiple datastores and the README might become slightly more complex.
The text was updated successfully, but these errors were encountered:
I agree that this would be great! While we could make it as a notebook, I also think such a "getting started guide" should be part of #61. More reason to put some effort into a proper documentation setup 😅
Description:
We should add a
HelloWorld.ipynb
notebook in thedocs
folder to provide a step-by-step guide for users to run a full model training using DANRA data. This will improve onboarding and showcase the capabilities of neural-lam.Proposed notebook contents:
--flags
) on CPUAdditional considerations:
This addition will significantly enhance the user experience and make it easier for new contributors to get started with neural-lam. Especially now that we offer multiple datastores and the README might become slightly more complex.
The text was updated successfully, but these errors were encountered: