Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
pytreat-practicals-2020
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Tom Nichols
pytreat-practicals-2020
Commits
6ad4b884
Commit
6ad4b884
authored
7 years ago
by
Paul McCarthy
Browse files
Options
Downloads
Patches
Plain Diff
Practical on threading/mp
parent
d982c507
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
advanced_topics/07_threading.ipynb
+614
-0
614 additions, 0 deletions
advanced_topics/07_threading.ipynb
advanced_topics/07_threading.md
+516
-0
516 additions, 0 deletions
advanced_topics/07_threading.md
advanced_topics/README.md
+1
-1
1 addition, 1 deletion
advanced_topics/README.md
with
1131 additions
and
1 deletion
advanced_topics/07_threading.ipynb
0 → 100644
+
614
−
0
View file @
6ad4b884
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Threading and parallel processing\n",
"\n",
"\n",
"The Python language has built-in support for multi-threading in the\n",
"[`threading`](https://docs.python.org/3.5/library/threading.html) module, and\n",
"true parallelism in the\n",
"[`multiprocessing`](https://docs.python.org/3.5/library/multiprocessing.html)\n",
"module. If you want to be impressed, skip straight to the section on\n",
"[`multiprocessing`](todo).\n",
"\n",
"\n",
"\n",
"\n",
"\n",
"## Threading\n",
"\n",
"\n",
"The [`threading`](https://docs.python.org/3.5/library/threading.html) module\n",
"provides a traditional multi-threading API that should be familiar to you if\n",
"you have worked with threads in other languages.\n",
"\n",
"\n",
"Running a task in a separate thread in Python is easy - simply create a\n",
"`Thread` object, and pass it the function or method that you want it to\n",
"run. Then call its `start` method:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"import time\n",
"import threading\n",
"\n",
"def longRunningTask(niters):\n",
" for i in range(niters):\n",
" if i % 2 == 0: print('Tick')\n",
" else: print('Tock')\n",
" time.sleep(0.5)\n",
"\n",
"t = threading.Thread(target=longRunningTask, args=(8,))\n",
"\n",
"t.start()\n",
"\n",
"while t.is_alive():\n",
" time.sleep(0.4)\n",
" print('Waiting for thread to finish...')\n",
"print('Finished!')"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"You can also `join` a thread, which will block execution in the current thread\n",
"until the thread that has been `join`ed has finished:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"t = threading.Thread(target=longRunningTask, args=(6, ))\n",
"t.start()\n",
"\n",
"print('Joining thread ...')\n",
"t.join()\n",
"print('Finished!')"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Subclassing `Thread`\n",
"\n",
"\n",
"It is also possible to sub-class the `Thread` class, and override its `run`\n",
"method:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"class LongRunningThread(threading.Thread):\n",
" def __init__(self, niters, *args, **kwargs):\n",
" super().__init__(*args, **kwargs)\n",
" self.niters = niters\n",
"\n",
" def run(self):\n",
" for i in range(self.niters):\n",
" if i % 2 == 0: print('Tick')\n",
" else: print('Tock')\n",
" time.sleep(0.5)\n",
"\n",
"t = LongRunningThread(6)\n",
"t.start()\n",
"t.join()\n",
"print('Done')"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Daemon threads\n",
"\n",
"\n",
"By default, a Python application will not exit until _all_ active threads have\n",
"finished execution. If you want to run a task in the background for the\n",
"duration of your application, you can mark it as a `daemon` thread - when all\n",
"non-daemon threads in a Python application have finished, all daemon threads\n",
"will be halted, and the application will exit.\n",
"\n",
"\n",
"You can mark a thread as being a daemon by setting an attribute on it after\n",
"creation:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"t = threading.Thread(target=longRunningTask)\n",
"t.daemon = True"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"See the [`Thread`\n",
"documentation](https://docs.python.org/3.5/library/threading.html#thread-objects)\n",
"for more details.\n",
"\n",
"\n",
"### Thread synchronisation\n",
"\n",
"\n",
"The `threading` module provides some useful thread-synchronisation primitives\n",
"- the `Lock`, `RLock` (re-entrant `Lock`), and `Event` classes. The\n",
"`threading` module also provides `Condition` and `Semaphore` classes - refer\n",
"to the [documentation](https://docs.python.org/3.5/library/threading.html) for\n",
"more details.\n",
"\n",
"\n",
"#### `Lock`\n",
"\n",
"\n",
"The [`Lock`](https://docs.python.org/3.5/library/threading.html#lock-objects)\n",
"class (and its re-entrant version, the\n",
"[`RLock`](https://docs.python.org/3.5/library/threading.html#rlock-objects))\n",
"prevents a block of code from being accessed by more than one thread at a\n",
"time. For example, if we have multiple threads running this `task` function,\n",
"their [outputs](https://www.youtube.com/watch?v=F5fUFnfPpYU) will inevitably\n",
"become intertwined:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"def task():\n",
" for i in range(5):\n",
" print('{} Woozle '.format(i), end='')\n",
" time.sleep(0.1)\n",
" print('Wuzzle')\n",
"\n",
"threads = [threading.Thread(target=task) for i in range(5)]\n",
"for t in threads:\n",
" t.start()"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"But if we protect the critical section with a `Lock` object, the output will\n",
"look more sensible:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"lock = threading.Lock()\n",
"\n",
"def task():\n",
"\n",
" for i in range(5):\n",
" with lock:\n",
" print('{} Woozle '.format(i), end='')\n",
" time.sleep(0.1)\n",
" print('Wuzzle')\n",
"\n",
"threads = [threading.Thread(target=task) for i in range(5)]\n",
"for t in threads:\n",
" t.start()"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"> Instead of using a `Lock` object in a `with` statement, it is also possible\n",
"> to manually call its `acquire` and `release` methods:\n",
">\n",
"> def task():\n",
"> for i in range(5):\n",
"> lock.acquire()\n",
"> print('{} Woozle '.format(i), end='')\n",
"> time.sleep(0.1)\n",
"> print('Wuzzle')\n",
"> lock.release()\n",
"\n",
"\n",
"Python does not have any built-in constructs to implement `Lock`-based mutual\n",
"exclusion across several functions or methods - each function/method must\n",
"explicitly acquire/release a shared `Lock` instance. However, it is relatively\n",
"straightforward to implement a decorator which does this for you:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"def mutex(func, lock):\n",
" def wrapper(*args):\n",
" with lock:\n",
" func(*args)\n",
" return wrapper\n",
"\n",
"class MyClass(object):\n",
"\n",
" def __init__(self):\n",
" lock = threading.Lock()\n",
" self.safeFunc1 = mutex(self.safeFunc1, lock)\n",
" self.safeFunc2 = mutex(self.safeFunc2, lock)\n",
"\n",
" def safeFunc1(self):\n",
" time.sleep(0.1)\n",
" print('safeFunc1 start')\n",
" time.sleep(0.2)\n",
" print('safeFunc1 end')\n",
"\n",
" def safeFunc2(self):\n",
" time.sleep(0.1)\n",
" print('safeFunc2 start')\n",
" time.sleep(0.2)\n",
" print('safeFunc2 end')\n",
"\n",
"mc = MyClass()\n",
"\n",
"f1threads = [threading.Thread(target=mc.safeFunc1) for i in range(4)]\n",
"f2threads = [threading.Thread(target=mc.safeFunc2) for i in range(4)]\n",
"\n",
"for t in f1threads + f2threads:\n",
" t.start()"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Try removing the `mutex` lock from the two methods in the above code, and see\n",
"what it does to the output.\n",
"\n",
"\n",
"#### `Event`\n",
"\n",
"\n",
"The\n",
"[`Event`](https://docs.python.org/3.5/library/threading.html#event-objects)\n",
"class is essentially a boolean [semaphore][semaphore-wiki]. It can be used to\n",
"signal events between threads. Threads can `wait` on the event, and be awoken\n",
"when the event is `set` by another thread:\n",
"\n",
"\n",
"[semaphore-wiki]: https://en.wikipedia.org/wiki/Semaphore_(programming)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"import numpy as np\n",
"\n",
"processingFinished = threading.Event()\n",
"\n",
"def processData(data):\n",
" print('Processing data ...')\n",
" time.sleep(2)\n",
" print('Result: {}'.format(data.mean()))\n",
" processingFinished.set()\n",
"\n",
"data = np.random.randint(1, 100, 100)\n",
"\n",
"t = threading.Thread(target=processData, args=(data,))\n",
"t.start()\n",
"\n",
"processingFinished.wait()\n",
"print('Processing finished!')"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### The Global Interpreter Lock (GIL)\n",
"\n",
"\n",
"The [_Global Interpreter\n",
"Lock_](https://docs.python.org/3/c-api/init.html#thread-state-and-the-global-interpreter-lock)\n",
"is an implementation detail of [CPython](https://github.com/python/cpython)\n",
"(the official Python interpreter). The GIL means that a multi-threaded\n",
"program written in pure Python is not able to take advantage of multiple\n",
"cores - this essentially means that only one thread may be executing at any\n",
"point in time.\n",
"\n",
"\n",
"The `threading` module does still have its uses though, as this GIL problem\n",
"does not affect tasks which involve calls to system or natively compiled\n",
"libraries (e.g. file and network I/O, Numpy operations, etc.). So you can,\n",
"for example, perform some expensive processing on a Numpy array in a thread\n",
"running on one core, whilst having another thread (e.g. user interaction)\n",
"running on another core.\n",
"\n",
"\n",
"## Multiprocessing\n",
"\n",
"\n",
"For true parallelism, you should check out the\n",
"[`multiprocessing`](https://docs.python.org/3.5/library/multiprocessing.html)\n",
"module.\n",
"\n",
"\n",
"The `multiprocessing` module spawns sub-processes, rather than threads, and so\n",
"is not subject to the GIL constraints that the `threading` module suffers\n",
"from. It provides two APIs - a \"traditional\" equivalent to that provided by\n",
"the `threading` module, and a powerful higher-level API.\n",
"\n",
"\n",
"### `threading`-equivalent API\n",
"\n",
"\n",
"The\n",
"[`Process`](https://docs.python.org/3.5/library/multiprocessing.html#the-process-class)\n",
"class is the `multiprocessing` equivalent of the\n",
"[`threading.Thread`](https://docs.python.org/3.5/library/threading.html#thread-objects)\n",
"class. `multprocessing` also has equivalents of the [`Lock` and `Event`\n",
"classes](https://docs.python.org/3.5/library/multiprocessing.html#synchronization-between-processes),\n",
"and the other synchronisation primitives provided by `threading`.\n",
"\n",
"\n",
"So you can simply replace `threading.Thread` with `multiprocessing.Process`,\n",
"and you will have true parallelism.\n",
"\n",
"\n",
"Because your \"threads\" are now independent processes, you need to be a little\n",
"careful about how to share information across them. Fortunately, the\n",
"`multiprocessing` module provides [`Queue` and `Pipe`\n",
"classes](https://docs.python.org/3.5/library/multiprocessing.html#exchanging-objects-between-processes)\n",
"which make it easy to share data across processes.\n",
"\n",
"\n",
"### Higher-level API - the `multiprocessing.Pool`\n",
"\n",
"\n",
"The real advantages of `multiprocessing` lie in its higher level API, centered\n",
"around the [`Pool`\n",
"class](https://docs.python.org/3.5/library/multiprocessing.html#using-a-pool-of-workers).\n",
"\n",
"\n",
"Essentially, you create a `Pool` of worker processes - you specify the number\n",
"of processes when you create the pool.\n",
"\n",
"\n",
"> The best number of processes to use for a `Pool` will depend on the system\n",
"> you are running on (number of cores), and the tasks you are running (e.g.\n",
"> I/O bound or CPU bound).\n",
"\n",
"\n",
"Once you have created a `Pool`, you can use its methods to automatically\n",
"parallelise tasks. The most useful are the `map`, `starmap` and\n",
"`apply_async` methods.\n",
"\n",
"\n",
"#### `Pool.map`\n",
"\n",
"\n",
"The\n",
"[`Pool.map`](https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.Pool.map)\n",
"method is the multiprocessing equivalent of the built-in\n",
"[`map`](https://docs.python.org/3.5/library/functions.html#map) function - it\n",
"is given a function, and a sequence, and it applies the function to each\n",
"element in the sequence."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"import time\n",
"import multiprocessing as mp\n",
"import numpy as np\n",
"\n",
"def crunchImage(imgfile):\n",
"\n",
" # Load a nifti image, do stuff\n",
" # to it. Use your imagination\n",
" # to fill in this function.\n",
" time.sleep(2)\n",
"\n",
" # numpy's random number generator\n",
" # will be initialised in the same\n",
" # way in each process, so let's\n",
" # re-seed it.\n",
" np.random.seed()\n",
" result = np.random.randint(1, 100, 1)\n",
"\n",
" print(imgfile, ':', result)\n",
"\n",
" return result\n",
"\n",
"imgfiles = ['{:02d}.nii.gz'.format(i) for i in range(20)]\n",
"\n",
"p = mp.Pool(processes=16)\n",
"\n",
"print('Crunching images...')\n",
"\n",
"start = time.time()\n",
"results = p.map(crunchImage, imgfiles)\n",
"end = time.time()\n",
"\n",
"print('Total execution time: {:0.2f} seconds'.format(end - start))"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"The `Pool.map` method only works with functions that accept one argument, such\n",
"as our `crunchImage` function above. If you have a function which accepts\n",
"multiple arguments, use the\n",
"[`Pool.starmap`](https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.Pool.starmap)\n",
"method instead:"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"def crunchImage(imgfile, modality):\n",
" time.sleep(2)\n",
"\n",
" np.random.seed()\n",
"\n",
" if modality == 't1':\n",
" result = np.random.randint(1, 100, 1)\n",
" elif modality == 't2':\n",
" result = np.random.randint(100, 200, 1)\n",
"\n",
" print(imgfile, ': ', result)\n",
"\n",
" return result\n",
"\n",
"imgfiles = ['t1_{:02d}.nii.gz'.format(i) for i in range(10)] + \\\n",
" ['t2_{:02d}.nii.gz'.format(i) for i in range(10)]\n",
"modalities = ['t1'] * 10 + ['t2'] * 10\n",
"\n",
"pool = mp.Pool(processes=16)\n",
"\n",
"args = [(f, m) for f, m in zip(imgfiles, modalities)]\n",
"\n",
"print('Crunching images...')\n",
"\n",
"start = time.time()\n",
"results = pool.starmap(crunchImage, args)\n",
"end = time.time()\n",
"\n",
"print('Total execution time: {:0.2f} seconds'.format(end - start))"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"The `map` and `starmap` methods also have asynchronous equivalents `map_async`\n",
"and `starmap_async`, which return immediately. Refer to the\n",
"[`Pool`](https://docs.python.org/3.5/library/multiprocessing.html#module-multiprocessing.pool)\n",
"documentation for more details.\n",
"\n",
"\n",
"#### `Pool.apply_async`\n",
"\n",
"\n",
"The\n",
"[`Pool.apply`](https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.Pool.apply)\n",
"method will execute a function on one of the processes, and block until it has\n",
"finished. The\n",
"[`Pool.apply_async`](https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.Pool.apply_async)\n",
"method returns immediately, and is thus more suited to asynchronously\n",
"scheduling multiple jobs to run in parallel.\n",
"\n",
"\n",
"`apply_async` returns an object of type\n",
"[`AsyncResult`](https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.AsyncResult).\n",
"An `AsyncResult` object has `wait` and `get` methods which will block until\n",
"the job has completed."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"import time\n",
"import multiprocessing as mp\n",
"import numpy as np\n",
"\n",
"\n",
"def linear_registration(src, ref):\n",
" time.sleep(1)\n",
"\n",
" return np.eye(4)\n",
"\n",
"def nonlinear_registration(src, ref, affine):\n",
"\n",
" time.sleep(3)\n",
"\n",
" # this number represents a non-linear warp\n",
" # field - use your imagination people!\n",
" np.random.seed()\n",
" return np.random.randint(1, 100, 1)\n",
"\n",
"t1s = ['{:02d}_t1.nii.gz'.format(i) for i in range(20)]\n",
"std = 'MNI152_T1_2mm.nii.gz'\n",
"\n",
"pool = mp.Pool(processes=16)\n",
"\n",
"print('Running structural-to-standard registration '\n",
" 'on {} subjects...'.format(len(t1s)))\n",
"\n",
"# Run linear registration on all the T1s.\n",
"#\n",
"# We build a list of AsyncResult objects\n",
"linresults = [pool.apply_async(linear_registration, (t1, std))\n",
" for t1 in t1s]\n",
"\n",
"# Then we wait for each job to finish,\n",
"# and replace its AsyncResult object\n",
"# with the actual result - an affine\n",
"# transformation matrix.\n",
"start = time.time()\n",
"for i, r in enumerate(linresults):\n",
" linresults[i] = r.get()\n",
"end = time.time()\n",
"\n",
"print('Linear registrations completed in '\n",
" '{:0.2f} seconds'.format(end - start))\n",
"\n",
"# Run non-linear registration on all the T1s,\n",
"# using the linear registrations to initialise.\n",
"nlinresults = [pool.apply_async(nonlinear_registration, (t1, std, aff))\n",
" for (t1, aff) in zip(t1s, linresults)]\n",
"\n",
"# Wait for each non-linear reg to finish,\n",
"# and store the resulting warp field.\n",
"start = time.time()\n",
"for i, r in enumerate(nlinresults):\n",
" nlinresults[i] = r.get()\n",
"end = time.time()\n",
"\n",
"print('Non-linear registrations completed in '\n",
" '{:0.2f} seconds'.format(end - start))\n",
"\n",
"print('Non linear registrations:')\n",
"for t1, result in zip(t1s, nlinresults):\n",
" print(t1, ':', result)"
]
}
],
"metadata": {},
"nbformat": 4,
"nbformat_minor": 2
}
%% Cell type:markdown id: tags:
# Threading and parallel processing
The Python language has built-in support for multi-threading in the
[
`threading`
](
https://docs.python.org/3.5/library/threading.html
)
module, and
true parallelism in the
[
`multiprocessing`
](
https://docs.python.org/3.5/library/multiprocessing.html
)
module. If you want to be impressed, skip straight to the section on
[
`multiprocessing`
](
todo
)
.
## Threading
The
[
`threading`
](
https://docs.python.org/3.5/library/threading.html
)
module
provides a traditional multi-threading API that should be familiar to you if
you have worked with threads in other languages.
Running a task in a separate thread in Python is easy - simply create a
`Thread`
object, and pass it the function or method that you want it to
run. Then call its
`start`
method:
%% Cell type:code id: tags:
```
import time
import threading
def longRunningTask(niters):
for i in range(niters):
if i % 2 == 0: print('Tick')
else: print('Tock')
time.sleep(0.5)
t = threading.Thread(target=longRunningTask, args=(8,))
t.start()
while t.is_alive():
time.sleep(0.4)
print('Waiting for thread to finish...')
print('Finished!')
```
%% Cell type:markdown id: tags:
You can also
`join`
a thread, which will block execution in the current thread
until the thread that has been
`join`
ed has finished:
%% Cell type:code id: tags:
```
t = threading.Thread(target=longRunningTask, args=(6, ))
t.start()
print('Joining thread ...')
t.join()
print('Finished!')
```
%% Cell type:markdown id: tags:
### Subclassing `Thread`
It is also possible to sub-class the
`Thread`
class, and override its
`run`
method:
%% Cell type:code id: tags:
```
class LongRunningThread(threading.Thread):
def __init__(self, niters, *args, **kwargs):
super().__init__(*args, **kwargs)
self.niters = niters
def run(self):
for i in range(self.niters):
if i % 2 == 0: print('Tick')
else: print('Tock')
time.sleep(0.5)
t = LongRunningThread(6)
t.start()
t.join()
print('Done')
```
%% Cell type:markdown id: tags:
### Daemon threads
By default, a Python application will not exit until _all_ active threads have
finished execution. If you want to run a task in the background for the
duration of your application, you can mark it as a
`daemon`
thread - when all
non-daemon threads in a Python application have finished, all daemon threads
will be halted, and the application will exit.
You can mark a thread as being a daemon by setting an attribute on it after
creation:
%% Cell type:code id: tags:
```
t = threading.Thread(target=longRunningTask)
t.daemon = True
```
%% Cell type:markdown id: tags:
See the
[
`Thread`
documentation
](
https://docs.python.org/3.5/library/threading.html#thread-objects
)
for more details.
### Thread synchronisation
The
`threading`
module provides some useful thread-synchronisation primitives
-
the
`Lock`
,
`RLock`
(re-entrant
`Lock`
), and
`Event`
classes. The
`threading`
module also provides
`Condition`
and
`Semaphore`
classes - refer
to the
[
documentation
](
https://docs.python.org/3.5/library/threading.html
)
for
more details.
#### `Lock`
The
[
`Lock`
](
https://docs.python.org/3.5/library/threading.html#lock-objects
)
class (and its re-entrant version, the
[
`RLock`
](
https://docs.python.org/3.5/library/threading.html#rlock-objects
)
)
prevents a block of code from being accessed by more than one thread at a
time. For example, if we have multiple threads running this
`task`
function,
their
[
outputs
](
https://www.youtube.com/watch?v=F5fUFnfPpYU
)
will inevitably
become intertwined:
%% Cell type:code id: tags:
```
def task():
for i in range(5):
print('{} Woozle '.format(i), end='')
time.sleep(0.1)
print('Wuzzle')
threads = [threading.Thread(target=task) for i in range(5)]
for t in threads:
t.start()
```
%% Cell type:markdown id: tags:
But if we protect the critical section with a
`Lock`
object, the output will
look more sensible:
%% Cell type:code id: tags:
```
lock = threading.Lock()
def task():
for i in range(5):
with lock:
print('{} Woozle '.format(i), end='')
time.sleep(0.1)
print('Wuzzle')
threads = [threading.Thread(target=task) for i in range(5)]
for t in threads:
t.start()
```
%% Cell type:markdown id: tags:
> Instead of using a `Lock` object in a `with` statement, it is also possible
> to manually call its `acquire` and `release` methods:
>
> def task():
> for i in range(5):
> lock.acquire()
> print('{} Woozle '.format(i), end='')
> time.sleep(0.1)
> print('Wuzzle')
> lock.release()
Python does not have any built-in constructs to implement
`Lock`
-based mutual
exclusion across several functions or methods - each function/method must
explicitly acquire/release a shared
`Lock`
instance. However, it is relatively
straightforward to implement a decorator which does this for you:
%% Cell type:code id: tags:
```
def mutex(func, lock):
def wrapper(*args):
with lock:
func(*args)
return wrapper
class MyClass(object):
def __init__(self):
lock = threading.Lock()
self.safeFunc1 = mutex(self.safeFunc1, lock)
self.safeFunc2 = mutex(self.safeFunc2, lock)
def safeFunc1(self):
time.sleep(0.1)
print('safeFunc1 start')
time.sleep(0.2)
print('safeFunc1 end')
def safeFunc2(self):
time.sleep(0.1)
print('safeFunc2 start')
time.sleep(0.2)
print('safeFunc2 end')
mc = MyClass()
f1threads = [threading.Thread(target=mc.safeFunc1) for i in range(4)]
f2threads = [threading.Thread(target=mc.safeFunc2) for i in range(4)]
for t in f1threads + f2threads:
t.start()
```
%% Cell type:markdown id: tags:
Try removing the
`mutex`
lock from the two methods in the above code, and see
what it does to the output.
#### `Event`
The
[
`Event`
](
https://docs.python.org/3.5/library/threading.html#event-objects
)
class is essentially a boolean
[
semaphore
][
semaphore-wiki
]
. It can be used to
signal events between threads. Threads can
`wait`
on the event, and be awoken
when the event is
`set`
by another thread:
[
semaphore-wiki
]:
https://en.wikipedia.org/wiki/Semaphore_(programming)
%% Cell type:code id: tags:
```
import numpy as np
processingFinished = threading.Event()
def processData(data):
print('Processing data ...')
time.sleep(2)
print('Result: {}'.format(data.mean()))
processingFinished.set()
data = np.random.randint(1, 100, 100)
t = threading.Thread(target=processData, args=(data,))
t.start()
processingFinished.wait()
print('Processing finished!')
```
%% Cell type:markdown id: tags:
### The Global Interpreter Lock (GIL)
The
[
_Global Interpreter
Lock_
](
https://docs.python.org/3/c-api/init.html#thread-state-and-the-global-interpreter-lock
)
is an implementation detail of
[
CPython
](
https://github.com/python/cpython
)
(the official Python interpreter). The GIL means that a multi-threaded
program written in pure Python is not able to take advantage of multiple
cores - this essentially means that only one thread may be executing at any
point in time.
The
`threading`
module does still have its uses though, as this GIL problem
does not affect tasks which involve calls to system or natively compiled
libraries (e.g. file and network I/O, Numpy operations, etc.). So you can,
for example, perform some expensive processing on a Numpy array in a thread
running on one core, whilst having another thread (e.g. user interaction)
running on another core.
## Multiprocessing
For true parallelism, you should check out the
[
`multiprocessing`
](
https://docs.python.org/3.5/library/multiprocessing.html
)
module.
The
`multiprocessing`
module spawns sub-processes, rather than threads, and so
is not subject to the GIL constraints that the
`threading`
module suffers
from. It provides two APIs - a "traditional" equivalent to that provided by
the
`threading`
module, and a powerful higher-level API.
### `threading`-equivalent API
The
[
`Process`
](
https://docs.python.org/3.5/library/multiprocessing.html#the-process-class
)
class is the
`multiprocessing`
equivalent of the
[
`threading.Thread`
](
https://docs.python.org/3.5/library/threading.html#thread-objects
)
class.
`multprocessing`
also has equivalents of the
[
`Lock` and `Event`
classes
](
https://docs.python.org/3.5/library/multiprocessing.html#synchronization-between-processes
)
,
and the other synchronisation primitives provided by
`threading`
.
So you can simply replace
`threading.Thread`
with
`multiprocessing.Process`
,
and you will have true parallelism.
Because your "threads" are now independent processes, you need to be a little
careful about how to share information across them. Fortunately, the
`multiprocessing`
module provides
[
`Queue` and `Pipe`
classes
](
https://docs.python.org/3.5/library/multiprocessing.html#exchanging-objects-between-processes
)
which make it easy to share data across processes.
### Higher-level API - the `multiprocessing.Pool`
The real advantages of
`multiprocessing`
lie in its higher level API, centered
around the
[
`Pool`
class
](
https://docs.python.org/3.5/library/multiprocessing.html#using-a-pool-of-workers
)
.
Essentially, you create a
`Pool`
of worker processes - you specify the number
of processes when you create the pool.
> The best number of processes to use for a `Pool` will depend on the system
> you are running on (number of cores), and the tasks you are running (e.g.
> I/O bound or CPU bound).
Once you have created a
`Pool`
, you can use its methods to automatically
parallelise tasks. The most useful are the
`map`
,
`starmap`
and
`apply_async`
methods.
#### `Pool.map`
The
[
`Pool.map`
](
https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.Pool.map
)
method is the multiprocessing equivalent of the built-in
[
`map`
](
https://docs.python.org/3.5/library/functions.html#map
)
function - it
is given a function, and a sequence, and it applies the function to each
element in the sequence.
%% Cell type:code id: tags:
```
import time
import multiprocessing as mp
import numpy as np
def crunchImage(imgfile):
# Load a nifti image, do stuff
# to it. Use your imagination
# to fill in this function.
time.sleep(2)
# numpy's random number generator
# will be initialised in the same
# way in each process, so let's
# re-seed it.
np.random.seed()
result = np.random.randint(1, 100, 1)
print(imgfile, ':', result)
return result
imgfiles = ['{:02d}.nii.gz'.format(i) for i in range(20)]
p = mp.Pool(processes=16)
print('Crunching images...')
start = time.time()
results = p.map(crunchImage, imgfiles)
end = time.time()
print('Total execution time: {:0.2f} seconds'.format(end - start))
```
%% Cell type:markdown id: tags:
The
`Pool.map`
method only works with functions that accept one argument, such
as our
`crunchImage`
function above. If you have a function which accepts
multiple arguments, use the
[
`Pool.starmap`
](
https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.Pool.starmap
)
method instead:
%% Cell type:code id: tags:
```
def crunchImage(imgfile, modality):
time.sleep(2)
np.random.seed()
if modality == 't1':
result = np.random.randint(1, 100, 1)
elif modality == 't2':
result = np.random.randint(100, 200, 1)
print(imgfile, ': ', result)
return result
imgfiles = ['t1_{:02d}.nii.gz'.format(i) for i in range(10)] + \
['t2_{:02d}.nii.gz'.format(i) for i in range(10)]
modalities = ['t1'] * 10 + ['t2'] * 10
pool = mp.Pool(processes=16)
args = [(f, m) for f, m in zip(imgfiles, modalities)]
print('Crunching images...')
start = time.time()
results = pool.starmap(crunchImage, args)
end = time.time()
print('Total execution time: {:0.2f} seconds'.format(end - start))
```
%% Cell type:markdown id: tags:
The
`map`
and
`starmap`
methods also have asynchronous equivalents
`map_async`
and
`starmap_async`
, which return immediately. Refer to the
[
`Pool`
](
https://docs.python.org/3.5/library/multiprocessing.html#module-multiprocessing.pool
)
documentation for more details.
#### `Pool.apply_async`
The
[
`Pool.apply`
](
https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.Pool.apply
)
method will execute a function on one of the processes, and block until it has
finished. The
[
`Pool.apply_async`
](
https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.Pool.apply_async
)
method returns immediately, and is thus more suited to asynchronously
scheduling multiple jobs to run in parallel.
`apply_async`
returns an object of type
[
`AsyncResult`
](
https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.AsyncResult
)
.
An
`AsyncResult`
object has
`wait`
and
`get`
methods which will block until
the job has completed.
%% Cell type:code id: tags:
```
import time
import multiprocessing as mp
import numpy as np
def linear_registration(src, ref):
time.sleep(1)
return np.eye(4)
def nonlinear_registration(src, ref, affine):
time.sleep(3)
# this number represents a non-linear warp
# field - use your imagination people!
np.random.seed()
return np.random.randint(1, 100, 1)
t1s = ['{:02d}_t1.nii.gz'.format(i) for i in range(20)]
std = 'MNI152_T1_2mm.nii.gz'
pool = mp.Pool(processes=16)
print('Running structural-to-standard registration '
'on {} subjects...'.format(len(t1s)))
# Run linear registration on all the T1s.
#
# We build a list of AsyncResult objects
linresults = [pool.apply_async(linear_registration, (t1, std))
for t1 in t1s]
# Then we wait for each job to finish,
# and replace its AsyncResult object
# with the actual result - an affine
# transformation matrix.
start = time.time()
for i, r in enumerate(linresults):
linresults[i] = r.get()
end = time.time()
print('Linear registrations completed in '
'{:0.2f} seconds'.format(end - start))
# Run non-linear registration on all the T1s,
# using the linear registrations to initialise.
nlinresults = [pool.apply_async(nonlinear_registration, (t1, std, aff))
for (t1, aff) in zip(t1s, linresults)]
# Wait for each non-linear reg to finish,
# and store the resulting warp field.
start = time.time()
for i, r in enumerate(nlinresults):
nlinresults[i] = r.get()
end = time.time()
print('Non-linear registrations completed in '
'{:0.2f} seconds'.format(end - start))
print('Non linear registrations:')
for t1, result in zip(t1s, nlinresults):
print(t1, ':', result)
```
This diff is collapsed.
Click to expand it.
advanced_topics/07_threading.md
0 → 100644
+
516
−
0
View file @
6ad4b884
# Threading and parallel processing
The Python language has built-in support for multi-threading in the
[
`threading`
](
https://docs.python.org/3.5/library/threading.html
)
module, and
true parallelism in the
[
`multiprocessing`
](
https://docs.python.org/3.5/library/multiprocessing.html
)
module. If you want to be impressed, skip straight to the section on
[
`multiprocessing`
](
todo
)
.
## Threading
The
[
`threading`
](
https://docs.python.org/3.5/library/threading.html
)
module
provides a traditional multi-threading API that should be familiar to you if
you have worked with threads in other languages.
Running a task in a separate thread in Python is easy - simply create a
`Thread`
object, and pass it the function or method that you want it to
run. Then call its
`start`
method:
```
import time
import threading
def longRunningTask(niters):
for i in range(niters):
if i % 2 == 0: print('Tick')
else: print('Tock')
time.sleep(0.5)
t = threading.Thread(target=longRunningTask, args=(8,))
t.start()
while t.is_alive():
time.sleep(0.4)
print('Waiting for thread to finish...')
print('Finished!')
```
You can also
`join`
a thread, which will block execution in the current thread
until the thread that has been
`join`
ed has finished:
```
t = threading.Thread(target=longRunningTask, args=(6, ))
t.start()
print('Joining thread ...')
t.join()
print('Finished!')
```
### Subclassing `Thread`
It is also possible to sub-class the
`Thread`
class, and override its
`run`
method:
```
class LongRunningThread(threading.Thread):
def __init__(self, niters, *args, **kwargs):
super().__init__(*args, **kwargs)
self.niters = niters
def run(self):
for i in range(self.niters):
if i % 2 == 0: print('Tick')
else: print('Tock')
time.sleep(0.5)
t = LongRunningThread(6)
t.start()
t.join()
print('Done')
```
### Daemon threads
By default, a Python application will not exit until _all_ active threads have
finished execution. If you want to run a task in the background for the
duration of your application, you can mark it as a
`daemon`
thread - when all
non-daemon threads in a Python application have finished, all daemon threads
will be halted, and the application will exit.
You can mark a thread as being a daemon by setting an attribute on it after
creation:
```
t = threading.Thread(target=longRunningTask)
t.daemon = True
```
See the
[
`Thread`
documentation
](
https://docs.python.org/3.5/library/threading.html#thread-objects
)
for more details.
### Thread synchronisation
The
`threading`
module provides some useful thread-synchronisation primitives
-
the
`Lock`
,
`RLock`
(re-entrant
`Lock`
), and
`Event`
classes. The
`threading`
module also provides
`Condition`
and
`Semaphore`
classes - refer
to the
[
documentation
](
https://docs.python.org/3.5/library/threading.html
)
for
more details.
#### `Lock`
The
[
`Lock`
](
https://docs.python.org/3.5/library/threading.html#lock-objects
)
class (and its re-entrant version, the
[
`RLock`
](
https://docs.python.org/3.5/library/threading.html#rlock-objects
)
)
prevents a block of code from being accessed by more than one thread at a
time. For example, if we have multiple threads running this
`task`
function,
their
[
outputs
](
https://www.youtube.com/watch?v=F5fUFnfPpYU
)
will inevitably
become intertwined:
```
def task():
for i in range(5):
print('{} Woozle '.format(i), end='')
time.sleep(0.1)
print('Wuzzle')
threads = [threading.Thread(target=task) for i in range(5)]
for t in threads:
t.start()
```
But if we protect the critical section with a
`Lock`
object, the output will
look more sensible:
```
lock = threading.Lock()
def task():
for i in range(5):
with lock:
print('{} Woozle '.format(i), end='')
time.sleep(0.1)
print('Wuzzle')
threads = [threading.Thread(target=task) for i in range(5)]
for t in threads:
t.start()
```
> Instead of using a `Lock` object in a `with` statement, it is also possible
> to manually call its `acquire` and `release` methods:
>
> def task():
> for i in range(5):
> lock.acquire()
> print('{} Woozle '.format(i), end='')
> time.sleep(0.1)
> print('Wuzzle')
> lock.release()
Python does not have any built-in constructs to implement
`Lock`
-based mutual
exclusion across several functions or methods - each function/method must
explicitly acquire/release a shared
`Lock`
instance. However, it is relatively
straightforward to implement a decorator which does this for you:
```
def mutex(func, lock):
def wrapper(*args):
with lock:
func(*args)
return wrapper
class MyClass(object):
def __init__(self):
lock = threading.Lock()
self.safeFunc1 = mutex(self.safeFunc1, lock)
self.safeFunc2 = mutex(self.safeFunc2, lock)
def safeFunc1(self):
time.sleep(0.1)
print('safeFunc1 start')
time.sleep(0.2)
print('safeFunc1 end')
def safeFunc2(self):
time.sleep(0.1)
print('safeFunc2 start')
time.sleep(0.2)
print('safeFunc2 end')
mc = MyClass()
f1threads = [threading.Thread(target=mc.safeFunc1) for i in range(4)]
f2threads = [threading.Thread(target=mc.safeFunc2) for i in range(4)]
for t in f1threads + f2threads:
t.start()
```
Try removing the
`mutex`
lock from the two methods in the above code, and see
what it does to the output.
#### `Event`
The
[
`Event`
](
https://docs.python.org/3.5/library/threading.html#event-objects
)
class is essentially a boolean
[
semaphore
][
semaphore-wiki
]
. It can be used to
signal events between threads. Threads can
`wait`
on the event, and be awoken
when the event is
`set`
by another thread:
[
semaphore-wiki
]:
https://en.wikipedia.org/wiki/Semaphore_(programming)
```
import numpy as np
processingFinished = threading.Event()
def processData(data):
print('Processing data ...')
time.sleep(2)
print('Result: {}'.format(data.mean()))
processingFinished.set()
data = np.random.randint(1, 100, 100)
t = threading.Thread(target=processData, args=(data,))
t.start()
processingFinished.wait()
print('Processing finished!')
```
### The Global Interpreter Lock (GIL)
The
[
_Global Interpreter
Lock_
](
https://docs.python.org/3/c-api/init.html#thread-state-and-the-global-interpreter-lock
)
is an implementation detail of
[
CPython
](
https://github.com/python/cpython
)
(the official Python interpreter). The GIL means that a multi-threaded
program written in pure Python is not able to take advantage of multiple
cores - this essentially means that only one thread may be executing at any
point in time.
The
`threading`
module does still have its uses though, as this GIL problem
does not affect tasks which involve calls to system or natively compiled
libraries (e.g. file and network I/O, Numpy operations, etc.). So you can,
for example, perform some expensive processing on a Numpy array in a thread
running on one core, whilst having another thread (e.g. user interaction)
running on another core.
## Multiprocessing
For true parallelism, you should check out the
[
`multiprocessing`
](
https://docs.python.org/3.5/library/multiprocessing.html
)
module.
The
`multiprocessing`
module spawns sub-processes, rather than threads, and so
is not subject to the GIL constraints that the
`threading`
module suffers
from. It provides two APIs - a "traditional" equivalent to that provided by
the
`threading`
module, and a powerful higher-level API.
### `threading`-equivalent API
The
[
`Process`
](
https://docs.python.org/3.5/library/multiprocessing.html#the-process-class
)
class is the
`multiprocessing`
equivalent of the
[
`threading.Thread`
](
https://docs.python.org/3.5/library/threading.html#thread-objects
)
class.
`multprocessing`
also has equivalents of the
[
`Lock` and `Event`
classes
](
https://docs.python.org/3.5/library/multiprocessing.html#synchronization-between-processes
)
,
and the other synchronisation primitives provided by
`threading`
.
So you can simply replace
`threading.Thread`
with
`multiprocessing.Process`
,
and you will have true parallelism.
Because your "threads" are now independent processes, you need to be a little
careful about how to share information across them. Fortunately, the
`multiprocessing`
module provides
[
`Queue` and `Pipe`
classes
](
https://docs.python.org/3.5/library/multiprocessing.html#exchanging-objects-between-processes
)
which make it easy to share data across processes.
### Higher-level API - the `multiprocessing.Pool`
The real advantages of
`multiprocessing`
lie in its higher level API, centered
around the
[
`Pool`
class
](
https://docs.python.org/3.5/library/multiprocessing.html#using-a-pool-of-workers
)
.
Essentially, you create a
`Pool`
of worker processes - you specify the number
of processes when you create the pool.
> The best number of processes to use for a `Pool` will depend on the system
> you are running on (number of cores), and the tasks you are running (e.g.
> I/O bound or CPU bound).
Once you have created a
`Pool`
, you can use its methods to automatically
parallelise tasks. The most useful are the
`map`
,
`starmap`
and
`apply_async`
methods.
#### `Pool.map`
The
[
`Pool.map`
](
https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.Pool.map
)
method is the multiprocessing equivalent of the built-in
[
`map`
](
https://docs.python.org/3.5/library/functions.html#map
)
function - it
is given a function, and a sequence, and it applies the function to each
element in the sequence.
```
import time
import multiprocessing as mp
import numpy as np
def crunchImage(imgfile):
# Load a nifti image, do stuff
# to it. Use your imagination
# to fill in this function.
time.sleep(2)
# numpy's random number generator
# will be initialised in the same
# way in each process, so let's
# re-seed it.
np.random.seed()
result = np.random.randint(1, 100, 1)
print(imgfile, ':', result)
return result
imgfiles = ['{:02d}.nii.gz'.format(i) for i in range(20)]
p = mp.Pool(processes=16)
print('Crunching images...')
start = time.time()
results = p.map(crunchImage, imgfiles)
end = time.time()
print('Total execution time: {:0.2f} seconds'.format(end - start))
```
The
`Pool.map`
method only works with functions that accept one argument, such
as our
`crunchImage`
function above. If you have a function which accepts
multiple arguments, use the
[
`Pool.starmap`
](
https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.Pool.starmap
)
method instead:
```
def crunchImage(imgfile, modality):
time.sleep(2)
np.random.seed()
if modality == 't1':
result = np.random.randint(1, 100, 1)
elif modality == 't2':
result = np.random.randint(100, 200, 1)
print(imgfile, ': ', result)
return result
imgfiles = ['t1_{:02d}.nii.gz'.format(i) for i in range(10)] + \
['t2_{:02d}.nii.gz'.format(i) for i in range(10)]
modalities = ['t1'] * 10 + ['t2'] * 10
pool = mp.Pool(processes=16)
args = [(f, m) for f, m in zip(imgfiles, modalities)]
print('Crunching images...')
start = time.time()
results = pool.starmap(crunchImage, args)
end = time.time()
print('Total execution time: {:0.2f} seconds'.format(end - start))
```
The
`map`
and
`starmap`
methods also have asynchronous equivalents
`map_async`
and
`starmap_async`
, which return immediately. Refer to the
[
`Pool`
](
https://docs.python.org/3.5/library/multiprocessing.html#module-multiprocessing.pool
)
documentation for more details.
#### `Pool.apply_async`
The
[
`Pool.apply`
](
https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.Pool.apply
)
method will execute a function on one of the processes, and block until it has
finished. The
[
`Pool.apply_async`
](
https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.Pool.apply_async
)
method returns immediately, and is thus more suited to asynchronously
scheduling multiple jobs to run in parallel.
`apply_async`
returns an object of type
[
`AsyncResult`
](
https://docs.python.org/3.5/library/multiprocessing.html#multiprocessing.pool.AsyncResult
)
.
An
`AsyncResult`
object has
`wait`
and
`get`
methods which will block until
the job has completed.
```
import time
import multiprocessing as mp
import numpy as np
def linear_registration(src, ref):
time.sleep(1)
return np.eye(4)
def nonlinear_registration(src, ref, affine):
time.sleep(3)
# this number represents a non-linear warp
# field - use your imagination people!
np.random.seed()
return np.random.randint(1, 100, 1)
t1s = ['{:02d}_t1.nii.gz'.format(i) for i in range(20)]
std = 'MNI152_T1_2mm.nii.gz'
pool = mp.Pool(processes=16)
print('Running structural-to-standard registration '
'on {} subjects...'.format(len(t1s)))
# Run linear registration on all the T1s.
#
# We build a list of AsyncResult objects
linresults = [pool.apply_async(linear_registration, (t1, std))
for t1 in t1s]
# Then we wait for each job to finish,
# and replace its AsyncResult object
# with the actual result - an affine
# transformation matrix.
start = time.time()
for i, r in enumerate(linresults):
linresults[i] = r.get()
end = time.time()
print('Linear registrations completed in '
'{:0.2f} seconds'.format(end - start))
# Run non-linear registration on all the T1s,
# using the linear registrations to initialise.
nlinresults = [pool.apply_async(nonlinear_registration, (t1, std, aff))
for (t1, aff) in zip(t1s, linresults)]
# Wait for each non-linear reg to finish,
# and store the resulting warp field.
start = time.time()
for i, r in enumerate(nlinresults):
nlinresults[i] = r.get()
end = time.time()
print('Non-linear registrations completed in '
'{:0.2f} seconds'.format(end - start))
print('Non linear registrations:')
for t1, result in zip(t1s, nlinresults):
print(t1, ':', result)
```
This diff is collapsed.
Click to expand it.
advanced_topics/README.md
+
1
−
1
View file @
6ad4b884
...
...
@@ -15,4 +15,4 @@ order, but we recommend going through them in this order:
4.
Operator overloading
5.
Context managers
6.
Decorators
7.
T
est
ing
7.
T
hreading and parallel process
ing
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment