Skip to content

Commit 57bc24e

Browse files
committed
Move comment on setting the number of threads to set_nthreads.
1 parent d916ccb commit 57bc24e

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

src/blosc2/core.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -892,11 +892,6 @@ def free_resources() -> None:
892892
temporary space. You can use this function to release these
893893
resources when you are not going to use Blosc for a long time.
894894
895-
The number of threads can also be set via the ``BLOSC_NTHREADS`` environment
896-
variable (e.g., ``export BLOSC_NTHREADS=1``). Additionally, you may want to set
897-
``NUMEXPR_NUM_THREADS`` as well since numexpr is used under the hood
898-
(e.g., ``export NUMEXPR_NUM_THREADS=1``).
899-
900895
Examples
901896
--------
902897
>>> blosc2.free_resources()
@@ -925,6 +920,13 @@ def set_nthreads(nthreads: int) -> int:
925920
926921
Notes
927922
-----
923+
The number of threads can also be set via the ``BLOSC_NTHREADS`` environment
924+
variable (e.g., ``export BLOSC_NTHREADS=1``). Additionally, you may want to set
925+
``NUMEXPR_NUM_THREADS`` (e.g., ``export NUMEXPR_NUM_THREADS=1``) as well since
926+
numexpr is used under the hood when performing some operations. Note that
927+
this function only sets the number of threads used by Blosc, not the number
928+
of threads used by numexpr.
929+
928930
The maximum number of threads for Blosc is :math:`2^{31} - 1`. In some
929931
cases, Blosc gets better results if you set the number of threads
930932
to a value slightly below your number of cores

0 commit comments

Comments
 (0)