add docstrings

baggepinnen · Nov 4, 2023 · c472329 · c472329
1 parent 11e312a
commit c472329
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/src/utils.jl b/src/utils.jl
@@ -62,8 +62,25 @@ function Base.oftype(x::Number, y::AbstractArray)
     y[]
 end
 
+"""
+    rms(x)
+  
+Root mean square of `x`.
+"""
 rms(x::AbstractVector) = sqrt(mean(abs2, x))
+
+"""
+    sse(x)
+
+Sum of squares of `x`.
+"""
 sse(x::AbstractVector) = x ⋅ x
+
+"""
+    mse(x)
+
+Mean square of `x`.
+"""
 mse(x::AbstractVector) = sse(x) / length(x)
 mse(x::AbstractMatrix) = sum(abs2, x, dims=2) ./ size(x, 2)