Skip to content

Commit e170e2e

Browse files
committed
add "Goals" section to landing page of docs
1 parent f086be7 commit e170e2e

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

docs/src/index.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,29 @@
44
LearnAPI.jl</span>
55
<br>
66
<span style="color: #9558B2;font-size:1.6em;font-style:italic;">
7-
A basic Julia interface for training and applying machine learning models </span>
7+
A basement-level Julia interface for training and applying machine learning models </span>
88
<br><br>
99
```
1010

11+
## Goals
12+
13+
- Ease of implementation for existing machine learning algorithms
14+
15+
- Applicability to a large variety of algorithms
16+
17+
- Provision of clear interface points for model-generic tooling, such as performance
18+
evaluation through resampling, hyperparameter optimization, and iterative model control.
19+
20+
- Should be data container agnostic
21+
22+
- Should be documented in detail
23+
24+
It is *not* a design goal of LearnAPI.jl to provide a convenient interface for the general
25+
user to directly interact with ML models.
26+
1127
## Quick tours
1228

13-
- To see how to **USE** models implementing LearnAPI: [Basic fit/predict
29+
- To see how to **INTERACT WITH** models implementing LearnAPI: [Basic fit/predict
1430
workflow](@ref workflow).
1531

1632
- For developers wanting to **IMPLEMENT** LearnAPI: [Anatomy of

0 commit comments

Comments
 (0)