Skip to content

Commit 28ac859

Browse files
committed
doc tweak
1 parent 01245ba commit 28ac859

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

docs/src/common_implementation_patterns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Common Implementation Patterns
1+
# [Common Implementation Patterns](@id patterns)
22

33
!!! important
44

docs/src/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ A base Julia interface for machine learning and statistics </span>
1111

1212
LearnAPI.jl is a lightweight, functional-style interface, providing a collection of
1313
[methods](@ref Methods), such as `fit` and `predict`, to be implemented by algorithms from
14-
machine learning and statistics. Its careful design ensures algorithms implementing
15-
LearnAPI.jl can buy into functionality, such as external performance estimates,
16-
hyperparameter optimization and model composition, provided by ML/statistics toolboxes and
17-
other packages. LearnAPI.jl includes a number of Julia [traits](@ref traits) for promising
18-
specific behavior.
14+
machine learning and statistics, some examples of which are listed [here](@ref
15+
patterns). A careful design ensures algorithms implementing LearnAPI.jl can buy into
16+
functionality, such as external performance estimates, hyperparameter optimization and
17+
model composition, provided by ML/statistics toolboxes and other packages. LearnAPI.jl
18+
includes a number of Julia [traits](@ref traits) for promising specific behavior.
1919

2020
LearnAPI.jl's only dependency is the standard library `InteractiveUtils`.
2121

@@ -99,7 +99,7 @@ loaders reading images from disk).
9999

100100
- [Reference](@ref reference): official specification
101101

102-
- [Common Implementation Patterns](@ref): implementation suggestions for common,
102+
- [Common Implementation Patterns](@ref patterns): implementation suggestions for common,
103103
informally defined, algorithm types
104104

105105
- [Testing an Implementation](@ref)

docs/src/reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Here we give the definitive specification of the LearnAPI.jl interface. For informal
44
guides see [Anatomy of an Implementation](@ref) and [Common Implementation
5-
Patterns](@ref).
5+
Patterns](@ref patterns).
66

77

88
## [Important terms and concepts](@id scope)

0 commit comments

Comments
 (0)