File tree 2 files changed +4
-4
lines changed
2 files changed +4
-4
lines changed Original file line number Diff line number Diff line change @@ -103,7 +103,7 @@ and suitable for accumulating against.
103
103
For types without a tangent space (e.g. singleton structs) this returns `NoTangent()`.
104
104
In general, it is more likely to produce a structural tangent.
105
105
106
- !!! warning Exprimental
106
+ !!! warning " Exprimental"
107
107
`zero_tangent`is an experimental feature, and is part of the mutation support featureset.
108
108
While this notice remains it may have changes in behavour, and interface in any _minor_ version of ChainRulesCore.
109
109
Exactly how it should be used (e.g. is it forward-mode only?)
Original file line number Diff line number Diff line change 4
4
Representing the type of the tangent of a `struct` `P` (or a `Tuple`/`NamedTuple`).
5
5
as an object with mirroring fields.
6
6
7
- !!!!!! warning Exprimental
7
+ !!! warning " Exprimental"
8
8
`StructuralTangent` is an experimental feature, and is part of the mutation support featureset.
9
9
The `StructuralTangent` constructor returns a `MutableTangent` for mutable structs.
10
10
`MutableTangent` is an experimental feature.
60
60
This type represents the tangent to a mutable struct.
61
61
It itself is also mutable.
62
62
63
- !!! warning Exprimental
63
+ !!! warning " Exprimental"
64
64
MutableTangent is an experimental feature, and is part of the mutation support featureset.
65
65
While this notice remains it may have changes in behavour, and interface in any _minor_ version of ChainRulesCore.
66
66
Exactly how it should be used (e.g. is it forward-mode only?)
67
67
68
- !!! warning Do not directly mess with the tangent backing data
68
+ !!! warning " Do not directly mess with the tangent backing data"
69
69
It is relatively straight forward for a forwards-mode AD to work correctly in the presence of mutation and aliasing of primal values.
70
70
However, this requires that the tangent is aliased in turn and conversely that it is copied when the primal is).
71
71
If you seperately alias the backing data, etc by using the internal `ChainRulesCore.backing` function you can break this.
You can’t perform that action at this time.
0 commit comments