Skip to content
Draft
Changes from all commits
Commits
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
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
# Thread-pool Controls [![Build Status](https://github.com/joblib/threadpoolctl/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/joblib/threadpoolctl/actions?query=branch%3Amaster) [![codecov](https://codecov.io/gh/joblib/threadpoolctl/branch/master/graph/badge.svg)](https://codecov.io/gh/joblib/threadpoolctl)

Python helpers to limit the number of threads used in the
threadpool-backed of common native libraries used for scientific
computing and data science (e.g. BLAS and OpenMP).

Fine control of the underlying thread-pool size can be useful in
workloads that involve nested parallelism so as to mitigate
lve nested parallelism so as to mitigate
oversubscription issues.

Note that "limiting the number of threads" in practice involves a variety of
Expand Down Expand Up @@ -145,7 +140,7 @@ True

## Usage when not using Python threads: Restricting Controlled Library Thread Pool Sizes

There are two scenarios in which you might want to use `threadpoolctl`; each
There are two scenarios in which you might want to use `threadpoolctl`; each
requires you to use different APIs.

1. You do not expect to use any Python threads, so all the work will be started
Expand Down Expand Up @@ -465,7 +460,7 @@ https://github.com/xianyi/OpenBLAS/issues/2985).
on Windows, the setting is process-wide and impacts the size of a process-wide
thread pool shared across all threads in the process.

## <div id="semantics"> Semantics of thread limiting </div>
## <div id="semantics"> Semantics of thread limiting </div>

Setting the number of threads may seem like a simple operation, but in practice
it can do quite different things depending on the underlying third-party library
Expand Down
Loading