Skip to content

Commit 6decb7d

Browse files
committed
Add link to olmoearth artifact license for weights in README
1 parent b43eee0 commit 6decb7d

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OlmoEarth Pretrain Minimal
22

3-
A minimal package for loading and initializing OlmoEarth v1 models. This package contains only the code necessary to load models from Hugging Face or initialize them with random weights, without training or evaluation dependencies.
3+
A minimal package for loading and initializing OlmoEarth models. This package contains only the code necessary to load models from Hugging Face or initialize them with random weights, without training or evaluation dependencies.
44

55

66
## Installation
@@ -29,7 +29,8 @@ uv installs everything into a venv, so to keep using python commands you can act
2929

3030
<img src="https://raw.githubusercontent.com/allenai/olmoearth_pretrain/main/assets/model.png" alt="Model Architecture Diagram" style="width: 800px; margin-left:'auto' margin-right:'auto' display:'block'"/>
3131

32-
The OlmoEarth models are trained on three satellite modalities (Sentinel 2, Sentinel 1 and Landsat) and six derived maps (OpenStreetMap, WorldCover, USDA Cropland Data Layer, SRTM DEM, WRI Canopy Height Map, and WorldCereal).
32+
The OlmoEarth models are trained on three satellite modalities (Sentinel 2, Sentinel 1 and Landsat) and six derived maps (OpenStreetMap, WorldCover, USDA Cropland Data Layer, SRTM DEM, WRI Canopy Height Map, and WorldCereal).
33+
**Note:** The model weights are released under the [OlmoEarth Artifact License](https://github.com/allenai/olmoearth_pretrain/blob/main/LICENSE)
3334
| Model Size | Weights | Encoder Params | Decoder Params |
3435
| --- | --- | --- | --- |
3536
| Nano | [link](https://huggingface.co/allenai/OlmoEarth-v1-Nano) | 1.4M | 800K |
@@ -55,7 +56,7 @@ from olmoearth_pretrain_minimal import ModelID, load_model_from_id
5556
model = load_model_from_id(ModelID.OLMOEARTH_V1_BASE, load_weights=True)
5657

5758
# Load with randomly initialized weights
58-
model_with_weights = load_model_from_id(ModelID.OLMOEARTH_V1_NANO, load_weights=True)
59+
model_with_weights = load_model_from_id(ModelID.OLMOEARTH_V1_NANO, load_weights=False)
5960
```
6061

6162
### Direct Model Initialization (Custom Configuration)
@@ -95,7 +96,7 @@ model.load_state_dict(weights)
9596

9697
The model expects normalized input data. Use the `Normalizer` class to normalize your data before passing it to the model.
9798

98-
**Important:** Data must be provided with bands in the specific order expected by each modality. See the band order section below.
99+
**Note:** Data must be provided with bands in the specific order expected by each modality. See the band order section below.
99100

100101
### Sample Code
101102

0 commit comments

Comments
 (0)