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

Update README.md about dev branch and Huggingface data #96

Merged
merged 1 commit into from
Oct 3, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading