Skip to content

Update warning about RNG hyperparameter copies #61

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.

Sign up for GitHub

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
ablaom merged 2 commits into from
Apr 30, 2026
+5 −3
Merged

Update warning about RNG hyperparameter copies #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8dc86ae
Update warning about RNG hyperparameter copies
ablaom Apr 30, 2026
37ea2ba
spelling
ablaom Apr 30, 2026
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/src/predict_transform.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The above signatures apply in the case that [`LearnAPI.kind_of(learner)`](@ref)
returns [`LearnAPI.Generative()`](@ref), as in [density
estimation](@ref density_estimation).

## [Typical worklows](@id predict_workflow)
## [Typical workflows](@id predict_workflow)

Train some supervised `learner`:

Expand Down
6 changes: 4 additions & 2 deletions docs/src/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,10 @@ generally requires overloading `Base.==` for the struct.
!!! important

No LearnAPI.jl method is permitted to mutate a learner. In particular, one should make
deep copies of RNG hyperparameters before using them in an implementation of
[`fit`](@ref).
copies of RNG hyperparameters before using them in an implementation of
[`fit`](@ref). (Do not make *deep* copies as this leads to wrong behavior in the case
of `Random.default_rng()`, which not an actual RNG but only a pointer to the task-local
default RNG.)


#### Kinds of learner
Expand Down
Loading