Skip to content

Added note to BLAS.[g|s]et_num_threads about Apple Accelerate not supporting it #1195

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
merged 1 commit into from
Feb 9, 2025
Merged

Added note to BLAS.[g|s]et_num_threads about Apple Accelerate not supporting it #1195

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions src/blas.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,10 @@ Set the number of threads the BLAS library should use equal to `n::Integer`.

Also accepts `nothing`, in which case julia tries to guess the default number of threads.
Passing `nothing` is discouraged and mainly exists for historical reasons.

!!! note
Some BLAS libraries, such as Apple Accelerate, cannot be configured to use a fixed number of threads.
For these backends, `set_num_threads()` is a no-op. See also [`get_num_threads`](@ref).
"""
set_num_threads(nt::Integer)::Nothing = lbt_set_num_threads(Int32(nt))
function set_num_threads(::Nothing)
Expand All @@ -147,6 +151,10 @@ Get the number of threads the BLAS library is using.

!!! compat "Julia 1.6"
`get_num_threads` requires at least Julia 1.6.

!!! note
Some BLAS libraries, such as Apple Accelerate, cannot be configured to use a fixed number of threads.
For these backends, `get_num_threads()` always returns `1`. See also [`set_num_threads`](@ref).
"""
get_num_threads()::Int = lbt_get_num_threads()

Expand Down