Skip to content

Commit

Permalink
fix docstring
Browse files Browse the repository at this point in the history
fix some more
  • Loading branch information
ablaom committed Jul 2, 2024
1 parent 370b3da commit ecb4322
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions src/resampling.jl
Original file line number Diff line number Diff line change
Expand Up @@ -752,15 +752,15 @@ Base.show(io::IO, e::CompactPerformanceEvaluation) =
## USER CONTROL OF DEFAULT LOGGING

const DOC_DEFAULT_LOGGER =
"""
"""
The default logger is used in calls to [`evaluate!`](@ref) and [`evaluate`](@ref), and
in the constructors `TunedModel` and `IteratedModel`, unless the `logger` keyword is
explicitly specified.
The default logger is used in calls to [`evaluate!`](@ref) and [`evaluate`](@ref), and
in the constructors `TunedModel` and `IteratedModel`, unless the `logger` keyword is
explicitly specified.
!!! note
!!! note
Prior to MLJ v0.20.7 (and MLJBase 1.5) the default logger was always `nothing`.
Prior to MLJ v0.20.7 (and MLJBase 1.5) the default logger was always `nothing`.
"""

Expand All @@ -772,8 +772,7 @@ tracking platforms, such as [MLflow](https://mlflow.org/docs/latest/index.html).
$DOC_DEFAULT_LOGGER
When MLJBase is first loaded, the default logger is `nothing`. To reset the logger, see
beow.
When MLJBase is first loaded, the default logger is `nothing`.
"""
default_logger() = DEFAULT_LOGGER[]
Expand All @@ -786,9 +785,9 @@ Reset the default logger.
# Example
Suppose an [MLflow](https://mlflow.org/docs/latest/index.html) tracking service is running
on a local server at `http://127.0.0.1:500`. Then every in every `evaluate` call in which
`logger` is not specified, as in the example below, the peformance evaluation is
automatically logged to the service.
on a local server at `http://127.0.0.1:500`. Then in every `evaluate` call in which
`logger` is not specified, the peformance evaluation is
automatically logged to the service, as here:
```julia-repl
using MLJ
Expand All @@ -798,6 +797,7 @@ default_logger(logger)
X, y = make_moons()
model = ConstantClassifier()
evaluate(model, X, y, measures=[log_loss, accuracy)])
```
"""
function default_logger(logger)
Expand Down

0 comments on commit ecb4322

Please sign in to comment.