Skip to content

Commit e0ec04e

Browse files
committed
update readme
1 parent 3bf44cf commit e0ec04e

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,13 @@
55
| [![Build status](https://github.com/alan-turing-institute/StatTraits.jl/workflows/CI/badge.svg)](https://github.com/alan-turing-institute/StatTraits.jl/actions)| [![codecov.io](http://codecov.io/github/alan-turing-institute/StatTraits.jl/coverage.svg?branch=master)](http://codecov.io/github/alan-turing-institute/StatTraits.jl?branch=master) |
66

77
A light-weight package defining fall-back implementations for a
8-
collection of "traits" possessed by statistical objects. Here are two
9-
examples, which apply to both statistical models and loss functions:
8+
collection of traits possessed by statistical objects. Here a "trait"
9+
is a function with a single argument that is a julia type, which might
10+
encode type metadata for inspection, or for use in function
11+
dispatch.
12+
13+
Here are two examples, which might be applies to both statistical
14+
model types and loss function types:
1015

1116
```julia
1217
target_scitype(::Type) = Unknown
@@ -17,7 +22,7 @@ Here `Unknown` is a type defined in the light-weight package
1722
[`ScientificTypes.jl`](https://github.com/alan-turing-institute/ScientificTypes.jl),
1823
the only dependency of StatsTraits.jl.
1924

20-
Refer to [source code](src/StatTraits.jl) for a complete list.
25+
Refer to [source code](src/StatisticalTraits.jl) for a complete list.
2126

2227
The traits defined here are overloaded by assorted model types and
2328
measure types in the

0 commit comments

Comments
 (0)