Skip to content

Commit

Permalink
structure docs
Browse files Browse the repository at this point in the history
  • Loading branch information
scheidan committed Aug 16, 2024
1 parent 1b7f52a commit ec119ce
Showing 1 changed file with 36 additions and 2 deletions.
38 changes: 36 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,43 @@ CurrentModule = SimulatedAnnealingABC

Documentation for [SimulatedAnnealingABC](/~https://github.com/Eawag-SIAM/SimulatedAnnealingABC.jl).

This package provides different SimulatedAnnealingABC (SABC)
algorithms for Approximate Bayesian Computation (ABC) (sometimes also called
_simulation-based inference_).

> [!NOTE]
> If you are able to compute the density of your posterior, you should
most likely not be using this or another ABC package. A traditional MCMC
algorithm will be much more efficient.



## Usage

todo...



## API

```@index
```

```@autodocs
Modules = [SimulatedAnnealingABC]
```@docs
sabc
```

```@docs
update_population!
```


## Related Julia Packages

todo

## References

Albert, C., Künsch, H.R., Scheidegger, A., 2015. A simulated annealing
approach to approximate Bayes computations. Statistics and computing
25, 1217–1232. https://doi.org/10.1007/s11222-014-9507-8

0 comments on commit ec119ce

Please sign in to comment.