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

docs(models): Docathon #202

Merged
merged 22 commits into from
Mar 25, 2025
Merged

docs(models): Docathon #202

merged 22 commits into from
Mar 25, 2025

Conversation

jakob-schloer
Copy link
Collaborator

@jakob-schloer jakob-schloer commented Mar 19, 2025

Update anemoi-models documentation.

What I've done:

  • Move files and content to match our template from anemoi-graphs
  • Add reciepe to create model from config

ToDo:

  • Recipe to build a custom model
  • Fix docstrings for classes in anemoi.models.preprocessing.imputer
  • Some of the modules do not have yet a short description.

Remark:
Please feel free to change whatever you want. I'm not attached to any of my changes :)


📚 Documentation preview 📚: https://anemoi-training--202.org.readthedocs.build/en/202/


📚 Documentation preview 📚: https://anemoi-graphs--202.org.readthedocs.build/en/202/


📚 Documentation preview 📚: https://anemoi-models--202.org.readthedocs.build/en/202/

@JPXKQX
Copy link
Member

JPXKQX commented Mar 19, 2025

I think we agreed on the following names:

  • Recipe example -> User Guide
  • Modules -> API Reference

@paulaharder
Copy link

I tested all the steps and overall it looks great to me : ) I left some minor comments. Let me know if I should just apply some of the changes myself

@jakob-schloer
Copy link
Collaborator Author

I tested all the steps and overall it looks great to me : ) I left some minor comments. Let me know if I should just apply some of the changes myself

Thank you! I've tried to include your comments.

@jakob-schloer jakob-schloer requested a review from HCookie March 21, 2025 09:22
@HCookie
Copy link
Member

HCookie commented Mar 21, 2025

@b8raoult Can you update the logo here?

paulaharder
paulaharder previously approved these changes Mar 21, 2025
Copy link

@paulaharder paulaharder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Magnus-SI and others added 2 commits March 24, 2025 11:04
# Adds temporal interpolation functionality to anemoi

A forecaster with longer time steps might yield better predictions going days out than a 1 hour forecaster, as it has to make fewer auto-regressive steps. To produce the hourly predictions still, we can use the information available from a longer time-stepping forecaster, e.g. hours 12 and 18 as input to predict hours 13-17. These predictions can be made individually, assisted by some information about the target time as input.

Preliminary results indicate that this approach works well when combining a 6 hour forecaster and hourly interpolator during inference. Additionally, when hourly analysis is not available, there does not seem to be a major loss in training the interpolator as an emulator on nwp model runs, as long as it is combined with a forecasting model trained on analysis during inference.

---------------------------------------------------------------------------------------------------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Harrison Cook <[email protected]>
@HCookie HCookie merged commit 5dba9d3 into main Mar 25, 2025
29 checks passed
@HCookie HCookie deleted the Docathon-Models branch March 25, 2025 16:08
@github-project-automation github-project-automation bot moved this from Now In Progress to Done in Anemoi-dev Mar 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

7 participants