From b8b4bc48b94b9faeddc3afef8c2d2b057079bb97 Mon Sep 17 00:00:00 2001
From: Katharine Hyatt <khyatt@flatironinstitute.org>
Date: Mon, 21 Oct 2019 10:31:44 -0400
Subject: [PATCH] Backticks and examples for normalise

---
 src/layers/stateless.jl | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/src/layers/stateless.jl b/src/layers/stateless.jl
index 4c216672..ff1cbc39 100644
--- a/src/layers/stateless.jl
+++ b/src/layers/stateless.jl
@@ -42,7 +42,25 @@ logitbinarycrossentropy(logŷ, y) = (1 - y)*logŷ - logσ(logŷ)
 """
     normalise(x::AbstractArray; dims=1)
 
-    Normalises x to mean 0 and standard deviation 1, across the dimensions given by dims. Defaults to normalising over columns.
+Normalises `x` to mean 0 and standard deviation 1, across the dimensions given by `dims`. Defaults to normalising over columns.
+
+    julia> a = reshape(collect(1:9), 3, 3)
+    3×3 Array{Int64,2}:
+     1  4  7
+     2  5  8
+     3  6  9
+
+    julia> normalise(a)
+    3×3 Array{Float64,2}:
+     -1.22474  -1.22474  -1.22474
+      0.0       0.0       0.0
+      1.22474   1.22474   1.22474
+
+    julia> normalise(a, dims=2)
+    3×3 Array{Float64,2}:
+     -1.22474  0.0  1.22474
+     -1.22474  0.0  1.22474
+     -1.22474  0.0  1.22474
 """
 function normalise(x::AbstractArray; dims=1)
   μ′ = mean(x, dims = dims)