Skip to content

[Docs] [AutoDiff] Allow implicitly inherited '@differentiable' on non-public protocol req impls. #29307

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

Merged
merged 1 commit into from
Jan 19, 2020
Merged

[Docs] [AutoDiff] Allow implicitly inherited '@differentiable' on non-public protocol req impls. #29307

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 7 additions & 6 deletions docs/DifferentiableProgramming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1376,11 +1376,12 @@ inheritance must maintain the differentiability.

The `@differentiable` attribute can be used on protocol requirements. A
`@differentiable` protocol requirement requires that all conforming types
implement this protocol requirement with a differentiable body with respect to
the specified parameters.
implement this requirement with a differentiable body with respect to the
specified parameters. Conforming implementations are not required to be marked
with `@differentiable` attribute unless they are `public`.

```swift
protocol Layer: Differentiable {
public protocol Layer: Differentiable {
associatedtype Input: Differentiable
associatedtype Output: Differentiable
@differentiable // w.r.t. `input` and `self`
Expand All @@ -1389,7 +1390,7 @@ protocol Layer: Differentiable {
struct Perceptron: @memberwise Differentiable, Layer {
var weight: SIMD4<Float>
var bias: Float
@differentiable // w.r.t. `input` and `self`

func callAsFunction(_ input: SIMD4<Float>) -> Float {
(weight * input).sum() + b
}
Expand All @@ -1401,14 +1402,14 @@ with a `@differentiable` attribute that declares differentiability with respect
to more parameters.

```swift
protocol Module: Differentiable {
public protocol Module: Differentiable {
associatedtype Input
associatedtype Output: Differentiable
@differentiable(wrt: self)
func callAsFunction(_: Input) -> Output
}

protocol Layer: Module where Input: Differentiable {
public protocol Layer: Module where Input: Differentiable {
@differentiable(wrt: (self, input))
func callAsFunction(_: Input) -> Output
}
Expand Down