Adding more docs to transforms

Author: theogf

docs/.gitignore

@@ -1,2 +1,5 @@
 build/
 site/
+src/assets/*.png
+
+#Temp to avoid to many changes

src/kernelmatrix.jl

@@ -114,12 +114,18 @@ function kerneldiagmatrix(
         end
 end
 
+"""
+```
+    kerneldiagmatrix!(K::AbstractVector,κ::Kernel, X::Matrix; obsdim::Int=2)
+```
+In place version of `kerneldiagmatrix`
+"""
 function kerneldiagmatrix!(
-        K::AbstractVector{T₁},
-        κ::Kernel{T},
-        X::AbstractMatrix{T₂};
+        K::AbstractVector,
+        κ::Kernel,
+        X::AbstractMatrix;
         obsdim::Int = defaultobs
-        ) where {T,T₁,T₂}
+        )
         if length(K) != size(X,obsdim)
             throw(DimensionMismatch("Dimensions of the target array K $(size(K)) are not consistent with X $(size(X))"))
         end

src/transform/functiontransform.jl

@@ -1,6 +1,9 @@
 """
     FunctionTransform
-
+```
+    f(x) = abs.(x)
+    tr = FunctionTransform(f)
+```
     Take a function `f` as an argument which is going to act on each vector individually.
     Make sure that `f` is supposed to act on a vector by eventually using broadcasting
     For example `f(x)=sin(x)` -> `f(x)=sin.(x)`

src/transform/lowranktransform.jl

@@ -1,3 +1,12 @@
+"""
+    LowRankTransform
+    ```
+        P = rand(10,5)
+        tr = LowRankTransform(P)
+    ```
+    Apply the low-rank projection realised by the matrix `P`
+    The second dimension of `P` must match the number of features of the target.
+"""
 struct LowRankTransform{T<:AbstractMatrix{<:Real}} <: Transform
     proj::T
 end

src/transform/scaletransform.jl

@@ -1,5 +1,13 @@
 """
     Scale Transform
+```
+    l = 2.0
+    tr = ScaleTransform(l)
+    v = rand(3)
+    tr = ScaleTransform(v)
+```
+    Multiply every element of the matrix by `l` for a scalar
+    Multiply every vector of observation by `v` element-wise for a vector
 """
 struct ScaleTransform{T<:Union{Real,AbstractVector{<:Real}}} <: Transform
     s::T

src/transform/transform.jl

@@ -7,6 +7,17 @@ include("scaletransform.jl")
 include("lowranktransform.jl")
 include("functiontransform.jl")
 
+
+"""
+    ChainTransform
+    ```
+        t1 = ScaleTransform()
+        t2 = LowRankTransform(rand(3,4))
+        ct = ChainTransform([t1,t2]) #t1 will be called first
+        ct == t2∘t1
+    ```
+    Chain a series of transform, here `t1` is called first
+"""
 struct ChainTransform <: Transform
     transforms::Vector{Transform}
 end
@@ -28,7 +39,11 @@ end
 Base.:∘(t₁::Transform,t₂::Transform) = ChainTransform([t₂,t₁])
 Base.:∘(t::Transform,tc::ChainTransform) = ChainTransform(vcat(tc.transforms,t))
 Base.:∘(tc::ChainTransform,t::Transform) = ChainTransform(vcat(t,tc.transforms))
+"""
+    IdentityTransform
 
+    Return exactly the input
+"""
 struct IdentityTransform <: Transform end
 
 transform(t::IdentityTransform,x::AbstractArray,obsdim::Int=defaultobs) = x