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: fix documentation to refer to anemoi datasets instead of zarr datasets #154

Conversation

floriankrb
Copy link
Member

@floriankrb floriankrb commented Feb 27, 2025

Description

Refering to Zarr outside of the anemoi-datasets package breaks the encapsulation principle.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Issue Number

Code Compatibility

  • I have performed a self-review of my code

Code Performance and Testing

  • I have added tests that prove my fix is effective or that my feature works
  • I ran the complete Pytest test suite locally, and they pass
  • I have tested the changes on a single GPU
  • I have tested the changes on multiple GPUs / multi-node setups
  • I have run the Benchmark Profiler against the old version of the code
  • If the new feature introduces modifications at the config level, I have made sure to update Pydantic Schemas and default configs accordingly

Dependencies

  • I have ensured that the code is still pip-installable after the changes and runs
  • I have tested that new dependencies themselves are pip-installable.
  • I have not introduced new dependencies in the inference portion of the pipeline

Documentation

  • My code follows the style guidelines of this project
  • I have updated the documentation and docstrings to reflect the changes
  • I have added comments to my code, particularly in hard-to-understand areas

Additional Notes


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


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


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

@FussyDuck
Copy link

FussyDuck commented Feb 27, 2025

CLA assistant check
All committers have signed the CLA.

@floriankrb floriankrb self-assigned this Feb 27, 2025
@floriankrb floriankrb changed the title doc: fix documentation to refer to anemoi datasets instead of zarr datasets docs: fix documentation to refer to anemoi datasets instead of zarr datasets Feb 27, 2025
@HCookie HCookie requested a review from JPXKQX February 27, 2025 10:47
@JesperDramsch JesperDramsch added the documentation Improvements or additions to documentation label Feb 27, 2025
@JesperDramsch JesperDramsch removed the enhancement New feature or request label Feb 27, 2025
@github-actions github-actions bot added the enhancement New feature or request label Feb 27, 2025
@JPXKQX
Copy link
Member

JPXKQX commented Feb 27, 2025

It may be worth renaming the ZarrDatasetNodes class to AnemoiDatasetNodes in the near future, but this will break all the configs

@anaprietonem
Copy link
Contributor

It may be worth renaming the ZarrDatasetNodes class to AnemoiDatasetNodes in the near future, but this will break all the configs

@JPXKQX so it's that something you'd prefer to wait to fix it because it would be more breaking changes? Cause if so, at least we could have an issue opened to capture that

@JPXKQX
Copy link
Member

JPXKQX commented Feb 27, 2025

It may be worth renaming the ZarrDatasetNodes class to AnemoiDatasetNodes in the near future, but this will break all the configs

@JPXKQX so it's that something you'd prefer to wait to fix it because it would be more breaking changes? Cause if so, at least we could have an issue opened to capture that

I have no preference, but in agreement with Florian PR, I just realised that it is not the correct name. All anemoi datasets are zarr datasets, but not vice versa, and we only support anemoi datasets in this node builder.

@floriankrb
Copy link
Member Author

#155

@floriankrb floriankrb merged commit ad062b2 into main Feb 27, 2025
32 of 33 checks passed
@floriankrb floriankrb deleted the feature/fix-documentation-to-refer-to-anemoi-datasets-instead-of-zarr-datasets branch February 27, 2025 11:02
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 enhancement New feature or request graphs models training
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants