From ef161309e498fb2a3a297e99ad1f7242e5519397 Mon Sep 17 00:00:00 2001 From: Guillaume Dalle <22795598+gdalle@users.noreply.github.com> Date: Thu, 23 May 2024 13:49:06 +0200 Subject: [PATCH] Add docs --- DifferentiationInterface/docs/make.jl | 1 + DifferentiationInterface/docs/src/tutorial.md | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/DifferentiationInterface/docs/make.jl b/DifferentiationInterface/docs/make.jl index a6ab5f722..163c8c1b6 100644 --- a/DifferentiationInterface/docs/make.jl +++ b/DifferentiationInterface/docs/make.jl @@ -22,6 +22,7 @@ using Zygote: Zygote links = InterLinks( "ADTypes" => "https://sciml.github.io/ADTypes.jl/stable/", "SparseConnectivityTracer" => "https://adrianhill.de/SparseConnectivityTracer.jl/stable/", + "SparseMatrixColorings" => "https://gdalle.github.io/SparseMatrixColorings.jl/stable/", ) cp(joinpath(@__DIR__, "..", "README.md"), joinpath(@__DIR__, "src", "index.md"); force=true) diff --git a/DifferentiationInterface/docs/src/tutorial.md b/DifferentiationInterface/docs/src/tutorial.md index 561a572a7..21688d11e 100644 --- a/DifferentiationInterface/docs/src/tutorial.md +++ b/DifferentiationInterface/docs/src/tutorial.md @@ -148,13 +148,14 @@ To compute sparse Jacobians or Hessians, you need three ingredients (read [this - [`TracerSparsityDetector`](@extref SparseConnectivityTracer.TracerSparsityDetector), implemented by [SparseConnectivityTracer.jl](https://github.com/adrhill/SparseConnectivityTracer.jl) (our default recommendation) - [`SymbolicsSparsityDetector`](@ref DifferentiationInterface.SymbolicsSparsityDetector), implemented by DifferentiationInterface.jl with [Symbolics.jl](https://github.com/JuliaSymbolics/Symbolics.jl) but not exported nor part of the public API (it will soon be [transferred](https://github.com/JuliaSymbolics/Symbolics.jl/pull/1134)) 3. A coloring algorithm like: - - [`GreedyColoringAlgorithm`](@ref), implemented by DifferentiationInterface.jl + - [`GreedyColoringAlgorithm`](@extref SparseMatrixColorings), implemented by [SparseMatrixColorings.jl](https://github.com/gdalle/SparseMatrixColorings.jl) and re-exported by DifferentiationInterface.jl ADTypes.jl v1.0 provides the [`AutoSparse`](@extref ADTypes.AutoSparse) wrapper to combine these three ingredients, and DifferentiationInterface.jl re-exports it. Here's an example: ```@example tuto -using SparseConnectivityTracer +using SparseConnectivityTracer: TracerSparsityDetector +using SparseMatrixColorings: GreedyColoringAlgorithm dense_backend = AutoForwardDiff()