Tangent Interface Docs

[willtebbutt]

@Jollywatt per our discussion elsewhere, here is a stab at aggregating all of the information that I have about the tangent interface into a single location. When you get a minute, could you let me know if this is the kind of thing that you need to do what you wanted to do, or if there's additional info that you'll need?

[codecov]

Codecov Report

Attention: Patch coverage is 88.46154% with 3 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/test_utils.jl	91.66%	2 Missing ⚠️
src/tangents.jl	50.00%	1 Missing ⚠️

Files with missing lines	Coverage Δ
src/fwds_rvs_data.jl	96.66% <ø> (ø)
src/tangents.jl	84.92% <50.00%> (-0.31%)	⬇️
src/test_utils.jl	93.06% <91.66%> (-0.04%)	⬇️

[github-actions]

Performance Ratio:
Ratio of time to compute gradient and time to compute function.
Warning: results are very approximate! See here for more context.

┌────────────────────────────┬──────────┬─────────┬─────────────┬─────────┐
│                      Label │ Mooncake │  Zygote │ ReverseDiff │  Enzyme │
│                     String │   String │  String │      String │  String │
├────────────────────────────┼──────────┼─────────┼─────────────┼─────────┤
│                   sum_1000 │     84.8 │     1.0 │        5.61 │    8.21 │
│                  _sum_1000 │      6.6 │  1380.0 │        34.4 │    1.09 │
│               sum_sin_1000 │     2.29 │    1.68 │        10.8 │    1.96 │
│              _sum_sin_1000 │     2.71 │   255.0 │        13.6 │    2.44 │
│                   kron_sum │     62.0 │    3.55 │       232.0 │    8.44 │
│              kron_view_sum │     21.3 │    3.32 │        80.8 │    34.0 │
│      naive_map_sin_cos_exp │      2.6 │ missing │        7.63 │    2.35 │
│            map_sin_cos_exp │     2.72 │    1.44 │        6.01 │    2.94 │
│      broadcast_sin_cos_exp │     2.59 │    2.23 │        1.46 │    2.24 │
│                 simple_mlp │     4.78 │    3.25 │        6.45 │     3.3 │
│                     gp_lml │     13.2 │    6.55 │     missing │     6.2 │
│ turing_broadcast_benchmark │     3.22 │ missing │        25.2 │ missing │
│         large_single_block │     4.42 │  4380.0 │        30.6 │    2.18 │
└────────────────────────────┴──────────┴─────────┴─────────────┴─────────┘