Skip to content

Commit

Permalink
Preserve old AutoTapir docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
gdalle committed Sep 25, 2024
1 parent c57eb48 commit 583510d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ AutoGTPSA
AutoMooncake
AutoReverseDiff
AutoTracker
AutoTapir
AutoZygote
```

Expand Down Expand Up @@ -107,3 +106,9 @@ ADTypes.SymbolicMode
```@docs
ADTypes.Auto
```

## Deprecated

```@docs
AutoTapir
```
12 changes: 12 additions & 0 deletions src/dense.jl
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,18 @@ mode(::AutoSymbolics) = SymbolicMode()
!!! danger
`AutoTapir` is deprecated following a package renaming, please use [`AutoMooncake`](@ref) instead.
Struct used to select the [Tapir.jl](https://github.com/compintell/Tapir.jl) backend for automatic differentiation.
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
# Constructors
AutoTapir(; safe_mode=true)
# Fields
- `safe_mode::Bool`: whether to run additional checks to catch errors early.
"""
struct AutoTapir <: AbstractADType
safe_mode::Bool
Expand Down

0 comments on commit 583510d

Please sign in to comment.