Skip to content

Commit

Permalink
Move sections from description to notes
Browse files Browse the repository at this point in the history
  • Loading branch information
wesselb committed Jan 20, 2025
1 parent 17c5fe4 commit 6d8f2cb
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 36 deletions.
36 changes: 0 additions & 36 deletions assets/models/system/aurora/description.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,39 +9,3 @@ and one for ocean wave prediction.
Currently, this implementation only includes the version for medium-term weather prediction.
Please see the documentation of the Aurora Foundry Python API linked below for
precisely which models are available.

## Resources

* [Documentation of the Aurora Foundry Python API](https://microsoft.github.io/aurora/foundry/intro.html)
* [A full-fledged example that runs the model on Foundry](https://microsoft.github.io/aurora/foundry/demo_hres_t0.html).
* [Implementation of the Aurora model](https://github.com/microsoft/aurora)
* [Documentation of the Aurora implementation](https://microsoft.github.io/aurora/intro.html)
* [Paper with detailed evaluation](https://arxiv.org/abs/2405.13063)

## Quickstart

```python
from aurora import Batch

from aurora.foundry import BlobStorageChannel, FoundryClient, submit


initial_condition = Batch(...) # Create initial condition for the model.

for pred in submit(
initial_condition,
model_name="aurora-0.25-finetuned",
num_steps=4, # Every step predicts six hours ahead.
foundry_client=FoundryClient(
endpoint="https://endpoint/",
token="ENDPOINT_TOKEN",
),
# Communication with the endpoint happens via an intermediate blob storage container. You
# will need to create one and generate an URL with a SAS token that has both read and write
# rights.
channel=BlobStorageChannel(
"https://storageaccount.blob.core.windows.net/container?<READ_WRITE_SAS_TOKEN>"
),
):
pass # Do something with `pred`, which is a `Batch`.
```
36 changes: 36 additions & 0 deletions assets/models/system/aurora/notes.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,39 @@
## Resources

* [Documentation of the Aurora Foundry Python API](https://microsoft.github.io/aurora/foundry/intro.html)
* [A full-fledged example that runs the model on Foundry](https://microsoft.github.io/aurora/foundry/demo_hres_t0.html).
* [Implementation of the Aurora model](https://github.com/microsoft/aurora)
* [Documentation of the Aurora implementation](https://microsoft.github.io/aurora/intro.html)
* [Paper with detailed evaluation](https://arxiv.org/abs/2405.13063)

## Quickstart

```python
from aurora import Batch

from aurora.foundry import BlobStorageChannel, FoundryClient, submit


initial_condition = Batch(...) # Create initial condition for the model.

for pred in submit(
initial_condition,
model_name="aurora-0.25-finetuned",
num_steps=4, # Every step predicts six hours ahead.
foundry_client=FoundryClient(
endpoint="https://endpoint/",
token="ENDPOINT_TOKEN",
),
# Communication with the endpoint happens via an intermediate blob storage container. You
# will need to create one and generate an URL with a SAS token that has both read and write
# rights.
channel=BlobStorageChannel(
"https://storageaccount.blob.core.windows.net/container?<READ_WRITE_SAS_TOKEN>"
),
):
pass # Do something with `pred`, which is a `Batch`.
```

## License

This model and the associated model weights are released under the license [CC-BY-NC-SA-4.0](https://spdx.org/licenses/CC-BY-NC-SA-4.0).
Expand Down

0 comments on commit 6d8f2cb

Please sign in to comment.