Skip to content

Commit 6e2d8c8

Browse files
committed
apply readme simplifications & other tweaks
1 parent 484de7b commit 6e2d8c8

File tree

3 files changed

+17
-29
lines changed

3 files changed

+17
-29
lines changed

README.md

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,40 +11,27 @@ Comprehensive documentation is [here](https://juliaai.github.io/LearnAPI.jl/dev/
1111

1212
New contributions welcome. See the [road map](ROADMAP.md).
1313

14-
## Code snippet
14+
## Synopsis
1515

16-
Configure a machine learning algorithm:
16+
Package provides for variations and elaborations on the following basic pattern in machine
17+
learning and statistics:
1718

1819
```julia
19-
julia> ridge = Ridge(lambda=0.1)
20+
model = fit(learner, data)
21+
predict(model, newdata)
2022
```
2123

22-
Inspect available functionality:
24+
Here `learner` specifies the configuration the algorithm (the hyperparameters) while
25+
`model` stores learned parameters and any byproducts of algorithm execution.
2326

24-
```
25-
julia> @functions ridge
26-
(fit, LearnAPI.learner, LearnAPI.strip, obs, LearnAPI.features, LearnAPI.target, predict, LearnAPI.coefficients)
27-
```
28-
29-
Train:
30-
31-
```julia
32-
julia> model = fit(ridge, data)
33-
```
27+
## Related packages
3428

35-
Predict:
29+
- [MLCore.jl](https://github.com/JuliaML/MLCore.jl) ([docs](https://juliaml.github.io/MLUtils.jl/stable/api/#Core-API))
3630

37-
```julia
38-
julia> predict(model, newdata)[1]
39-
"virginica"
40-
```
31+
- [LearnTestAPI.jl](https://github.com/JuliaAI/LearnTestAPI.jl): Package to test implementations of LearnAPI.jl (but documented here)
4132

42-
Predict a probability distribution ([proxy](https://juliaai.github.io/LearnAPI.jl/dev/kinds_of_target_proxy/#proxy_types) for the target):
33+
- [LearnDataFrontEnds.jl](https://github.com/JuliaAI/LearnDataFrontEnds.jl): for including flexible, user-friendly, data front ends for LearnAPI.jl implementations ([docs]((https://juliaai.github.io/stable/))
4334

44-
```julia
45-
julia> predict(model, Distribution(), newdata)[1]
46-
UnivariateFinite{Multiclass{3}}(setosa=>0.0, versicolor=>0.25, virginica=>0.75)
47-
```
4835

4936
## Credits
5037

docs/src/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
<div style="font-size:1.4em;font-weight:bold;">
55
<a href="anatomy_of_an_implementation"
66
style="color: #389826;">Tutorial</a> &nbsp;|&nbsp;
7-
<a href="reference"
8-
style="color: #9558B2;">Reference</a> &nbsp;|&nbsp;
97
<a href="common_implementation_patterns"
108
style="color: #9558B2;">Patterns</a>
9+
<a href="reference"
10+
style="color: #9558B2;">Reference</a> &nbsp;|&nbsp;
1111
</div>
1212
1313
<span style="color: #9558B2;font-size:4.5em;">
@@ -87,7 +87,7 @@ Algorithms are free to consume data in any format. However, a method called [`ob
8787
data_interface) (read as "observations") gives developers the option of providing a
8888
separate data front end for their algorithms. In this case `obs` gives users and
8989
meta-algorithms access to an algorithm-specific representation of input data, which is
90-
also guaranteed to implement a standard interface for accessing individual observations,
90+
additionally guaranteed to implement a standard interface for accessing individual observations,
9191
unless the algorithm explicitly opts out. Moreover, the `fit` and `predict` methods will
9292
also be able to consume these alternative data representations, for performance benefits
9393
in some situations.
@@ -99,8 +99,8 @@ then overloading `obs` is completely optional. Plain iteration interfaces, with
9999
knowledge of the number of observations, can also be specified, to support, e.g., data
100100
loaders reading images from disk.
101101

102-
Some canned data front ends are provided by the
103-
[LearnDataFrontEnds.jl](https://juliaai.github.io/LearnAPI.jl/stable/) package.
102+
Some canned data front ends (implementations of [`obs`](@ref)) are provided by the
103+
[LearnDataFrontEnds.jl](https://juliaai.github.io/LearnDataFrontEnds.jl/stable/) package.
104104

105105
## Learning more
106106

docs/src/testing_an_implementation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ LearnTestAPI.Selector
3838
LearnTestAPI.FancySelector
3939
LearnTestAPI.NormalEstimator
4040
LearnTestAPI.Ensemble
41+
LearnTestAPI.StumpRegressor
4142
```
4243

4344
## Private methods

0 commit comments

Comments
 (0)