Skip to content

Commit

Permalink
fix bad urls
Browse files Browse the repository at this point in the history
  • Loading branch information
ablaom committed Nov 23, 2024
1 parent 105d7ff commit 07c815e
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const REPO = Remotes.GitHub("JuliaAI", "LearnAPI.jl")
makedocs(
modules=[LearnAPI,],
format=Documenter.HTML(
prettyurls = get(ENV, "CI", nothing) == "true",
prettyurls = true,#get(ENV, "CI", nothing) == "true",
collapselevel = 1,
),
pages=[
Expand Down
10 changes: 4 additions & 6 deletions docs/src/anatomy_of_an_implementation.md
Original file line number Diff line number Diff line change
Expand Up @@ -366,8 +366,8 @@ An implementation may optionally implement [`obs`](@ref), to expose to the user
meta-algorithm like cross-validation) the representation of input data internal to `fit`
or `predict`, such as the matrix version `A` of `X` in the ridge example. That is, we may
factor out of `fit` (and also `predict`) the data pre-processing step, `obs`, to expose
its outcomes. These outcomes become alternative user inputs to `fit`. To see the use of
`obs` in action, see [below](@ref advanced_demo).
its outcomes. These outcomes become alternative user inputs to `fit`/`predict`. To see the
use of `obs` in action, see [below](@ref advanced_demo).

Here we specifically wrap all the pre-processed data into single object, for which we
introduce a new type:
Expand Down Expand Up @@ -536,7 +536,5 @@ declaration.
³ The last index must be the observation index.

⁴ The `data = (X, y)` pattern implemented here is not the only supported pattern. For,
example, `data` might be a single table containing both features and target variable. In
this case, it will be necessary to overload [`LearnAPI.features`](@ref) in addition to
[`LearnAPI.target`](@ref); the name of the target column would need to be a
hyperparameter.
example, `data` might be `(T, formula)` where `T` is a table and `formula` is an R-style
formula.
2 changes: 1 addition & 1 deletion docs/src/fit_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ clustering algorithms); there is no training data and the algorithm is executed
```
update(model, data; verbosity=..., param1=new_value1, param2=new_value2, ...) -> updated_model
update_observations(model, new_data; verbosity=..., param1=new_value1, ...) -> updated_model
update_features(model, new_data; verbosity=1, param1=new_value1, ...) -> updated_model
update_features(model, new_data; verbosity=..., param1=new_value1, ...) -> updated_model
```

## Typical workflows
Expand Down
6 changes: 3 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
<script async defer src="https://buttons.github.io/buttons.js"></script>
<div style="font-size:1.4em;font-weight:bold;">
<a href="anatomy_of_an_implementation.html"
<a href="anatomy_of_an_implementation"
style="color: #389826;">Tutorial</a> &nbsp;|&nbsp;
<a href="reference.html"
<a href="reference"
style="color: #9558B2;">Reference</a> &nbsp;|&nbsp;
<a href="common_implementation_patterns.html"
<a href="common_implementation_patterns"
style="color: #9558B2;">Patterns</a>
</div>
Expand Down

0 comments on commit 07c815e

Please sign in to comment.