Restructure docs

EnzymeAD · Mar 18, 2024 · b4a9b74 · b4a9b74
1 parent e4ec856
commit b4a9b74
Show file tree

Hide file tree

Showing 7 changed files with 413 additions and 410 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -21,8 +21,8 @@ const EXAMPLES_DIR = joinpath(@__DIR__, "..", "examples")
 const OUTPUT_DIR = joinpath(@__DIR__, "src/generated")
 
 examples = Pair{String,String}[
+    "Basics" => "autodiff"
     "Box model" => "box"
-    "AutoDiff API" => "autodiff"
     "Custom rules" => "custom_rule"
 ]
 
@@ -51,17 +51,19 @@ makedocs(;
     pages = [
         "Home" => "index.md",
         "Examples" => examples,
-        "API" => "api.md",
-        "Implementing pullbacks" => "pullbacks.md",
-        "For developers" => "dev_docs.md",
-        "Internal API" => "internal_api.md",
+        "FAQ" => "FAQ.md",
+        "API reference" => "api.md",
+        "Advanced" => [
+            "For developers" => "dev_docs.md",
+            "Internal API" => "internal_api.md",
+        ]
     ],
     doctest = true,
     strict = true,
 )
 
 deploydocs(;
     repo="github.com/EnzymeAD/Enzyme.jl",
-    devbranch = "main",
-    push_preview = true,
+    devbranch="main",
+    push_preview=true,
 )
diff --git a/docs/src/api.md b/docs/src/api.md
@@ -1,4 +1,4 @@
-# API
+# API reference
 
 ## Types and constants
 
@@ -14,7 +14,7 @@ Modules = [Enzyme, EnzymeCore, EnzymeCore.EnzymeRules, EnzymeTestUtils, Enzyme.A
 Order = [:macro, :function]
 ```
 
-# Documentation
+## Documentation
 
 ```@autodocs
 Modules = [Enzyme, EnzymeCore, EnzymeCore.EnzymeRules, EnzymeTestUtils, Enzyme.API]

diff --git a/docs/src/faq.md b/docs/src/faq.md
diff --git a/docs/src/index.md b/docs/src/index.md
diff --git a/docs/src/pullbacks.md b/docs/src/pullbacks.md
diff --git a/examples/autodiff.jl b/examples/autodiff.jl
@@ -1,4 +1,4 @@
-# # AutoDiff API
+# # Basics
 
 # The goal of this tutorial is to give users already familiar with automatic
 # differentiation (AD) an overview

diff --git a/lib/EnzymeCore/src/EnzymeCore.jl b/lib/EnzymeCore/src/EnzymeCore.jl
@@ -58,17 +58,6 @@ Mark a function argument `x` of [`autodiff`](@ref Enzyme.autodiff) as duplicated
 auto-differentiate in respect to such arguments, with `dx` acting as an
 accumulator for gradients (so ``\\partial f / \\partial x`` will be *added to*)
 `∂f_∂x`.
-
-# Note
-
-Enzyme forces `x` and `∂f_∂x` to have the same types when constructing `Duplicated`.
-This is not a mathematical requirement, but rather a guardrail to prevent user error.
-The memory locations of `x` and `∂f_∂x` are accessed in the same way by the differentiation code, so they should have the same data layout.
-Equality of types is an approximation of this condition.
-
-In some ways, type equality is too strict, but in other ways it is not strict enough.
-For instance, if `x` and `∂f_∂x` are sparse arrays, their sparsity pattern should be identical, but this is not encoded in the type.
-To make sure that `∂f_∂x` has the right data layout, create it with `∂f_∂x = Enzyme.make_zero(x)`.
 """
 struct Duplicated{T} <: Annotation{T}
     val::T