Skip to content

Commit 05760db

Browse files
committed
Update tutorial names which were affecting linking
Fix broken links
1 parent f0fb5de commit 05760db

5 files changed

Lines changed: 12 additions & 7 deletions

File tree

docs/newproject.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ You will train the model using historical model data and historical point data.
2020

2121
From there, configure the data accessors. The PyEarthTools accessors are currently being extended so that there are a range of accessors for fetching cloud data and working with standard datasets, but for now look at the examples in the tutorial for how to create one for your own data.
2222

23-
Then, make a pipeline. Work out which variables you want, subset the grid points you want, and normlise the data. Take a look at the tutorial on [Working with Multiple Data Sources](notebooks/tutorial/MultipleSources.md) and [MLX Demo](notebooks/tutorial/ML_Demo_CustomArch.md) to see how to approach constructing the pipeline, and refer to [api/pipeline/howto.md](api/pipeline/howto.md) for a more in-depth how-to guide on this process.
23+
Then, make a pipeline. Work out which variables you want, subset the grid points you want, and normlise the data. Take a look at the tutorial on [Working with Multiple Data Sources](./notebooks/tutorial/MultipleSources) and [MLX Demo](./notebooks/tutorial/MLX-Demo-Custom-Arch) to see how to approach constructing the pipeline, and refer to [api/pipeline/howto.md](api/pipeline/pipeline_how_to.md) for a more in-depth how-to guide on this process.
2424

2525
Visualise some of the samples from the pipeline, and make sure the data looks right. Maybe do a plot of the historical difference between the gridded value and the point value, to see how the two things are different.
2626

27-
There are a number of ways to train the baseline model. One of the easiest is to use the XGBoost framework, because it's robust and computationally lightweight. There is no tutorial example of this yet, but you might like to look at the [MLX Demo](notebooks/tutorial/ML_Demo_CustomArch.md) and the [CNN Demo](notebooks/tutorial/CNN_Model_Training.md) for inspiration. There are a lot of nuances here for how to manage a large project where you might be running dozens or hundreds of experiments, but the easiest place to start is a single model trained in a Jupyter Notebook. Experiment management information will be added later.
27+
There are a number of ways to train the baseline model. One of the easiest is to use the XGBoost framework, because it's robust and computationally lightweight. There is no tutorial example of this yet, but you might like to look at the [MLX Demo](./notebooks/tutorial/MLX-Demo-Custom-Arch) and the [CNN Demo](./notebooks/tutorial/CNN-Model-Training) for inspiration. There are a lot of nuances here for how to manage a large project where you might be running dozens or hundreds of experiments, but the easiest place to start is a single model trained in a Jupyter Notebook. Experiment management information will be added later.
2828

2929
Evaluating the model is up to you at this point. They PyEarthTools roadmap includes the development of standard scorecards for an out-of-the-box experience, but for now check out the [scores](https://scores.readthedocs.io/) framework for verification.

notebooks/Gallery.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"These tutorials can be run on a 4GB GPU using relatively low volumes of data (3-10GB). They will also work in HPC environments.\n",
2121
"\n",
2222
"- [Train and run a simplified global weather model (low hardware and data requirements)](./tutorial/FourCastMini_Demo.ipynb) (working on 1 June 2025)\n",
23-
"- [MLX Framework Example](./tutorial/MLX_Demo_CustomArch.ipynb) (working as at 8 Jun 2025)\n"
23+
"- [MLX Framework Example](./tutorial/MLX-Demo-Custom-Arch.ipynb) (working as at 8 Jun 2025)\n"
2424
]
2525
},
2626
{
@@ -42,7 +42,7 @@
4242
"- [Downloading ERA5 Data](./tutorial/Downloading_ERA5.ipynb) (working as at 1 June 2025)\n",
4343
"- [Accessing ERA5 Data](./tutorial/Accessing_ERA5_Data.ipynb) (working as at 1 June 2025)\n",
4444
"- [Introduction to Pipelines](./tutorial/Data_Pipelines.ipynb) (working as at 1 June 2025)\n",
45-
"- [End-to-end CNN Training Example](./tutorial/CNN_model_training.ipynb) (working as at 1 June 2025)\n",
45+
"- [End-to-end CNN Training Example](./tutorial/CNN-Model-Training.ipynb) (working as at 1 June 2025)\n",
4646
"- [Training FourCastNeXt](./tutorial/FourCastNeXt_Training.ipynb) (not working on 1 June 2025, requires fixes to the configuration files to work for all users, will be restored in future)\n",
4747
"- [Make a weather prediction with FourCastNeXt](./demo/FourCastNeXt_Inference.ipynb) (not working on 1 June 2025, requires fixes to the configuration files to work for all users, will be restored in future)\n",
4848
"- [Working with Multiple Data Sources](./tutorial/MultipleSources.ipynb) (working as at 1 June 2025)\n",

notebooks/tutorial/CNN_model_training.ipynb renamed to notebooks/tutorial/CNN-Model-Training.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8364,7 +8364,7 @@
83648364
"name": "python",
83658365
"nbconvert_exporter": "python",
83668366
"pygments_lexer": "ipython3",
8367-
"version": "3.11.7"
8367+
"version": "3.13.2"
83688368
}
83698369
},
83708370
"nbformat": 4,
File renamed without changes.

packages/bundled_models/fourcastnext/src/fourcastnext/registered_model.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,14 @@
3131
@pyearthtools.zoo.register("Development/FourCastNextRM", exists="ignore")
3232
class FourCastNextRM(pyearthtools.zoo.BaseForecastModel):
3333
"""
34-
FourCastNeXt
34+
FourCastNeXt was originally developed by FourCastNeXt ([Guo et al. 2024](https://doi.org/10.48550/arXiv.2401.05584))
3535
36-
Developed by NCI
36+
This class provides the underlying architecture as a registered model within the framework,
37+
so that it can be trained according to whatever data and resolution may be of interest.
38+
39+
Users need to train their own model weights.
40+
41+
3742
3843
Arguments:
3944
lead_time (int | str | pyearthtools.data.TimeDelta):

0 commit comments

Comments
 (0)