Merge pull request #6 from JuliaAI/dev

Minor doc tweak. No new release

Author: ablaom

README.md

@@ -7,7 +7,7 @@ A Julia package for building production-ready measures (metrics) for statistics
 [![Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaai.github.io/StatisticalMeasuresBase.jl/dev/)
 
 Related:
-[StatisticalMeasures.jl](https://github.com/JuliaAI/StatisticalMeasuresBase.jl/actions).
+[StatisticalMeasures.jl](https://github.com/JuliaAI/StatisticalMeasures.jl).
 
 
 ## The main idea 
@@ -27,13 +27,13 @@ Wrappers provided in this package extend the functionality of such measures. For
 
 ```julia
 using StatisticalMeasuresBase
-L1 = multimeasure(supports_missings_measure(l1))
-y = [1, 2, missing]
-ŷ = [2, 3, 4]
-weights = [8, 7, 6]
+L1 = multimeasure(supports_missings_measure(l1), mode=Sum())
+y = [5, 6, missing]
+ŷ = [6, 8, 7]
+weights = [1, 3, 9]
 
-julia> L1(ŷ, y, weights)
-5.0
+julia> L1(ŷ, y, weights) ≈ 1*l1(6, 5) + 3*l1(8, 6)
+true
 ```
 
 ```julia

docs/src/index.md

@@ -13,7 +13,7 @@ A Julia package for building production-ready measures (metrics) for statistics
 Here's an example of a simple statistical measure, applied to a pair of scalars:
 
 ```@example 01
-l1(ŷ, y) = abs(ŷ - y) 
+l1(ŷ, y) = abs(ŷ - y)
 y = 5 # ground truth
 ŷ = 2 # prediction
 l1(ŷ, y)
@@ -23,11 +23,11 @@ Wrappers provided in this package extend the functionality of such measures. For
 
 ```@example 01
 using StatisticalMeasuresBase
-L1 = multimeasure(supports_missings_measure(l1))
-y = [1, 2, missing]
-ŷ = [2, 3, 4]
-weights = [8, 7, 6]
-L1(ŷ, y, weights)
+L1 = multimeasure(supports_missings_measure(l1), mode=Sum())
+y = [5, 6, missing]
+ŷ = [6, 8, 7]
+weights = [1, 3, 9]
+L1(ŷ, y, weights) ≈ 1*l1(6, 5) + 3*l1(8, 6)
 ```
 
 ```@example 01