Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ptiede committed Oct 6, 2024
1 parent 444ab63 commit 6667d83
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
10 changes: 3 additions & 7 deletions docs/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,9 @@ not have to create a separate source "model" every time they
change the model specification. Additionally, most models currently implemented are differentiable with at Enzyme. This allows for gradient accelerated optimization and sampling (e.g., HMC) to be used with little
effort by the end user.

!!! warn
As of 0.11 Comrade is only tested with Enzyme. ForwardDiff may work for some
models, but it is not tested and there are known problems with e.g., closures
due to the use of a sparse cholesky factorization. Additionally essentially no
models will work with Zygote due to the heavy use of mutation in the codebase.
The use of mutation is necessary for performance reasons, and we have no plans
to change this in the future.
!!! warning
As of 0.11 Comrade will only support AD with Enzyme. We have removed support for Zygote and ForwardDiff
due to performance issues.


## Tutorials
Expand Down
2 changes: 1 addition & 1 deletion examples/advanced/HybridImaging/main.jl
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ using Pyehtim

# For reproducibility we use a stable random number genreator
using StableRNGs
rng = StableRNG(49)
rng = StableRNG(5)


# To download the data visit https://doi.org/10.25739/g85n-f134
Expand Down

0 comments on commit 6667d83

Please sign in to comment.