Skip to content

Commit

Permalink
Merge pull request #96 from m2lines/readme_updates
Browse files Browse the repository at this point in the history
Update README.md about dev branch and Huggingface data
  • Loading branch information
MarionBWeinzierl authored Oct 3, 2023
2 parents da3aa17 + c46c711 commit e82bbe6
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,19 @@ notebooks developed during early project development, some of which were used to
generate figures used in the 2021 paper. See the readme in the folder for
details.

### Dev Branch
The `dev` branch contains ongoing refactoring work which removes the necessity to use
mlflow. Currently, the code has been refactored into a clearer structure and easier
use through a command line interface for the data step, and the training step
is in progress. Further work is needed for the inference step, and to adapt the Jupyter
notebooks.

## Data on Huggingface
There is GZ21 Ocean Momentum data available on [Huggingface](https://huggingface.co/):
- [the output of the data step](https://huggingface.co/datasets/M2LInES/gfdl-cmip26-gz21-ocean-forcing)
and
- [the trained model](https://huggingface.co/M2LInES/gz21-ocean-momentum)

## Contributing
We are not currently accepting contributions outside of the M2LInES and ICCS
projects until we have reached a code release milestone.
Expand Down

0 comments on commit e82bbe6

Please sign in to comment.