Update docs

Author: hshindo

docs/make.jl

@@ -8,11 +8,12 @@ makedocs(
     sitename = "Merlin.jl",
     pages = [
         "Home" => "index.md",
+        "Var" => "var.md",
         "Functions" => "functions.md",
+        "Graph" => "graph.md",
         "Initializaters" => "initializers.md",
-        #"Graph" => "graph.md",
-        #"Optimizers" => "optimizers.md",
-        #"Save and Load" => "save_load.md",
+        "Optimizers" => "optimizers.md",
+        "Save and Load" => "save_load.md",
     ]
 )
 

docs/src/graph.md

@@ -1,2 +1,23 @@
 # Graph
-`Graph` is a type of computational graph.
+`Graph` represents a computational graph.
+
+```julia
+using Merlin
+
+T = Float32
+x = Node()
+y = Linear(T,10,7)(x)
+y = relu(y)
+y = Linear(T,7,3)(y)
+@assert typeof(y) == Node
+g = Graph(input=x, output=y)
+
+x = zerograd(rand(T,10,10))
+y = g(x)
+
+params = gradient!(y)
+println(x.grad)
+
+opt = SGD(0.01)
+foreach(opt, params)
+```

docs/src/initializers.md

@@ -10,15 +10,3 @@ Normal
 Xavier
 Orthogonal
 ```
-
-## Custom Initializer
-```julia
-import Merlin.random
-
-struct CustomRand
-end
-
-function random{T}(init, ::Type{T}, dims...)
-    # code
-end
-```

docs/src/optimizers.md

@@ -1,13 +1,9 @@
 # Optimizers
 
-A Optimizer provides functions for updating parameters.
-
-For example,
 ```julia
-x1 = Var(rand(Float32,5,4))
-x1.grad = rand(Float32,5,4)
+x = zerograd(rand(Float32,5,4))
 opt = SGD(0.001)
-opt(x1.data, x1.grad)
+opt(x)
 ```
 
 ```@docs

docs/src/overview.md

@@ -1,34 +1,2 @@
 # Save and Load
-`Merlin` supports saving and loading objects in HDF5 format.
-* For saving objects provided by Merlin, use `Merlin.save` and `Merlin.load` functions.
-* For other complex objects, it is recommended to use `JLD.save` and `JLD.load` functions provided by [JLD.jl](https://github.com/JuliaIO/JLD.jl).
-
-```@docs
-Merlin.save
-Merlin.load
-```
-
-For example,
-```julia
-x = Embeddings(Float32,10000,100)
-Merlin.save("embedding.h5", "w", "x", x)
-```
-
-A graph structure can be saved as well:
-```julia
-T = Float32
-x = Var()
-y = Linear(T,10,7)(x)
-y = relu(y)
-y = Linear(T,7,3)(y)
-g = Graph(y, x)
-Merlin.save("graph.h5", "g", g)
-```
-
-The saved HDF5 file is as follows:
-
-![graph.h5](https://raw.githubusercontent.com/hshindo/Merlin.jl/master/docs/src/assets/graph.h5.png)
-
-## Custom Serialization
-It requires to implement `h5convert` function for custom serialization/deserialization.
-See Merlin sources for details.
+It is recommended to use [JLD2](https://github.com/simonster/JLD2.jl) for object serialization.

docs/src/save_load.md

@@ -1,4 +1,4 @@
-# Variable
+# Var
 
 ```@autodocs
 Pages   = ["var.jl"]