Skip to content

Fix doc links and Base.Docs.doc issue #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
with:
version: ${{ matrix.version }}
arch: ${{ matrix.arch }}
- uses: actions/cache@v1
- uses: julia-actions/cache@v1
env:
cache-name: cache-artifacts
with:
Expand Down Expand Up @@ -63,4 +63,4 @@ jobs:
using Documenter: DocMeta, doctest
using MLJModelInterface
DocMeta.setdocmeta!(MLJModelInterface, :DocTestSetup, :(using MLJModelInterface); recursive=true)
doctest(MLJModelInterface)'
doctest(MLJModelInterface)'
2 changes: 2 additions & 0 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ authors = ["Thibaut Lienart and Anthony Blaom"]
version = "1.11.0"

[deps]
REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
ScientificTypesBase = "30f210dd-8aff-4c5f-94ba-8e64358c1161"
StatisticalTraits = "64bff920-2084-43da-a3e6-9bb72801c0c9"
Expand All @@ -16,6 +17,7 @@ Distances = "0.10"
InteractiveUtils = "<0.0.1, 1"
Markdown = "<0.0.1, 1"
OrderedCollections = "1"
REPL = "<0.0.1, 1"
Random = "<0.0.1, 1"
ScientificTypes = "3"
ScientificTypesBase = "3"
Expand Down
1 change: 1 addition & 0 deletions src/MLJModelInterface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ const ABSTRACT_MODEL_SUBTYPES = [
using ScientificTypesBase
using StatisticalTraits
using Random
using REPL # apparently needed to get Base.Docs.doc to work

import StatisticalTraits: info

Expand Down
2 changes: 1 addition & 1 deletion src/metadata_utils.jl
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ depwarn_docstring(T) =
Regarding $T: `metadata_model` should not be called with the keyword argument `descr`
or `docstring`. Implementers of the MLJ model interface should instead create an
MLJ-compliant docstring in the usual way. See
https://alan-turing-institute.github.io/MLJ.jl/dev/adding_models_for_general_use/#Document-strings
https://juliaai.github.io/MLJ.jl/dev/adding_models_for_general_use/#Document-strings
for details.

"""
Expand Down
4 changes: 2 additions & 2 deletions src/model_api.jl
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The following trait overload is also required:
training_losses(model, report) = nothing

# to support online learning in the future:
# https://github.com/alan-turing-institute/MLJ.jl/issues/60 :
# https://github.com/JuliaAI/MLJ.jl/issues/60 :
function update_data end

"""
Expand All @@ -67,7 +67,7 @@ the model-specific representations of the data.

To implement the `reformat` data front-end for a model, refer to
"Implementing a data front-end" in the [MLJ
manual](https://alan-turing-institute.github.io/MLJ.jl/dev/adding_models_for_general_use/).
manual](https://juliaai.github.io/MLJ.jl/dev/adding_models_for_general_use/).


"""
Expand Down
Loading