Skip to content

Commit 35823b4

Browse files
committed
doc tweaks
1 parent 2dd5d9c commit 35823b4

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ Wrappers provided in this package extend the functionality of such measures. For
2727

2828
```julia
2929
using StatisticalMeasuresBase
30-
L1 = multimeasure(supports_missings_measure(l1))
31-
y = [1, 2, missing]
32-
= [2, 3, 4]
33-
weights = [8, 7, 6]
30+
L1 = multimeasure(supports_missings_measure(l1), mode=Sum())
31+
y = [5, 6, missing]
32+
= [6, 8, 7]
33+
weights = [1, 3, 9]
3434

35-
julia> L1(ŷ, y, weights)
36-
5.0
35+
julia> L1(ŷ, y, weights) 1*abs(6 - 5) + 3*abs(8 - 6)
36+
true
3737
```
3838

3939
```julia

docs/src/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ A Julia package for building production-ready measures (metrics) for statistics
1313
Here's an example of a simple statistical measure, applied to a pair of scalars:
1414

1515
```@example 01
16-
l1(ŷ, y) = abs(ŷ - y)
16+
l1(ŷ, y) = abs(ŷ - y)
1717
y = 5 # ground truth
1818
ŷ = 2 # prediction
1919
l1(ŷ, y)
@@ -23,11 +23,11 @@ Wrappers provided in this package extend the functionality of such measures. For
2323

2424
```@example 01
2525
using StatisticalMeasuresBase
26-
L1 = multimeasure(supports_missings_measure(l1))
27-
y = [1, 2, missing]
28-
ŷ = [2, 3, 4]
29-
weights = [8, 7, 6]
30-
L1(ŷ, y, weights)
26+
L1 = multimeasure(supports_missings_measure(l1), mode=Sum())
27+
y = [5, 6, missing]
28+
ŷ = [6, 8, 7]
29+
weights = [1, 3, 9]
30+
L1(ŷ, y, weights) ≈ 1*abs(6 - 5) + 3*abs(8 - 6)
3131
```
3232

3333
```@example 01

0 commit comments

Comments
 (0)