Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
msainsburydale committed Jan 14, 2025
1 parent 160bcf5 commit c350865
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/src/workflow/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ end
simulate(parameters::Parameters, m::Integer = 1) = simulate(parameters, range(m, m))
```

Next, we construct our GNN architectur. Here, our goal is to construct a point estimator, however any other kind of estimator (see [Estimators](@ref)) can be constructed by simply substituting the appropriate estimator class in the final line below:
Next, we construct our GNN architectur. Here, we use an architecture tailored to isotropic spatial dependence models; for further details, see Section 2.2 of [Sainsbury-Dale et al. (2025)](https://doi.org/10.1080/10618600.2024.2433671). In this example our goal is to construct a point estimator, however any other kind of estimator (see [Estimators](@ref)) can be constructed by simply substituting the appropriate estimator class in the final line below:

```
# Spatial weight functions: continuous surrogates for 0-1 basis functions
Expand Down Expand Up @@ -368,9 +368,9 @@ K = 5000
θ̂ = train(θ̂, θ_train, θ_val, simulate, m = m, epochs = 20)
```

Note that the fast construction of a GNN-based neural Bayes estimator typically requires a graphical processing unit (GPU).
Note that the computations in GNNs are performed in parallel, making them particularly well-suited for GPUs, which typically contain thousands of cores. If you have access to an NVIDIA GPU, you can utilise it by simply loading the Julia package `CUDA`.

Then, we assess our trained estimator:
Next, we assess our trained estimator:

```
θ_test = sample(1000)
Expand Down

2 comments on commit c350865

@msainsburydale
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/122957

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.2.2 -m "<description of version>" c350865b61e11ea4eb615c428d90b94379d86ba4
git push origin v0.2.2

Also, note the warning: Version 0.2.2 skips over 0.2.0
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

Please sign in to comment.