Skip to content

Commit 2c7eab6

Browse files
authored
Add HISTORY.md (#425)
* Add HISTORY.md * Apply reviews * Fix typos * Apply reviews
1 parent 5538397 commit 2c7eab6

File tree

3 files changed

+46
-20
lines changed

3 files changed

+46
-20
lines changed

HISTORY.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# AdvancedHMC Changelog
2+
3+
## v0.7.1
4+
5+
- README has been simplified, many docs transfered to docs: https://turinglang.org/AdvancedHMC.jl/dev/.
6+
- ADTypes.jl can be used for specifying the AD backend in `Hamiltonian(metric, ℓπ, AutoForwardDiff())`.
7+
- SimpleUnpack.jl and Requires.jl are removed from the dependency.
8+
- `find_good_stepsize` now has fewer allocations.
9+
10+
## v0.7.0
11+
12+
- Type piracies of Base.rand and Base.randn for vectors of RNGs are removed: Replace `rand(rngs::AbstractVector{<:Random.AbstractRNG})` with `map(rand, rngs)`, `randn(rngs::AbstractVector{<:Random.AbstractRNG})` with `map(randn, rngs)`, `rand(rngs::AbstractVector{<:Random.AbstractRNG}, T, n::Int) (for n == length(rngs))` with `map(Base.Fix2(rand, T), rngs)`, and `randn(rngs::AbstractVector{<:Random.AbstractRNG}, T, m::Int, n::Int) (for n == length(rngs))` with eg `reduce(hcat, map(rng -> randn(rng, T, m), rngs))`.
13+
- Type piracy `Base.isfinite(x::AbstractVecOrMat)` is removed: Switch to `all(isfinite, x)` if you (possibly implicitly) relied on this definition
14+
- Abstract fields of `NesterovDualAveraging`, `HMCDA`, `SliceTS`, and `MultinomialTS` are made concrete by adding type parameters: Update occurrences of these types (eg. in function signatures) if necessary
15+
- Definitions of Base.rand for metrics are removed: Use the (internal) `AdvancedHMC.rand_momentum` function if you depend on this functionality and open an issue to further discuss the API
16+
17+
## v0.5.0
18+
19+
Convenience constructors for common samplers changed to:
20+
21+
- `HMC(leapfrog_stepsize::Real, n_leapfrog::Int)`
22+
- `NUTS(target_acceptance::Real)`
23+
- `HMCDA(target_acceptance::Real, integration_time::Real)`
24+
25+
## v0.2.22
26+
27+
Three functions are renamed.
28+
29+
- `Preconditioner(metric::AbstractMetric)` -> `MassMatrixAdaptor(metric)` and
30+
- `NesterovDualAveraging(δ, integrator::AbstractIntegrator)` -> `StepSizeAdaptor(δ, integrator)`
31+
- `find_good_eps` -> `find_good_stepsize`
32+
33+
## v0.2.15
34+
35+
`n_adapts` is no longer needed to construct `StanHMCAdaptor`; the old constructor is deprecated.
36+
37+
## v0.2.8
38+
39+
Two Hamiltonian trajectory sampling methods are renamed to avoid a name clash with Distributions.
40+
41+
- `Multinomial` -> `MultinomialTS`
42+
- `Slice` -> `SliceTS`
43+
44+
## v0.2.0
45+
46+
The gradient function passed to `Hamiltonian` is supposed to return a value-gradient tuple now.

docs/make.jl

-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ makedocs(;
2020
"Detailed API" => "api.md",
2121
"Interfaces" => "interfaces.md",
2222
"News" => "news.md",
23-
"Change Log" => "changelog.md",
2423
"References" => "references.md",
2524
],
2625
)

docs/src/changelog.md

-19
This file was deleted.

0 commit comments

Comments
 (0)