Skip to content

docs: added contributor tip to README #15

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: added contributor tip to README #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# A repo for training deterministic models to predict future satellite


<!-- Tip: This repo is a great way to get started with ML for weather forecasting. 🌤️ -->
## Installation

Create and activate a new python environment, e.g.
Expand Down Expand Up @@ -71,6 +71,19 @@ python sat_pred/train.py model=earthformer model_name="earthformer-v1" model.opt
will train the model defined in `configs/model/earthformer.yaml` log ther training results to wandb under the name `earthformer-v1`. It will also overwrite the learning rate of the optimiser to 0.0002.


---

## Extra Setup Tips (for new contributors)

If you're setting this up for the first time, here are some easy tips:

- Make sure you're using Python 3.8 or newer.
- It's recommended to use a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # On Windows use: venv\Scripts\activate





Expand Down