Skip to content

Commit

Permalink
In list of measures, link each measure to a doc-string
Browse files Browse the repository at this point in the history
  • Loading branch information
ablaom committed Jun 28, 2021
1 parent dcd8821 commit 02e8b16
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/src/performance_measures.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ log_loss(ŷ, y)
```

The measures `rms`, `l2` and `log_loss` illustrated here are actually
instances of measure *types*. For, example, `l2 = LPLoss(p=2)` and
instances of measure *types*. For, example, `l2 = LPLoss(p=2)` and
`log_loss = LogLoss() = LogLoss(tol=eps())`. Common aliases are
provided:

Expand Down Expand Up @@ -152,13 +152,19 @@ predictions.

## List of measures

All measures listed below have a doc-string associated with the measure's
*type*. So do, for example, `?LPLoss`, and not `?l2`.

```@setup losses_and_scores
using DataFrames
```

```@example losses_and_scores
ms = measures()
types = map(ms) do m m.name end
types = map(ms) do m
name = m.name
"[`$name`](@ref)"
end
instance = map(ms) do m m.instances end
t = (type=types, instances=instance)
DataFrame(t)
Expand Down

0 comments on commit 02e8b16

Please sign in to comment.