Skip to content

Commit eb1ab08

Browse files
committed
tweak doc-strings for api
1 parent 742ded7 commit eb1ab08

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/model_api.jl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
fit(model, verbosity, data...) -> fitresult, cache, report
2+
MLJModelInterface.fit(model, verbosity, data...) -> fitresult, cache, report
33
44
All models must implement a `fit` method. Here `data` is the
55
output of `reformat` on user-provided data, or some some resampling
@@ -16,7 +16,7 @@ fit(::Static, ::Integer, data...) = (nothing, nothing, nothing)
1616
fit(m::Supervised, verbosity, X, y, w) = fit(m, verbosity, X, y)
1717

1818
"""
19-
update(model, verbosity, fitresult, cache, data...)
19+
MLJModelInterface.update(model, verbosity, fitresult, cache, data...)
2020
2121
Models may optionally implement an `update` method. The fallback calls
2222
`fit`.
@@ -26,10 +26,10 @@ update(m::Model, verbosity, fitresult, cache, data...) =
2626
fit(m, verbosity, data...)
2727

2828
"""
29-
training_losses(model::M, fitresult, cache)
29+
MLJModelInterface.training_losses(model::M, fitresult, cache)
3030
3131
If `M` is an iterative model type which calculates training losses,
32-
implement this method to return the an `AbstractVector` of the losses
32+
implement this method to return an `AbstractVector` of the losses
3333
in historical order. If the model calculates scores instead, then the
3434
sign of the scores should be reversed.
3535
@@ -64,7 +64,7 @@ manual](https://alan-turing-institute.github.io/MLJ.jl/dev/adding_models_for_gen
6464
reformat(model::Model, args...) = args
6565

6666
"""
67-
selectrows(::Model, I, data...) -> sampled_data
67+
MLJModelInterface.selectrows(::Model, I, data...) -> sampled_data
6868
6969
A model overloads `selectrows` whenever it buys into the optional
7070
`reformat` front-end for data preprocessing. See [`reformat`](@ref)

0 commit comments

Comments
 (0)