From 583510dcf9f656cf197b5f94a33f97304a6bdcb4 Mon Sep 17 00:00:00 2001 From: Guillaume Dalle <22795598+gdalle@users.noreply.github.com> Date: Wed, 25 Sep 2024 13:35:37 +0200 Subject: [PATCH] Preserve old AutoTapir docstring --- docs/src/index.md | 7 ++++++- src/dense.jl | 12 ++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/src/index.md b/docs/src/index.md index d356e3d..2100fb2 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -42,7 +42,6 @@ AutoGTPSA AutoMooncake AutoReverseDiff AutoTracker -AutoTapir AutoZygote ``` @@ -107,3 +106,9 @@ ADTypes.SymbolicMode ```@docs ADTypes.Auto ``` + +## Deprecated + +```@docs +AutoTapir +``` diff --git a/src/dense.jl b/src/dense.jl index 7a1ee0b..aa028bc 100644 --- a/src/dense.jl +++ b/src/dense.jl @@ -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