Skip to content

Commit

Permalink
include arxiv paper and upadte citation guide (#113)
Browse files Browse the repository at this point in the history
Co-authored-by: tungnd <[email protected]>
  • Loading branch information
tung-nd and tungnd authored Jul 31, 2023
1 parent 1a46b08 commit b199b45
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Google Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1LcecQLgLtwaHOwbvJAxw9UjCxfM0RMrX?usp=sharing)

**ClimateLearn** is a Python library for accessing state-of-the-art climate data and machine learning models in a standardized, straightforward way. This library provides access to multiple datasets, a zoo of baseline approaches, and a suite of metrics and visualizations for large-scale benchmarking of statistical downscaling and temporal forecasting methods. For further context on our past motivation and future plans, check out our announcement [blog post](https://aditya-grover.github.io/blog/2023/climate-learn/).
**ClimateLearn** is a Python library for accessing state-of-the-art climate data and machine learning models in a standardized, straightforward way. This library provides access to multiple datasets, a zoo of baseline approaches, and a suite of metrics and visualizations for large-scale benchmarking of statistical downscaling and temporal forecasting methods. For further context on our past motivation and future plans, check out our announcement [blog post](https://aditya-grover.github.io/blog/2023/climate-learn/). Also, check out our [arxiv preprint](https://arxiv.org/abs/2307.01909) that showcases the flexibility of ClimateLearn in performing benchmarking and analysis on the robustness and transfer performance of deep learning models.

## Usage

Expand All @@ -30,4 +30,13 @@ ClimateLearn is managed by the Machine Intelligence Group at UCLA, headed by [Pr
Contributions are welcome! See our [contributing guide](https://github.com/aditya-grover/climate-learn/blob/main/CONTRIBUTING.md).

## Citing ClimateLearn
If you use ClimateLearn, please see the [`CITATION.cff`](https://github.com/aditya-grover/climate-learn/blob/main/CITATION.cff) file or use the citation prompt provided by GitHub in the sidebar.
<!-- If you use ClimateLearn, please see the [`CITATION.cff`](https://github.com/aditya-grover/climate-learn/blob/main/CITATION.cff) file or use the citation prompt provided by GitHub in the sidebar. -->
If you use ClimateLearn in your research, please cite our paper:
```
@article{nguyen2023climatelearn,
title={ClimateLearn: Benchmarking Machine Learning for Weather and Climate Modeling},
author={Nguyen, Tung and Jewik, Jason and Bansal, Hritik and Sharma, Prakhar and Grover, Aditya},
journal={arXiv preprint arXiv:2307.01909},
year={2023}
}
```

0 comments on commit b199b45

Please sign in to comment.