Merge pull request #26 from gdalle/docstring_chainrules

Document AutoChainRules
SciML · Mar 11, 2024 · 4bd7704 · 4bd7704
2 parents 0af4052 + aa4e1a9
commit 4bd7704
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "ADTypes"
 uuid = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
 authors = ["Vaibhav Dixit <[email protected]> and contributors"]
-version = "0.2.6"
+version = "0.2.7"
 
 [compat]
 julia = "1.6"

diff --git a/README.md b/README.md
@@ -13,8 +13,9 @@ Just run the following code in a Julia REPL to find out:
 julia> using ADTypes
 
 julia> names(ADTypes)
-15-element Vector{Symbol}:
+16-element Vector{Symbol}:
  :ADTypes
+ :AutoChainRules
  :AutoEnzyme
  :AutoFiniteDiff
  :AutoFiniteDifferences

diff --git a/src/ADTypes.jl b/src/ADTypes.jl
@@ -19,6 +19,15 @@ abstract type AbstractSparseReverseMode <: AbstractReverseMode end
 abstract type AbstractSparseForwardMode <: AbstractForwardMode end
 abstract type AbstractSparseFiniteDifferences <: AbstractFiniteDifferencesMode end
 
+"""
+    AutoChainRules{RC}
+
+Chooses any AD library based on [ChainRulesCore.jl](https://github.com/JuliaDiff/ChainRulesCore.jl), given an appropriate [`RuleConfig`](https://juliadiff.org/ChainRulesCore.jl/stable/rule_author/superpowers/ruleconfig.html) object.
+
+# Fields
+
+- `ruleconfig::RC`
+"""
 Base.@kwdef struct AutoChainRules{RC} <: AbstractADType
     ruleconfig::RC
 end