Skip to content

Commit 6c9660b

Browse files
Apply suggestions from code review
Co-authored-by: Nick Robinson <npr251@gmail.com>
1 parent 1dd9345 commit 6c9660b

3 files changed

Lines changed: 5 additions & 6 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@
1212
[![](https://img.shields.io/badge/docs-master-blue.svg)](https://juliadiff.org/ChainRulesOverloadGeneration.jl/dev)
1313
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliadiff.org/ChainRulesOverloadGeneration.jl/stable)
1414

15-
The ChainRulesOverloadGeneration package provides a suite of methods for using [ChainRulesCore.jl](https://github.com/JuliaDiff/ChainRulesCore.jl) rules in operator overloaded based AD systems.
15+
The ChainRulesOverloadGeneration package provides a suite of methods for using [ChainRulesCore.jl](https://github.com/JuliaDiff/ChainRulesCore.jl) rules in operator overloading AD systems.
1616
It tracks what rules are defined at any point in time, and lets you trigger functions to which can use `@eval` in order to define the matching operator overloads.

docs/src/examples/forward_mode.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ForwardDiffZero
22
This is a fairly standard operator overloading-based forward mode AD system.
3-
It defines a `Dual` part which holds both the primal value, paired with the partial deriviative.
3+
It defines a `Dual` part which holds both the primal value, paired with the partial derivative.
44
It doesn't handle chunked-mode, or perturbation confusion.
55
The overload generation hook in this example is: `define_dual_overload`.
66

@@ -12,4 +12,3 @@ $(read(joinpath(@__DIR__,"../../../test/demos/forwarddiffzero.jl"), String))
1212
```
1313
""")
1414
````
15-

docs/src/examples/reverse_mode.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
21
# ReverseDiffZero
2+
33
This is a fairly standard operator overloading based reverse mode AD system.
4-
It defines a `Tracked` type which carries the primal value as well as a reference to the tape which is it using, a partially accumulated partial derivative and a `propagate` function that propagates it's partial back to its input.
5-
A perhaps unusual thing about it is how little it carries around it's creating operator's inputs.
4+
It defines a `Tracked` type which carries the primal value as well as a reference to the tape which is it using, a partially accumulated partial derivative and a `propagate` function that propagates its partial back to its input.
5+
A perhaps unusual thing about it is how little it carries around its creating operator's inputs.
66
That information is all entirely wrapped up in the `propagate` function.
77
The overload generation hook in this example is: `define_tracked_overload`.
88

0 commit comments

Comments
 (0)