Skip to content

Commit 0014ae6

Browse files
committed
Add code sample to load models to READMEs
1 parent ff0fafe commit 0014ae6

File tree

3 files changed

+24
-0
lines changed

3 files changed

+24
-0
lines changed

the_well/benchmark/models/tfno/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,11 @@ Below is the list of checkpoints available for the training of TFNO on different
7070
| [viscoelastic_instability](https://huggingface.co/polymathic-ai/TFNO-viscoelastic_instability) | 5E-3 | 199 | 0.7021 |
7171

7272
## Loading the model from Hugging Face
73+
74+
To load the TFNO model trained on a dataset of the Well, use the following while replacing `<datasetname>` by the actual name of the dataset.
75+
76+
```python
77+
from the_well.benchmark.models import TFNO
78+
79+
model = TFNO.from_pretrained("polymathic-ai/TFNO-<datasetname>")
80+
```

the_well/benchmark/models/unet_classic/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,11 @@ Below is the list of checkpoints available for the training of U-Net on differen
7272
| [viscoelastic_instability](https://huggingface.co/polymathic-ai/UNET-viscoelastic_instability) | 5E-4 | 198 | 0.3147 |
7373

7474
## Loading the model from Hugging Face
75+
76+
To load the U-Net model trained on a dataset of the Well, use the following while replacing `<datasetname>` by the actual name of the dataset.
77+
78+
```python
79+
from the_well.benchmark.models import UNetClassic
80+
81+
model = UNetClassic.from_pretrained("polymathic-ai/UNET-<datasetname>")
82+
```

the_well/benchmark/models/unet_convnext/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,11 @@ Below is the list of checkpoints available for the training of CNextU-Net on dif
7474
| [viscoelastic_instability](https://huggingface.co/polymathic-ai/CNextU-Net-viscoelastic_instability) | 5E-4 | 114 | 0.1966 |
7575

7676
## Loading the model from Hugging Face
77+
78+
To load the CNextU-Net model trained on a dataset of the Well, use the following while replacing `<datasetname>` by the actual name of the dataset.
79+
80+
```python
81+
from the_well.benchmark.models import UNetConvNext
82+
83+
model = UNetConvNext.from_pretrained("polymathic-ai/CNextU-Net-<datasetname>")
84+
```

0 commit comments

Comments
 (0)