Skip to content

Commit a3ece5c

Browse files
committed
typo
1 parent aabdfa5 commit a3ece5c

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed

docs/src/anatomy_of_an_implementation.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,19 @@ A transformer ordinarily implements `transform` instead of
1212

1313
New implementations of `fit`, `predict`, etc,
1414
always have a *single* `data` argument, as in
15-
`LearnAPI.fit(algorithm, data; verbosity=1) = ...`.
15+
`LearnAPI.fit(algorithm, data; verbosity=1) = ...`.
1616
For convenience, user-calls, such as `fit(algorithm, X, y)`, automatically fallback
17-
to `fit(algorithm, (X, y))`.
17+
to `fit(algorithm, (X, y))`.
1818

1919
!!! note
2020

21-
By default, it is assumed that `data` supports the [`LearnAPI.RandomAccess`](@ref)
22-
interface; this includes all matrices, with observations-as-columns, most tables, and
23-
tuples thereof. See [`LearnAPI.RandomAccess`](@ref) for details. If this is not the
24-
case then an implementation must either:
25-
2621
If the `data` object consumed by `fit`, `predict`, or `transform` is not
2722
not a suitable table¹, array³, tuple of tables and arrays, or some
2823
other object implementing
2924
the MLUtils.jl `getobs`/`numobs` interface,
3025
then an implementation must: (i) overload [`obs`](@ref) to articulate how
3126
provided data can be transformed into a form that does support
32-
it, as illustrated below under
27+
this interface, as illustrated below under
3328
[Providing an advanced data interface](@ref); or (ii) overload the trait
3429
[`LearnAPI.data_interface`](@ref) to specify a more relaxed data
3530
API.

0 commit comments

Comments
 (0)