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.

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

Hello World Example #69

Open
sadamov opened this issue Aug 19, 2024 · 1 comment
Open

Hello World Example #69

sadamov opened this issue Aug 19, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@sadamov
Copy link
Collaborator

sadamov commented Aug 19, 2024

Description:

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:

  1. Install Neural-LAM with all dependencies using PDM (+ ipykernel)
  2. Data loading and preprocessing (using https://github.com/leifdenby/neural-lam/blob/0a79c74cb1d6bf3e29b999188c0c6e4d9f95078b/tests/datastore_examples/mllam/danra.example.yaml)
  3. Model configuration and HiLAM graph generation with https://github.com/leifdenby/neural-lam/blob/0a79c74cb1d6bf3e29b999188c0c6e4d9f95078b/neural_lam/create_graph.py
  4. Training process (using --flags) on CPU
  5. 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.

@sadamov sadamov added the documentation Improvements or additions to documentation label Aug 19, 2024
@joeloskarsson
Copy link
Collaborator

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 😅

@joeloskarsson joeloskarsson added this to the v0.4.0 milestone Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants