Skip to content
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

Update the manual #1140

Merged
merged 4 commits into from
Sep 2, 2024
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
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ pages = [
"Learning Networks" => "learning_networks.md",
],
"Third Party Tools" => [
"Logging Workflows using MLflow" => "logging_workflows.md",
"Logging Workflows" => "logging_workflows.md",
"Third Party Packages" => "third_party_packages.md",
],
"Customization and Extension" => [
Expand Down
25 changes: 20 additions & 5 deletions docs/src/logging_workflows.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,28 @@
# Logging Workflows

## MLflow integration
Currently the following workflows can log their outcomes to an external machine learning
tracking platform, such as [MLflow](https://mlflow.org) (see [MLflow](@ref) below):

[MLflow](https://mlflow.org) is a popular, language-agnostic, tool for externally logging
the outcomes of machine learning experiments, including those carried out using MLJ.
- Estimating model performance using [`evaluate`](@ref)/[`evaluate!`](@ref).

- Model tuning, using the `TunedModel` wrapper, as described under [Tuning Models](@ref).

To enable logging one must create a `logger` object for the relevant tracking platform,
and either:

- Provide `logger` as an explicit keyword argument in the workflow, as in `evaluate(...;
logger=...)` or `TunedModel(...; logger=...)`; or

- Set a global default logger with the call [`default_logger(logger)`](@ref).

MLJ logging examples are given in the [MLJFlow.jl](https://github.com/JuliaAI/MLJFlow.jl)
documentation. MLJ includes and re-exports all the methods of MLJFlow.jl, so there is no
need to import MLJFlow.jl if `using MLJ`.
documentation.
x

### Supported tracking platforms

- [MLflow](@ref) (natively supported: MLJ re-exports `MLJFlow.Logger(...)`)


!!! warning

Expand Down
3 changes: 0 additions & 3 deletions docs/src/target_transformations.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,6 @@ X, y = @load_boston
evaluate(ridge3, X, y, measure=l1)
```

Without the log transform (ie, using `ridge`) we get the poorer mean absolute error,
`l1`, of 3.9.

```@docs
TransformedTargetModel
```
Loading