Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Restore full API in docstrings #57

Merged
merged 2 commits into from
May 16, 2024
Merged

Restore full API in docstrings #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e768e1
Restore full API
gdalle May 16, 2024
0921565
Indent
gdalle May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ uuid = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
authors = [
"Vaibhav Dixit <vaibhavyashdixit@gmail.com>, Guillaume Dalle and contributors",
]
version = "1.2.0"
version = "1.2.1"

[deps]
ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
Expand Down
124 changes: 89 additions & 35 deletions src/dense.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
"""
AutoChainRules(; ruleconfig)
AutoChainRules{RC}

Struct used to select an automatic differentiation backend based on [ChainRulesCore.jl](https://github.com/JuliaDiff/ChainRulesCore.jl) (see the list [here](https://juliadiff.org/ChainRulesCore.jl/stable/index.html#ChainRules-roll-out-status)).

Exported from [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).

# Constructors

AutoChainRules(; ruleconfig)

# Keyword Arguments
# Fields

- `ruleconfig::RC`: a [`ChainRulesCore.RuleConfig`](https://juliadiff.org/ChainRulesCore.jl/stable/rule_author/superpowers/ruleconfig.html) object.
"""
Expand All @@ -16,24 +20,32 @@ end
mode(::AutoChainRules) = ForwardOrReverseMode() # specialized in the extension

"""
AutoDiffractor()
AutoDiffractor

Struct used to select the [Diffractor.jl](https://github.com/JuliaDiff/Diffractor.jl) backend for automatic differentiation.

Exported from [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).

# Constructors

AutoDiffractor()
"""
struct AutoDiffractor <: AbstractADType end

mode(::AutoDiffractor) = ForwardOrReverseMode()

"""
AutoEnzyme(; mode=nothing)
AutoEnzyme{M}

Struct used to select the [Enzyme.jl](https://github.com/EnzymeAD/Enzyme.jl) backend for automatic differentiation.

Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).

# Constructors

Exported from [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
AutoEnzyme(; mode=nothing)

# Keyword Arguments
# Fields

- `mode::M`: can be either
- an object subtyping `EnzymeCore.Mode` (like `EnzymeCore.Forward` or `EnzymeCore.Reverse`) if a specific mode is required
Expand All @@ -46,24 +58,32 @@ end
mode(::AutoEnzyme) = ForwardOrReverseMode() # specialized in the extension

"""
AutoFastDifferentiation()
AutoFastDifferentiation

Struct used to select the [FastDifferentiation.jl](https://github.com/brianguenter/FastDifferentiation.jl) backend for automatic differentiation.

Exported from [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).

# Constructors

AutoFastDifferentiation()
"""
struct AutoFastDifferentiation <: AbstractADType end

mode(::AutoFastDifferentiation) = SymbolicMode()

"""
AutoFiniteDiff(; fdtype=Val(:forward), fdjtype=fdtype, fdhtype=Val(:hcentral))
AutoFiniteDiff{T1,T2,T3}

Struct used to select the [FiniteDiff.jl](https://github.com/JuliaDiff/FiniteDiff.jl) backend for automatic differentiation.

Exported from [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).

# Constructors

AutoFiniteDiff(; fdtype=Val(:forward), fdjtype=fdtype, fdhtype=Val(:hcentral))

# Keyword Arguments
# Fields

- `fdtype::T1`: finite difference type
- `fdjtype::T2`: finite difference type for the Jacobian
Expand All @@ -78,13 +98,17 @@ end
mode(::AutoFiniteDiff) = ForwardMode()

"""
AutoFiniteDifferences(; fdm)
AutoFiniteDifferences{T}

Struct used to select the [FiniteDifferences.jl](https://github.com/JuliaDiff/FiniteDifferences.jl) backend for automatic differentiation.

Exported from [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).

# Constructors

# Keyword Arguments
AutoFiniteDifferences(; fdm)

# Fields

- `fdm::T`: a [`FiniteDifferenceMethod`](https://juliadiff.org/FiniteDifferences.jl/stable/pages/api/#FiniteDifferences.FiniteDifferenceMethod)
"""
Expand All @@ -95,15 +119,22 @@ end
mode(::AutoFiniteDifferences) = ForwardMode()

"""
AutoForwardDiff(; chunksize=nothing, tag=nothing)
AutoForwardDiff{chunksize,T}

Struct used to select the [ForwardDiff.jl](https://github.com/JuliaDiff/ForwardDiff.jl) backend for automatic differentiation.

Exported from [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).

# Keyword Arguments
# Constructors

AutoForwardDiff(; chunksize=nothing, tag=nothing)

# Type parameters

- `chunksize`: the preferred [chunk size](https://juliadiff.org/ForwardDiff.jl/stable/user/advanced/#Configuring-Chunk-Size) to evaluate several derivatives at once

# Fields

- `tag::T`: a [custom tag](https://juliadiff.org/ForwardDiff.jl/release-0.10/user/advanced.html#Custom-tags-and-tag-checking-1) to handle nested differentiation calls (usually not necessary)
"""
struct AutoForwardDiff{chunksize, T} <: AbstractADType
Expand All @@ -117,15 +148,22 @@ end
mode(::AutoForwardDiff) = ForwardMode()

"""
AutoPolyesterForwardDiff{chunksize,T}

Struct used to select the [PolyesterForwardDiff.jl](https://github.com/JuliaDiff/PolyesterForwardDiff.jl) backend for automatic differentiation.

Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).

# Constructors

AutoPolyesterForwardDiff(; chunksize=nothing, tag=nothing)

Struct used to select the [PolyesterForwardDiff.jl](https://github.com/JuliaDiff/PolyesterForwardDiff.jl) backend for automatic differentiation.
# Type parameters

Exported from [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
- `chunksize`: the preferred [chunk size](https://juliadiff.org/ForwardDiff.jl/stable/user/advanced/#Configuring-Chunk-Size) to evaluate several derivatives at once

# Keyword Arguments
# Fields

- `chunksize`: the preferred [chunk size](https://juliadiff.org/ForwardDiff.jl/stable/user/advanced/#Configuring-Chunk-Size) to evaluate several derivatives at once
- `tag::T`: a [custom tag](https://juliadiff.org/ForwardDiff.jl/release-0.10/user/advanced.html#Custom-tags-and-tag-checking-1) to handle nested differentiation calls (usually not necessary)
"""
struct AutoPolyesterForwardDiff{chunksize, T} <: AbstractADType
Expand All @@ -139,13 +177,17 @@ end
mode(::AutoPolyesterForwardDiff) = ForwardMode()

"""
AutoReverseDiff(; compile=false)
AutoReverseDiff

Struct used to select the [ReverseDiff.jl](https://github.com/JuliaDiff/ReverseDiff.jl) backend for automatic differentiation.

Exported from [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).

# Constructors

# Keyword Arguments
AutoReverseDiff(; compile=false)

# Fields

- `compile::Bool`: whether to [compile the tape](https://juliadiff.org/ReverseDiff.jl/api/#ReverseDiff.compile) prior to differentiation
"""
Expand All @@ -156,24 +198,32 @@ end
mode(::AutoReverseDiff) = ReverseMode()

"""
AutoSymbolics()
AutoSymbolics

Struct used to select the [Symbolics.jl](https://github.com/JuliaSymbolics/Symbolics.jl) backend for automatic differentiation.

Exported from [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).

# Constructors

AutoSymbolics()
"""
struct AutoSymbolics <: AbstractADType end

mode(::AutoSymbolics) = SymbolicMode()

"""
AutoTapir()
AutoTapir

Struct used to select the [Tapir.jl](https://github.com/withbayes/Tapir.jl) backend for automatic differentiation.

Exported from [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).

# Constructors

# Keyword Arguments
AutoTapir(; safe_mode=true)

# Fields

- `safe_mode::Bool`: whether to run additional checks to catch errors early. On by default. Turn off to maximise performance if your code runs correctly.
"""
Expand All @@ -188,9 +238,9 @@ mode(::AutoTapir) = ReverseMode()

Struct used to select the [Tracker.jl](https://github.com/FluxML/Tracker.jl) backend for automatic differentiation.

Exported from [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).

# Constructor
# Constructors

AutoTracker()
"""
Expand All @@ -199,11 +249,15 @@ struct AutoTracker <: AbstractADType end
mode(::AutoTracker) = ReverseMode()

"""
AutoZygote()
AutoZygote

Struct used to select the [Zygote.jl](https://github.com/FluxML/Zygote.jl) backend for automatic differentiation.

Exported from [ADTypes.jl](https://github.com/SciML/ADTypes.jl).
Defined by [ADTypes.jl](https://github.com/SciML/ADTypes.jl).

# Constructors

AutoZygote()
"""
struct AutoZygote <: AbstractADType end

Expand Down
Loading