Better documentation #417
Merged
Better documentation #417
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks @ErikQQY. I suggest that we
|
mhauru
requested changes
Apr 2, 2025
sunxd3
reviewed
Apr 4, 2025
There was a problem hiding this comment.
Some nitpicking.
Also, the reference list at https://turinglang.org/AdvancedHMC.jl/previews/PR417/#References and https://turinglang.org/AdvancedHMC.jl/previews/PR417/references/ are not identical. Not sure if we want to unify them.
|
extra line at AdvancedHMC.jl/docs/src/index.md Line 58 in e23c7a0 |
|
Thanks @ErikQQY! |
mhauru
reviewed
Apr 7, 2025
| @@ -1,5 +1,5 @@ | |||
| # Gradient in AdvancedHMC.jl | |||
|
|
|||
| AdvancedHMC.jl supports automatic differentiation using [`LogDensityProblemsAD`](https://github.com/tpapp/LogDensityProblemsAD.jl) and user-specified gradients. While the default AD backend for AdvancedHMC.jl is ForwardDiff.jl, we can seamlessly change to other backend like Zygote.jl using various syntax like `Hamiltonian(metric, ℓπ, Zygote)`, `Hamiltonian(metric, ℓπ, Val(:Zygote))` or via ADTypes.jl `Hamiltonian(metric, ℓπ, AutoZygote())`. | |||
| AdvancedHMC.jl supports automatic differentiation using [`LogDensityProblemsAD`](https://github.com/tpapp/LogDensityProblemsAD.jl) across various AD backends and allows user-specified gradients. While the default AD backend for AdvancedHMC.jl is ForwardDiff.jl, we can seamlessly change to other backend like Mooncake.jl using various syntax like `Hamiltonian(metric, ℓπ, AutoZygote())`. Different AD backend can also be pluged in using `Hamiltonian(metric, ℓπ, Zygote)`, `Hamiltonian(metric, ℓπ, Val(:Zygote))` but we recommend using ADTypes since that would allow you to have more freedom for specifying the AD backend. | |||
There was a problem hiding this comment.
Is the mixture of Mooncake and Zygote here intentional? Would it be clearer to have the whole example use Mooncake?
There was a problem hiding this comment.
I probably merge this too soon. Please open another follow-up PR.
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix: #330
Fix: #413
Fix: #402
Replace #414
Preview can be checked in https://turinglang.org/AdvancedHMC.jl/previews/PR417