Skip to content
This repository was archived by the owner on Jul 1, 2023. It is now read-only.

Add documentation to Sequential #653

Merged
merged 2 commits into from
Jan 31, 2020
Merged

Add documentation to Sequential #653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef13414
Add documentation to Sequential
rickwierenga Jan 29, 2020
556588d
Make changes requested in PR
rickwierenga Jan 29, 2020
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
32 changes: 31 additions & 1 deletion Sources/TensorFlow/Layers/Sequential.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,37 @@
// See the License for the specific language governing permissions and
// limitations under the License.

/// A layer that sequentially composes two other layers.
/// A layer that sequentially composes two or more other layers.
///
/// ### Examples: ###
///
/// - Build a simple 2-layer perceptron model for MNIST:
///
/// ````
/// let inputSize = 28 * 28
/// let hiddenSize = 300
/// var classifier = Sequential {
/// Dense<Float>(inputSize: inputSize, outputSize: hiddenSize, activation: relu)
/// Dense<Float>(inputSize: hiddenSize, outputSize: 3, activation: identity)
/// }
/// ````
///
/// - Build an autoencoder for MNIST:
///
/// ````
/// var autoencoder = Sequential {
/// // The encoder.
/// Dense<Float>(inputSize: 28 * 28, outputSize: 128, activation: relu)
/// Dense<Float>(inputSize: 128, outputSize: 64, activation: relu)
/// Dense<Float>(inputSize: 64, outputSize: 12, activation: relu)
/// Dense<Float>(inputSize: 12, outputSize: 3, activation: relu)
/// // The decoder.
/// Dense<Float>(inputSize: 3, outputSize: 12, activation: relu)
/// Dense<Float>(inputSize: 12, outputSize: 64, activation: relu)
/// Dense<Float>(inputSize: 64, outputSize: 128, activation: relu)
/// Dense<Float>(inputSize: 128, outputSize: imageHeight * imageWidth, activation: tanh)
/// }
/// ````
public struct Sequential<Layer1: Module, Layer2: Layer>: Module
where Layer1.Output == Layer2.Input,
Layer1.TangentVector.VectorSpaceScalar == Layer2.TangentVector.VectorSpaceScalar {
Expand Down
32 changes: 31 additions & 1 deletion Sources/TensorFlow/Layers/Sequential.swift.gyb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,37 @@
// See the License for the specific language governing permissions and
// limitations under the License.

/// A layer that sequentially composes two other layers.
/// A layer that sequentially composes two or more other layers.
///
/// ### Examples: ###
///
/// - Build a simple 2-layer perceptron model for MNIST:
///
/// ````
/// let inputSize = 28 * 28
/// let hiddenSize = 300
/// var classifier = Sequential {
/// Dense<Float>(inputSize: inputSize, outputSize: hiddenSize, activation: relu)
/// Dense<Float>(inputSize: hiddenSize, outputSize: 3, activation: identity)
/// }
/// ````
///
/// - Build an autoencoder for MNIST:
///
/// ````
/// var autoencoder = Sequential {
/// // The encoder.
/// Dense<Float>(inputSize: 28 * 28, outputSize: 128, activation: relu)
/// Dense<Float>(inputSize: 128, outputSize: 64, activation: relu)
/// Dense<Float>(inputSize: 64, outputSize: 12, activation: relu)
/// Dense<Float>(inputSize: 12, outputSize: 3, activation: relu)
/// // The decoder.
/// Dense<Float>(inputSize: 3, outputSize: 12, activation: relu)
/// Dense<Float>(inputSize: 12, outputSize: 64, activation: relu)
/// Dense<Float>(inputSize: 64, outputSize: 128, activation: relu)
/// Dense<Float>(inputSize: 128, outputSize: imageHeight * imageWidth, activation: tanh)
/// }
/// ````
public struct Sequential<Layer1: Module, Layer2: Layer>: Module
where Layer1.Output == Layer2.Input,
Layer1.TangentVector.VectorSpaceScalar == Layer2.TangentVector.VectorSpaceScalar {
Expand Down