From c473f2100d906c71504a973fcf6759d0ac2c5c6c Mon Sep 17 00:00:00 2001 From: Wessel Bruinsma Date: Tue, 3 Sep 2024 11:16:34 +0200 Subject: [PATCH] Add sketch of plugin information --- docs/_toc.yml | 1 + docs/ai_models_plugin.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 docs/ai_models_plugin.md diff --git a/docs/_toc.yml b/docs/_toc.yml index ca1c59e..4a695a4 100644 --- a/docs/_toc.yml +++ b/docs/_toc.yml @@ -8,4 +8,5 @@ chapters: - file: finetuning - file: example_era5 - file: example_hres_t0 +- file: ai_models_plugin - file: api diff --git a/docs/ai_models_plugin.md b/docs/ai_models_plugin.md new file mode 100644 index 0000000..e8bf1cd --- /dev/null +++ b/docs/ai_models_plugin.md @@ -0,0 +1,18 @@ +# Plugin for ECMWF's `ai-models` + +Aurora is a supported model for ECMWF's +[`ai-models`](https://github.com/ecmwf-lab/ai-models) +through the plugin +[`ai-models-aurora`](https://github.com/ecmwf-lab/ai-models-aurora). +Install this plugin with `pip`: + +```bash +pip install ai-models-aurora +``` + +See +[the documentation of `ai-models`](https://github.com/ecmwf-lab/ai-models) +for more information about `ai-models` +and see +[the documentation of `ai-models-aurora`](https://github.com/ecmwf-lab/ai-models-aurora) +for more information about the Aurora plugin.