Add mermaidjs based code diagram #9
Conversation
To aid discussion around refactoring the code and allow for easy modification of the code diagram in future introduce a [mermaidjs](https://mermaid.js.org/) based diagram in the README.
|
@joeloskarsson I updated the diagram because I realised that I had slightly misunderstood the shapes of what is in the |
There was a problem hiding this comment.
I think this is great, and much more maintainable than the diagram I had made before. Just fix the missing file and (optionally) see if you can re-style the notes, and I'll merge.
As we refactor I hope to abstract some of these things away, but having this diagram also to change when we are doing such refactoring is very valuable.
|
|
||
| subgraph parameter_weights | ||
| direction LR | ||
| parameter_mean.pt\nparameter_std.pt\ndiff_mean.pt\ndiff_std.pt\nflux_stats.pt:::pt_file |
There was a problem hiding this comment.
The file parameter_weights.npy is missing here.
There was a problem hiding this comment.
I realise that this is a pretty bad name for this specific file, but that's for another day 😅
| source_xy_coordinates | ||
| surface_geopotential | ||
| border_mask | ||
| note("stored in `data/{dataset_name}/static/") |
There was a problem hiding this comment.
How tricky would it be to make these notes look more different than the files? It would be nice just to avoid confusion. But if it is not trivial to change the styling a bit it doesn't matter.
|
Should we fix and merge this, or is this diagram obsolete as we are moving to other ways of handling data loading? I just don't see a need for this to sit here as an open PR. |
|
I think this is obsolete now :) |
To aid discussion around refactoring the code and allow for easy modification of the code diagram in future I have created a mermaidjs based diagram in the README in place of the graphic that was there previously. Please have a look @joeloskarsson if you think this covers what the old diagram did.
Here's a direct link in the README: https://github.com/leifdenby/neural-lam/tree/feat/readme-code-diagram?tab=readme-ov-file#pre-processing, and a screenshot from vscode: