Skip to content

Commit

Permalink
Add docstring for heap_size_in_bytes
Browse files Browse the repository at this point in the history
  • Loading branch information
MilesCranmer committed Dec 24, 2023
1 parent bda097e commit 9bf2e52
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/MLJInterface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -492,6 +492,11 @@ function tag_with_docstring(model_name::Symbol, description::String, bottom_matt
which is the number of processes to use, as well as the `lazy` keyword argument.
For example, if set up on a slurm cluster, you could pass
`addprocs_function = addprocs_slurm`, which will set up slurm processes.
- `heap_size_hint_in_bytes::Union{Int,Nothing}=nothing`: On Julia 1.9+, you may set the `--heap-size-hint`
flag on Julia processes, recommending garbage collection once a process
is close to the recommended size. This is important for long-running distributed
jobs where each process has an independent memory, and can help avoid
out-of-memory errors. By default, this is set to `Sys.free_memory() / numprocs`.
- `runtests::Bool=true`: Whether to run (quick) tests before starting the
search, to see if there will be any problems during the equation search
related to the host environment.
Expand Down
5 changes: 5 additions & 0 deletions src/SymbolicRegression.jl
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,11 @@ which is useful for debugging and profiling.
which is the number of processes to use, as well as the `lazy` keyword argument.
For example, if set up on a slurm cluster, you could pass
`addprocs_function = addprocs_slurm`, which will set up slurm processes.
- `heap_size_hint_in_bytes::Union{Int,Nothing}=nothing`: On Julia 1.9+, you may set the `--heap-size-hint`
flag on Julia processes, recommending garbage collection once a process
is close to the recommended size. This is important for long-running distributed
jobs where each process has an independent memory, and can help avoid
out-of-memory errors. By default, this is set to `Sys.free_memory() / numprocs`.
- `runtests::Bool=true`: Whether to run (quick) tests before starting the
search, to see if there will be any problems during the equation search
related to the host environment.
Expand Down

0 comments on commit 9bf2e52

Please sign in to comment.