Skip to content

Commit

Permalink
Update docstring for AutoMooncake
Browse files Browse the repository at this point in the history
  • Loading branch information
willtebbutt committed Sep 25, 2024
1 parent 8546ebe commit 7840fcf
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions src/dense.jl
Original file line number Diff line number Diff line change
Expand Up @@ -235,17 +235,15 @@ for automatic differentiation.
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
Note: Tapir.jl was renamed to Mooncake.jl due to a naming conflict. You should use this type
instead of `AutoTapir`.
# Constructors
AutoMooncake(; config)
# Fields
- `config`: an instance of `Mooncake.Config` -- see the docstring for `Mooncake.Config`
for more information.
- `config`: either `nothing` or an instance of `Mooncake.Config` -- see the docstring for
`Mooncake.Config` for more information. `AutoMooncake(; config=nothing)` is equivalent
to `AutoMooncake(; config=Mooncake.Config())`, i.e. the default configuration.
"""
Base.@kwdef struct AutoMooncake{Tconfig} <: AbstractADType
config::Tconfig
Expand Down

0 comments on commit 7840fcf

Please sign in to comment.