Show More
@@ -1,847 +1,847 b'' | |||
|
1 | 1 | .. _parallel_multiengine: |
|
2 | 2 | |
|
3 | 3 | ========================== |
|
4 | 4 | IPython's Direct interface |
|
5 | 5 | ========================== |
|
6 | 6 | |
|
7 | 7 | The direct, or multiengine, interface represents one possible way of working with a set of |
|
8 | 8 | IPython engines. The basic idea behind the multiengine interface is that the |
|
9 | 9 | capabilities of each engine are directly and explicitly exposed to the user. |
|
10 | 10 | Thus, in the multiengine interface, each engine is given an id that is used to |
|
11 | 11 | identify the engine and give it work to do. This interface is very intuitive |
|
12 | 12 | and is designed with interactive usage in mind, and is the best place for |
|
13 | 13 | new users of IPython to begin. |
|
14 | 14 | |
|
15 | 15 | Starting the IPython controller and engines |
|
16 | 16 | =========================================== |
|
17 | 17 | |
|
18 | 18 | To follow along with this tutorial, you will need to start the IPython |
|
19 | 19 | controller and four IPython engines. The simplest way of doing this is to use |
|
20 | 20 | the :command:`ipcluster` command:: |
|
21 | 21 | |
|
22 | 22 | $ ipcluster start --n=4 |
|
23 | 23 | |
|
24 | 24 | For more detailed information about starting the controller and engines, see |
|
25 | 25 | our :ref:`introduction <ip1par>` to using IPython for parallel computing. |
|
26 | 26 | |
|
27 | 27 | Creating a ``Client`` instance |
|
28 | 28 | ============================== |
|
29 | 29 | |
|
30 | 30 | The first step is to import the IPython :mod:`IPython.parallel` |
|
31 | 31 | module and then create a :class:`.Client` instance: |
|
32 | 32 | |
|
33 | 33 | .. sourcecode:: ipython |
|
34 | 34 | |
|
35 | 35 | In [1]: from IPython.parallel import Client |
|
36 | 36 | |
|
37 | 37 | In [2]: rc = Client() |
|
38 | 38 | |
|
39 | 39 | This form assumes that the default connection information (stored in |
|
40 | 40 | :file:`ipcontroller-client.json` found in :file:`IPYTHON_DIR/profile_default/security`) is |
|
41 | 41 | accurate. If the controller was started on a remote machine, you must copy that connection |
|
42 | 42 | file to the client machine, or enter its contents as arguments to the Client constructor: |
|
43 | 43 | |
|
44 | 44 | .. sourcecode:: ipython |
|
45 | 45 | |
|
46 | 46 | # If you have copied the json connector file from the controller: |
|
47 | 47 | In [2]: rc = Client('/path/to/ipcontroller-client.json') |
|
48 | 48 | # or to connect with a specific profile you have set up: |
|
49 | 49 | In [3]: rc = Client(profile='mpi') |
|
50 | 50 | |
|
51 | 51 | |
|
52 | 52 | To make sure there are engines connected to the controller, users can get a list |
|
53 | 53 | of engine ids: |
|
54 | 54 | |
|
55 | 55 | .. sourcecode:: ipython |
|
56 | 56 | |
|
57 | 57 | In [3]: rc.ids |
|
58 | 58 | Out[3]: [0, 1, 2, 3] |
|
59 | 59 | |
|
60 | 60 | Here we see that there are four engines ready to do work for us. |
|
61 | 61 | |
|
62 | 62 | For direct execution, we will make use of a :class:`DirectView` object, which can be |
|
63 | 63 | constructed via list-access to the client: |
|
64 | 64 | |
|
65 | 65 | .. sourcecode:: ipython |
|
66 | 66 | |
|
67 | 67 | In [4]: dview = rc[:] # use all engines |
|
68 | 68 | |
|
69 | 69 | .. seealso:: |
|
70 | 70 | |
|
71 | 71 | For more information, see the in-depth explanation of :ref:`Views <parallel_details>`. |
|
72 | 72 | |
|
73 | 73 | |
|
74 | 74 | Quick and easy parallelism |
|
75 | 75 | ========================== |
|
76 | 76 | |
|
77 | 77 | In many cases, you simply want to apply a Python function to a sequence of |
|
78 | 78 | objects, but *in parallel*. The client interface provides a simple way |
|
79 | 79 | of accomplishing this: using the DirectView's :meth:`~DirectView.map` method. |
|
80 | 80 | |
|
81 | 81 | Parallel map |
|
82 | 82 | ------------ |
|
83 | 83 | |
|
84 | 84 | Python's builtin :func:`map` functions allows a function to be applied to a |
|
85 | 85 | sequence element-by-element. This type of code is typically trivial to |
|
86 | 86 | parallelize. In fact, since IPython's interface is all about functions anyway, |
|
87 | 87 | you can just use the builtin :func:`map` with a :class:`RemoteFunction`, or a |
|
88 | 88 | DirectView's :meth:`map` method: |
|
89 | 89 | |
|
90 | 90 | .. sourcecode:: ipython |
|
91 | 91 | |
|
92 | 92 | In [62]: serial_result = map(lambda x:x**10, range(32)) |
|
93 | 93 | |
|
94 | 94 | In [63]: parallel_result = dview.map_sync(lambda x: x**10, range(32)) |
|
95 | 95 | |
|
96 | 96 | In [67]: serial_result==parallel_result |
|
97 | 97 | Out[67]: True |
|
98 | 98 | |
|
99 | 99 | |
|
100 | 100 | .. note:: |
|
101 | 101 | |
|
102 | 102 | The :class:`DirectView`'s version of :meth:`map` does |
|
103 | 103 | not do dynamic load balancing. For a load balanced version, use a |
|
104 | 104 | :class:`LoadBalancedView`. |
|
105 | 105 | |
|
106 | 106 | .. seealso:: |
|
107 | 107 | |
|
108 | 108 | :meth:`map` is implemented via :class:`ParallelFunction`. |
|
109 | 109 | |
|
110 | 110 | Remote function decorators |
|
111 | 111 | -------------------------- |
|
112 | 112 | |
|
113 | 113 | Remote functions are just like normal functions, but when they are called, |
|
114 | 114 | they execute on one or more engines, rather than locally. IPython provides |
|
115 | 115 | two decorators: |
|
116 | 116 | |
|
117 | 117 | .. sourcecode:: ipython |
|
118 | 118 | |
|
119 | 119 | In [10]: @dview.remote(block=True) |
|
120 | 120 | ...: def getpid(): |
|
121 | 121 | ...: import os |
|
122 | 122 | ...: return os.getpid() |
|
123 | 123 | ...: |
|
124 | 124 | |
|
125 | 125 | In [11]: getpid() |
|
126 | 126 | Out[11]: [12345, 12346, 12347, 12348] |
|
127 | 127 | |
|
128 | 128 | The ``@parallel`` decorator creates parallel functions, that break up an element-wise |
|
129 | 129 | operations and distribute them, reconstructing the result. |
|
130 | 130 | |
|
131 | 131 | .. sourcecode:: ipython |
|
132 | 132 | |
|
133 | 133 | In [12]: import numpy as np |
|
134 | 134 | |
|
135 | 135 | In [13]: A = np.random.random((64,48)) |
|
136 | 136 | |
|
137 | 137 | In [14]: @dview.parallel(block=True) |
|
138 | 138 | ...: def pmul(A,B): |
|
139 | 139 | ...: return A*B |
|
140 | 140 | |
|
141 | 141 | In [15]: C_local = A*A |
|
142 | 142 | |
|
143 | 143 | In [16]: C_remote = pmul(A,A) |
|
144 | 144 | |
|
145 | 145 | In [17]: (C_local == C_remote).all() |
|
146 | 146 | Out[17]: True |
|
147 | 147 | |
|
148 | 148 | .. seealso:: |
|
149 | 149 | |
|
150 | 150 | See the docstrings for the :func:`parallel` and :func:`remote` decorators for |
|
151 | 151 | options. |
|
152 | 152 | |
|
153 | 153 | Calling Python functions |
|
154 | 154 | ======================== |
|
155 | 155 | |
|
156 | 156 | The most basic type of operation that can be performed on the engines is to |
|
157 | 157 | execute Python code or call Python functions. Executing Python code can be |
|
158 | 158 | done in blocking or non-blocking mode (non-blocking is default) using the |
|
159 | 159 | :meth:`.View.execute` method, and calling functions can be done via the |
|
160 | 160 | :meth:`.View.apply` method. |
|
161 | 161 | |
|
162 | 162 | apply |
|
163 | 163 | ----- |
|
164 | 164 | |
|
165 | 165 | The main method for doing remote execution (in fact, all methods that |
|
166 | 166 | communicate with the engines are built on top of it), is :meth:`View.apply`. |
|
167 | 167 | |
|
168 | 168 | We strive to provide the cleanest interface we can, so `apply` has the following |
|
169 | 169 | signature: |
|
170 | 170 | |
|
171 | 171 | .. sourcecode:: python |
|
172 | 172 | |
|
173 | 173 | view.apply(f, *args, **kwargs) |
|
174 | 174 | |
|
175 | 175 | There are various ways to call functions with IPython, and these flags are set as |
|
176 | 176 | attributes of the View. The ``DirectView`` has just two of these flags: |
|
177 | 177 | |
|
178 | 178 | dv.block : bool |
|
179 | 179 | whether to wait for the result, or return an :class:`AsyncResult` object |
|
180 | 180 | immediately |
|
181 | 181 | dv.track : bool |
|
182 | 182 | whether to instruct pyzmq to track when |
|
183 | 183 | This is primarily useful for non-copying sends of numpy arrays that you plan to |
|
184 | 184 | edit in-place. You need to know when it becomes safe to edit the buffer |
|
185 | 185 | without corrupting the message. |
|
186 | 186 | |
|
187 | 187 | |
|
188 | 188 | Creating a view is simple: index-access on a client creates a :class:`.DirectView`. |
|
189 | 189 | |
|
190 | 190 | .. sourcecode:: ipython |
|
191 | 191 | |
|
192 | 192 | In [4]: view = rc[1:3] |
|
193 | 193 | Out[4]: <DirectView [1, 2]> |
|
194 | 194 | |
|
195 | 195 | In [5]: view.apply<tab> |
|
196 | 196 | view.apply view.apply_async view.apply_sync |
|
197 | 197 | |
|
198 | 198 | For convenience, you can set block temporarily for a single call with the extra sync/async methods. |
|
199 | 199 | |
|
200 | 200 | Blocking execution |
|
201 | 201 | ------------------ |
|
202 | 202 | |
|
203 | 203 | In blocking mode, the :class:`.DirectView` object (called ``dview`` in |
|
204 | 204 | these examples) submits the command to the controller, which places the |
|
205 | 205 | command in the engines' queues for execution. The :meth:`apply` call then |
|
206 | 206 | blocks until the engines are done executing the command: |
|
207 | 207 | |
|
208 | 208 | .. sourcecode:: ipython |
|
209 | 209 | |
|
210 | 210 | In [2]: dview = rc[:] # A DirectView of all engines |
|
211 | 211 | In [3]: dview.block=True |
|
212 | 212 | In [4]: dview['a'] = 5 |
|
213 | 213 | |
|
214 | 214 | In [5]: dview['b'] = 10 |
|
215 | 215 | |
|
216 | 216 | In [6]: dview.apply(lambda x: a+b+x, 27) |
|
217 | 217 | Out[6]: [42, 42, 42, 42] |
|
218 | 218 | |
|
219 | 219 | You can also select blocking execution on a call-by-call basis with the :meth:`apply_sync` |
|
220 | 220 | method: |
|
221 | 221 | |
|
222 | 222 | In [7]: dview.block=False |
|
223 | 223 | |
|
224 | 224 | In [8]: dview.apply_sync(lambda x: a+b+x, 27) |
|
225 | 225 | Out[8]: [42, 42, 42, 42] |
|
226 | 226 | |
|
227 | 227 | Python commands can be executed as strings on specific engines by using a View's ``execute`` |
|
228 | 228 | method: |
|
229 | 229 | |
|
230 | 230 | .. sourcecode:: ipython |
|
231 | 231 | |
|
232 | 232 | In [6]: rc[::2].execute('c=a+b') |
|
233 | 233 | |
|
234 | 234 | In [7]: rc[1::2].execute('c=a-b') |
|
235 | 235 | |
|
236 | 236 | In [8]: dview['c'] # shorthand for dview.pull('c', block=True) |
|
237 | 237 | Out[8]: [15, -5, 15, -5] |
|
238 | 238 | |
|
239 | 239 | |
|
240 | 240 | Non-blocking execution |
|
241 | 241 | ---------------------- |
|
242 | 242 | |
|
243 | 243 | In non-blocking mode, :meth:`apply` submits the command to be executed and |
|
244 | 244 | then returns a :class:`AsyncResult` object immediately. The |
|
245 | 245 | :class:`AsyncResult` object gives you a way of getting a result at a later |
|
246 | 246 | time through its :meth:`get` method. |
|
247 | 247 | |
|
248 | 248 | .. Note:: |
|
249 | 249 | |
|
250 | 250 | The :class:`AsyncResult` object provides a superset of the interface in |
|
251 | 251 | :py:class:`multiprocessing.pool.AsyncResult`. See the |
|
252 | 252 | `official Python documentation <http://docs.python.org/library/multiprocessing#multiprocessing.pool.AsyncResult>`_ |
|
253 | 253 | for more. |
|
254 | 254 | |
|
255 | 255 | |
|
256 | 256 | This allows you to quickly submit long running commands without blocking your |
|
257 | 257 | local Python/IPython session: |
|
258 | 258 | |
|
259 | 259 | .. sourcecode:: ipython |
|
260 | 260 | |
|
261 | 261 | # define our function |
|
262 | 262 | In [6]: def wait(t): |
|
263 | 263 | ...: import time |
|
264 | 264 | ...: tic = time.time() |
|
265 | 265 | ...: time.sleep(t) |
|
266 | 266 | ...: return time.time()-tic |
|
267 | 267 | |
|
268 | 268 | # In non-blocking mode |
|
269 | 269 | In [7]: ar = dview.apply_async(wait, 2) |
|
270 | 270 | |
|
271 | 271 | # Now block for the result |
|
272 | 272 | In [8]: ar.get() |
|
273 | 273 | Out[8]: [2.0006198883056641, 1.9997570514678955, 1.9996809959411621, 2.0003249645233154] |
|
274 | 274 | |
|
275 | 275 | # Again in non-blocking mode |
|
276 | 276 | In [9]: ar = dview.apply_async(wait, 10) |
|
277 | 277 | |
|
278 | 278 | # Poll to see if the result is ready |
|
279 | 279 | In [10]: ar.ready() |
|
280 | 280 | Out[10]: False |
|
281 | 281 | |
|
282 | 282 | # ask for the result, but wait a maximum of 1 second: |
|
283 | 283 | In [45]: ar.get(1) |
|
284 | 284 | --------------------------------------------------------------------------- |
|
285 | 285 | TimeoutError Traceback (most recent call last) |
|
286 | 286 | /home/you/<ipython-input-45-7cd858bbb8e0> in <module>() |
|
287 | 287 | ----> 1 ar.get(1) |
|
288 | 288 | |
|
289 | 289 | /path/to/site-packages/IPython/parallel/asyncresult.pyc in get(self, timeout) |
|
290 | 290 | 62 raise self._exception |
|
291 | 291 | 63 else: |
|
292 | 292 | ---> 64 raise error.TimeoutError("Result not ready.") |
|
293 | 293 | 65 |
|
294 | 294 | 66 def ready(self): |
|
295 | 295 | |
|
296 | 296 | TimeoutError: Result not ready. |
|
297 | 297 | |
|
298 | 298 | .. Note:: |
|
299 | 299 | |
|
300 | 300 | Note the import inside the function. This is a common model, to ensure |
|
301 | 301 | that the appropriate modules are imported where the task is run. You can |
|
302 | 302 | also manually import modules into the engine(s) namespace(s) via |
|
303 | 303 | :meth:`view.execute('import numpy')`. |
|
304 | 304 | |
|
305 | 305 | Often, it is desirable to wait until a set of :class:`AsyncResult` objects |
|
306 | 306 | are done. For this, there is a the method :meth:`wait`. This method takes a |
|
307 | 307 | tuple of :class:`AsyncResult` objects (or `msg_ids` or indices to the client's History), |
|
308 | 308 | and blocks until all of the associated results are ready: |
|
309 | 309 | |
|
310 | 310 | .. sourcecode:: ipython |
|
311 | 311 | |
|
312 | 312 | In [72]: dview.block=False |
|
313 | 313 | |
|
314 | 314 | # A trivial list of AsyncResults objects |
|
315 | 315 | In [73]: pr_list = [dview.apply_async(wait, 3) for i in range(10)] |
|
316 | 316 | |
|
317 | 317 | # Wait until all of them are done |
|
318 | 318 | In [74]: dview.wait(pr_list) |
|
319 | 319 | |
|
320 | 320 | # Then, their results are ready using get() or the `.r` attribute |
|
321 | 321 | In [75]: pr_list[0].get() |
|
322 | 322 | Out[75]: [2.9982571601867676, 2.9982588291168213, 2.9987530708312988, 2.9990990161895752] |
|
323 | 323 | |
|
324 | 324 | |
|
325 | 325 | |
|
326 | 326 | The ``block`` and ``targets`` keyword arguments and attributes |
|
327 | 327 | -------------------------------------------------------------- |
|
328 | 328 | |
|
329 | 329 | Most DirectView methods (excluding :meth:`apply` and :meth:`map`) accept ``block`` and |
|
330 | 330 | ``targets`` as keyword arguments. As we have seen above, these keyword arguments control the |
|
331 | 331 | blocking mode and which engines the command is applied to. The :class:`View` class also has |
|
332 | 332 | :attr:`block` and :attr:`targets` attributes that control the default behavior when the keyword |
|
333 | 333 | arguments are not provided. Thus the following logic is used for :attr:`block` and :attr:`targets`: |
|
334 | 334 | |
|
335 | 335 | * If no keyword argument is provided, the instance attributes are used. |
|
336 | 336 | * Keyword argument, if provided override the instance attributes for |
|
337 | 337 | the duration of a single call. |
|
338 | 338 | |
|
339 | 339 | The following examples demonstrate how to use the instance attributes: |
|
340 | 340 | |
|
341 | 341 | .. sourcecode:: ipython |
|
342 | 342 | |
|
343 | 343 | In [16]: dview.targets = [0,2] |
|
344 | 344 | |
|
345 | 345 | In [17]: dview.block = False |
|
346 | 346 | |
|
347 | 347 | In [18]: ar = dview.apply(lambda : 10) |
|
348 | 348 | |
|
349 | 349 | In [19]: ar.get() |
|
350 | 350 | Out[19]: [10, 10] |
|
351 | 351 | |
|
352 | 352 | In [16]: dview.targets = v.client.ids # all engines (4) |
|
353 | 353 | |
|
354 | 354 | In [21]: dview.block = True |
|
355 | 355 | |
|
356 | 356 | In [22]: dview.apply(lambda : 42) |
|
357 | 357 | Out[22]: [42, 42, 42, 42] |
|
358 | 358 | |
|
359 | 359 | The :attr:`block` and :attr:`targets` instance attributes of the |
|
360 | 360 | :class:`.DirectView` also determine the behavior of the parallel magic commands. |
|
361 | 361 | |
|
362 | 362 | Parallel magic commands |
|
363 | 363 | ----------------------- |
|
364 | 364 | |
|
365 | 365 | .. warning:: |
|
366 | 366 | |
|
367 | 367 | The magics have not been changed to work with the zeromq system. The |
|
368 | 368 | magics do work, but *do not* print stdin/out like they used to in IPython.kernel. |
|
369 | 369 | |
|
370 | 370 | We provide a few IPython magic commands (``%px``, ``%autopx`` and ``%result``) |
|
371 | 371 | that make it more pleasant to execute Python commands on the engines |
|
372 | 372 | interactively. These are simply shortcuts to :meth:`execute` and |
|
373 | 373 | :meth:`get_result` of the :class:`DirectView`. The ``%px`` magic executes a single |
|
374 | 374 | Python command on the engines specified by the :attr:`targets` attribute of the |
|
375 | 375 | :class:`DirectView` instance: |
|
376 | 376 | |
|
377 | 377 | .. sourcecode:: ipython |
|
378 | 378 | |
|
379 | 379 | # load the parallel magic extension: |
|
380 | 380 | In [21]: %load_ext parallelmagic |
|
381 | 381 | |
|
382 | 382 | # Create a DirectView for all targets |
|
383 | 383 | In [22]: dv = rc[:] |
|
384 | 384 | |
|
385 | 385 | # Make this DirectView active for parallel magic commands |
|
386 | 386 | In [23]: dv.activate() |
|
387 | 387 | |
|
388 | 388 | In [24]: dv.block=True |
|
389 | 389 | |
|
390 | 390 | In [25]: import numpy |
|
391 | 391 | |
|
392 | 392 | In [26]: %px import numpy |
|
393 | 393 | Parallel execution on engines: [0, 1, 2, 3] |
|
394 | 394 | |
|
395 | 395 | In [27]: %px a = numpy.random.rand(2,2) |
|
396 | 396 | Parallel execution on engines: [0, 1, 2, 3] |
|
397 | 397 | |
|
398 | 398 | In [28]: %px ev = numpy.linalg.eigvals(a) |
|
399 | 399 | Parallel execution on engines: [0, 1, 2, 3] |
|
400 | 400 | |
|
401 | 401 | In [28]: dv['ev'] |
|
402 | 402 | Out[28]: [ array([ 1.09522024, -0.09645227]), |
|
403 | 403 | array([ 1.21435496, -0.35546712]), |
|
404 | 404 | array([ 0.72180653, 0.07133042]), |
|
405 | 405 | array([ 1.46384341e+00, 1.04353244e-04]) |
|
406 | 406 | ] |
|
407 | 407 | |
|
408 | 408 | The ``%result`` magic gets the most recent result, or takes an argument |
|
409 | 409 | specifying the index of the result to be requested. It is simply a shortcut to the |
|
410 | 410 | :meth:`get_result` method: |
|
411 | 411 | |
|
412 | 412 | .. sourcecode:: ipython |
|
413 | 413 | |
|
414 | 414 | In [29]: dv.apply_async(lambda : ev) |
|
415 | 415 | |
|
416 | 416 | In [30]: %result |
|
417 | 417 | Out[30]: [ [ 1.28167017 0.14197338], |
|
418 | 418 | [-0.14093616 1.27877273], |
|
419 | 419 | [-0.37023573 1.06779409], |
|
420 | 420 | [ 0.83664764 -0.25602658] ] |
|
421 | 421 | |
|
422 | 422 | The ``%autopx`` magic switches to a mode where everything you type is executed |
|
423 | 423 | on the engines given by the :attr:`targets` attribute: |
|
424 | 424 | |
|
425 | 425 | .. sourcecode:: ipython |
|
426 | 426 | |
|
427 | 427 | In [30]: dv.block=False |
|
428 | 428 | |
|
429 | 429 | In [31]: %autopx |
|
430 | 430 | Auto Parallel Enabled |
|
431 | 431 | Type %autopx to disable |
|
432 | 432 | |
|
433 | 433 | In [32]: max_evals = [] |
|
434 | 434 | <IPython.parallel.AsyncResult object at 0x17b8a70> |
|
435 | 435 | |
|
436 | 436 | In [33]: for i in range(100): |
|
437 | 437 | ....: a = numpy.random.rand(10,10) |
|
438 | 438 | ....: a = a+a.transpose() |
|
439 | 439 | ....: evals = numpy.linalg.eigvals(a) |
|
440 | 440 | ....: max_evals.append(evals[0].real) |
|
441 | 441 | ....: |
|
442 | 442 | ....: |
|
443 | 443 | <IPython.parallel.AsyncResult object at 0x17af8f0> |
|
444 | 444 | |
|
445 | 445 | In [34]: %autopx |
|
446 | 446 | Auto Parallel Disabled |
|
447 | 447 | |
|
448 | 448 | In [35]: dv.block=True |
|
449 | 449 | |
|
450 | 450 | In [36]: px ans= "Average max eigenvalue is: %f"%(sum(max_evals)/len(max_evals)) |
|
451 | 451 | Parallel execution on engines: [0, 1, 2, 3] |
|
452 | 452 | |
|
453 | 453 | In [37]: dv['ans'] |
|
454 | 454 | Out[37]: [ 'Average max eigenvalue is: 10.1387247332', |
|
455 | 455 | 'Average max eigenvalue is: 10.2076902286', |
|
456 | 456 | 'Average max eigenvalue is: 10.1891484655', |
|
457 | 457 | 'Average max eigenvalue is: 10.1158837784',] |
|
458 | 458 | |
|
459 | 459 | |
|
460 | 460 | Moving Python objects around |
|
461 | 461 | ============================ |
|
462 | 462 | |
|
463 | 463 | In addition to calling functions and executing code on engines, you can |
|
464 | 464 | transfer Python objects to and from your IPython session and the engines. In |
|
465 | 465 | IPython, these operations are called :meth:`push` (sending an object to the |
|
466 | 466 | engines) and :meth:`pull` (getting an object from the engines). |
|
467 | 467 | |
|
468 | 468 | Basic push and pull |
|
469 | 469 | ------------------- |
|
470 | 470 | |
|
471 | 471 | Here are some examples of how you use :meth:`push` and :meth:`pull`: |
|
472 | 472 | |
|
473 | 473 | .. sourcecode:: ipython |
|
474 | 474 | |
|
475 | 475 | In [38]: dview.push(dict(a=1.03234,b=3453)) |
|
476 | 476 | Out[38]: [None,None,None,None] |
|
477 | 477 | |
|
478 | 478 | In [39]: dview.pull('a') |
|
479 | 479 | Out[39]: [ 1.03234, 1.03234, 1.03234, 1.03234] |
|
480 | 480 | |
|
481 | 481 | In [40]: dview.pull('b', targets=0) |
|
482 | 482 | Out[40]: 3453 |
|
483 | 483 | |
|
484 | 484 | In [41]: dview.pull(('a','b')) |
|
485 | 485 | Out[41]: [ [1.03234, 3453], [1.03234, 3453], [1.03234, 3453], [1.03234, 3453] ] |
|
486 | 486 | |
|
487 | 487 | In [43]: dview.push(dict(c='speed')) |
|
488 | 488 | Out[43]: [None,None,None,None] |
|
489 | 489 | |
|
490 | 490 | In non-blocking mode :meth:`push` and :meth:`pull` also return |
|
491 | 491 | :class:`AsyncResult` objects: |
|
492 | 492 | |
|
493 | 493 | .. sourcecode:: ipython |
|
494 | 494 | |
|
495 | 495 | In [48]: ar = dview.pull('a', block=False) |
|
496 | 496 | |
|
497 | 497 | In [49]: ar.get() |
|
498 | 498 | Out[49]: [1.03234, 1.03234, 1.03234, 1.03234] |
|
499 | 499 | |
|
500 | 500 | |
|
501 | 501 | Dictionary interface |
|
502 | 502 | -------------------- |
|
503 | 503 | |
|
504 | 504 | Since a Python namespace is just a :class:`dict`, :class:`DirectView` objects provide |
|
505 | 505 | dictionary-style access by key and methods such as :meth:`get` and |
|
506 | 506 | :meth:`update` for convenience. This make the remote namespaces of the engines |
|
507 | 507 | appear as a local dictionary. Underneath, these methods call :meth:`apply`: |
|
508 | 508 | |
|
509 | 509 | .. sourcecode:: ipython |
|
510 | 510 | |
|
511 | 511 | In [51]: dview['a']=['foo','bar'] |
|
512 | 512 | |
|
513 | 513 | In [52]: dview['a'] |
|
514 | 514 | Out[52]: [ ['foo', 'bar'], ['foo', 'bar'], ['foo', 'bar'], ['foo', 'bar'] ] |
|
515 | 515 | |
|
516 | 516 | Scatter and gather |
|
517 | 517 | ------------------ |
|
518 | 518 | |
|
519 | 519 | Sometimes it is useful to partition a sequence and push the partitions to |
|
520 | 520 | different engines. In MPI language, this is know as scatter/gather and we |
|
521 | 521 | follow that terminology. However, it is important to remember that in |
|
522 | 522 | IPython's :class:`Client` class, :meth:`scatter` is from the |
|
523 | 523 | interactive IPython session to the engines and :meth:`gather` is from the |
|
524 | 524 | engines back to the interactive IPython session. For scatter/gather operations |
|
525 | 525 | between engines, MPI should be used: |
|
526 | 526 | |
|
527 | 527 | .. sourcecode:: ipython |
|
528 | 528 | |
|
529 | 529 | In [58]: dview.scatter('a',range(16)) |
|
530 | 530 | Out[58]: [None,None,None,None] |
|
531 | 531 | |
|
532 | 532 | In [59]: dview['a'] |
|
533 | 533 | Out[59]: [ [0, 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11], [12, 13, 14, 15] ] |
|
534 | 534 | |
|
535 | 535 | In [60]: dview.gather('a') |
|
536 | 536 | Out[60]: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15] |
|
537 | 537 | |
|
538 | 538 | Other things to look at |
|
539 | 539 | ======================= |
|
540 | 540 | |
|
541 | 541 | How to do parallel list comprehensions |
|
542 | 542 | -------------------------------------- |
|
543 | 543 | |
|
544 | 544 | In many cases list comprehensions are nicer than using the map function. While |
|
545 | 545 | we don't have fully parallel list comprehensions, it is simple to get the |
|
546 | 546 | basic effect using :meth:`scatter` and :meth:`gather`: |
|
547 | 547 | |
|
548 | 548 | .. sourcecode:: ipython |
|
549 | 549 | |
|
550 | 550 | In [66]: dview.scatter('x',range(64)) |
|
551 | 551 | |
|
552 | 552 | In [67]: %px y = [i**10 for i in x] |
|
553 | 553 | Parallel execution on engines: [0, 1, 2, 3] |
|
554 | 554 | Out[67]: |
|
555 | 555 | |
|
556 | 556 | In [68]: y = dview.gather('y') |
|
557 | 557 | |
|
558 | 558 | In [69]: print y |
|
559 | 559 | [0, 1, 1024, 59049, 1048576, 9765625, 60466176, 282475249, 1073741824,...] |
|
560 | 560 | |
|
561 | 561 | Remote imports |
|
562 | 562 | -------------- |
|
563 | 563 | |
|
564 | 564 | Sometimes you will want to import packages both in your interactive session |
|
565 | 565 | and on your remote engines. This can be done with the :class:`ContextManager` |
|
566 | 566 | created by a DirectView's :meth:`sync_imports` method: |
|
567 | 567 | |
|
568 | 568 | .. sourcecode:: ipython |
|
569 | 569 | |
|
570 | 570 | In [69]: with dview.sync_imports(): |
|
571 | 571 | ...: import numpy |
|
572 | 572 | importing numpy on engine(s) |
|
573 | 573 | |
|
574 | 574 | Any imports made inside the block will also be performed on the view's engines. |
|
575 | 575 | sync_imports also takes a `local` boolean flag that defaults to True, which specifies |
|
576 | 576 | whether the local imports should also be performed. However, support for `local=False` |
|
577 | 577 | has not been implemented, so only packages that can be imported locally will work |
|
578 | 578 | this way. |
|
579 | 579 | |
|
580 | 580 | You can also specify imports via the ``@require`` decorator. This is a decorator |
|
581 | 581 | designed for use in Dependencies, but can be used to handle remote imports as well. |
|
582 | 582 | Modules or module names passed to ``@require`` will be imported before the decorated |
|
583 | 583 | function is called. If they cannot be imported, the decorated function will never |
|
584 | 584 | execution, and will fail with an UnmetDependencyError. |
|
585 | 585 | |
|
586 | 586 | .. sourcecode:: ipython |
|
587 | 587 | |
|
588 | 588 | In [69]: from IPython.parallel import require |
|
589 | 589 | |
|
590 | In [70]: @requre('re'): | |
|
590 | In [70]: @require('re'): | |
|
591 | 591 | ...: def findall(pat, x): |
|
592 | 592 | ...: # re is guaranteed to be available |
|
593 | 593 | ...: return re.findall(pat, x) |
|
594 | 594 | |
|
595 | 595 | # you can also pass modules themselves, that you already have locally: |
|
596 | In [71]: @requre(time): | |
|
596 | In [71]: @require(time): | |
|
597 | 597 | ...: def wait(t): |
|
598 | 598 | ...: time.sleep(t) |
|
599 | 599 | ...: return t |
|
600 | 600 | |
|
601 | 601 | .. _parallel_exceptions: |
|
602 | 602 | |
|
603 | 603 | Parallel exceptions |
|
604 | 604 | ------------------- |
|
605 | 605 | |
|
606 | 606 | In the multiengine interface, parallel commands can raise Python exceptions, |
|
607 | 607 | just like serial commands. But, it is a little subtle, because a single |
|
608 | 608 | parallel command can actually raise multiple exceptions (one for each engine |
|
609 | 609 | the command was run on). To express this idea, we have a |
|
610 | 610 | :exc:`CompositeError` exception class that will be raised in most cases. The |
|
611 | 611 | :exc:`CompositeError` class is a special type of exception that wraps one or |
|
612 | 612 | more other types of exceptions. Here is how it works: |
|
613 | 613 | |
|
614 | 614 | .. sourcecode:: ipython |
|
615 | 615 | |
|
616 | 616 | In [76]: dview.block=True |
|
617 | 617 | |
|
618 | 618 | In [77]: dview.execute('1/0') |
|
619 | 619 | --------------------------------------------------------------------------- |
|
620 | 620 | CompositeError Traceback (most recent call last) |
|
621 | 621 | /home/user/<ipython-input-10-5d56b303a66c> in <module>() |
|
622 | 622 | ----> 1 dview.execute('1/0') |
|
623 | 623 | |
|
624 | 624 | /path/to/site-packages/IPython/parallel/client/view.pyc in execute(self, code, targets, block) |
|
625 | 625 | 591 default: self.block |
|
626 | 626 | 592 """ |
|
627 | 627 | --> 593 return self._really_apply(util._execute, args=(code,), block=block, targets=targets) |
|
628 | 628 | 594 |
|
629 | 629 | 595 def run(self, filename, targets=None, block=None): |
|
630 | 630 | |
|
631 | 631 | /home/user/<string> in _really_apply(self, f, args, kwargs, targets, block, track) |
|
632 | 632 | |
|
633 | 633 | /path/to/site-packages/IPython/parallel/client/view.pyc in sync_results(f, self, *args, **kwargs) |
|
634 | 634 | 55 def sync_results(f, self, *args, **kwargs): |
|
635 | 635 | 56 """sync relevant results from self.client to our results attribute.""" |
|
636 | 636 | ---> 57 ret = f(self, *args, **kwargs) |
|
637 | 637 | 58 delta = self.outstanding.difference(self.client.outstanding) |
|
638 | 638 | 59 completed = self.outstanding.intersection(delta) |
|
639 | 639 | |
|
640 | 640 | /home/user/<string> in _really_apply(self, f, args, kwargs, targets, block, track) |
|
641 | 641 | |
|
642 | 642 | /path/to/site-packages/IPython/parallel/client/view.pyc in save_ids(f, self, *args, **kwargs) |
|
643 | 643 | 44 n_previous = len(self.client.history) |
|
644 | 644 | 45 try: |
|
645 | 645 | ---> 46 ret = f(self, *args, **kwargs) |
|
646 | 646 | 47 finally: |
|
647 | 647 | 48 nmsgs = len(self.client.history) - n_previous |
|
648 | 648 | |
|
649 | 649 | /path/to/site-packages/IPython/parallel/client/view.pyc in _really_apply(self, f, args, kwargs, targets, block, track) |
|
650 | 650 | 529 if block: |
|
651 | 651 | 530 try: |
|
652 | 652 | --> 531 return ar.get() |
|
653 | 653 | 532 except KeyboardInterrupt: |
|
654 | 654 | 533 pass |
|
655 | 655 | |
|
656 | 656 | /path/to/site-packages/IPython/parallel/client/asyncresult.pyc in get(self, timeout) |
|
657 | 657 | 101 return self._result |
|
658 | 658 | 102 else: |
|
659 | 659 | --> 103 raise self._exception |
|
660 | 660 | 104 else: |
|
661 | 661 | 105 raise error.TimeoutError("Result not ready.") |
|
662 | 662 | |
|
663 | 663 | CompositeError: one or more exceptions from call to method: _execute |
|
664 | 664 | [0:apply]: ZeroDivisionError: integer division or modulo by zero |
|
665 | 665 | [1:apply]: ZeroDivisionError: integer division or modulo by zero |
|
666 | 666 | [2:apply]: ZeroDivisionError: integer division or modulo by zero |
|
667 | 667 | [3:apply]: ZeroDivisionError: integer division or modulo by zero |
|
668 | 668 | |
|
669 | 669 | Notice how the error message printed when :exc:`CompositeError` is raised has |
|
670 | 670 | information about the individual exceptions that were raised on each engine. |
|
671 | 671 | If you want, you can even raise one of these original exceptions: |
|
672 | 672 | |
|
673 | 673 | .. sourcecode:: ipython |
|
674 | 674 | |
|
675 | 675 | In [80]: try: |
|
676 | 676 | ....: dview.execute('1/0') |
|
677 | 677 | ....: except parallel.error.CompositeError, e: |
|
678 | 678 | ....: e.raise_exception() |
|
679 | 679 | ....: |
|
680 | 680 | ....: |
|
681 | 681 | --------------------------------------------------------------------------- |
|
682 | 682 | RemoteError Traceback (most recent call last) |
|
683 | 683 | /home/user/<ipython-input-17-8597e7e39858> in <module>() |
|
684 | 684 | 2 dview.execute('1/0') |
|
685 | 685 | 3 except CompositeError as e: |
|
686 | 686 | ----> 4 e.raise_exception() |
|
687 | 687 | |
|
688 | 688 | /path/to/site-packages/IPython/parallel/error.pyc in raise_exception(self, excid) |
|
689 | 689 | 266 raise IndexError("an exception with index %i does not exist"%excid) |
|
690 | 690 | 267 else: |
|
691 | 691 | --> 268 raise RemoteError(en, ev, etb, ei) |
|
692 | 692 | 269 |
|
693 | 693 | 270 |
|
694 | 694 | |
|
695 | 695 | RemoteError: ZeroDivisionError(integer division or modulo by zero) |
|
696 | 696 | Traceback (most recent call last): |
|
697 | 697 | File "/path/to/site-packages/IPython/parallel/engine/streamkernel.py", line 330, in apply_request |
|
698 | 698 | exec code in working,working |
|
699 | 699 | File "<string>", line 1, in <module> |
|
700 | 700 | File "/path/to/site-packages/IPython/parallel/util.py", line 354, in _execute |
|
701 | 701 | exec code in globals() |
|
702 | 702 | File "<string>", line 1, in <module> |
|
703 | 703 | ZeroDivisionError: integer division or modulo by zero |
|
704 | 704 | |
|
705 | 705 | If you are working in IPython, you can simple type ``%debug`` after one of |
|
706 | 706 | these :exc:`CompositeError` exceptions is raised, and inspect the exception |
|
707 | 707 | instance: |
|
708 | 708 | |
|
709 | 709 | .. sourcecode:: ipython |
|
710 | 710 | |
|
711 | 711 | In [81]: dview.execute('1/0') |
|
712 | 712 | --------------------------------------------------------------------------- |
|
713 | 713 | CompositeError Traceback (most recent call last) |
|
714 | 714 | /home/user/<ipython-input-10-5d56b303a66c> in <module>() |
|
715 | 715 | ----> 1 dview.execute('1/0') |
|
716 | 716 | |
|
717 | 717 | /path/to/site-packages/IPython/parallel/client/view.pyc in execute(self, code, targets, block) |
|
718 | 718 | 591 default: self.block |
|
719 | 719 | 592 """ |
|
720 | 720 | --> 593 return self._really_apply(util._execute, args=(code,), block=block, targets=targets) |
|
721 | 721 | 594 |
|
722 | 722 | 595 def run(self, filename, targets=None, block=None): |
|
723 | 723 | |
|
724 | 724 | /home/user/<string> in _really_apply(self, f, args, kwargs, targets, block, track) |
|
725 | 725 | |
|
726 | 726 | /path/to/site-packages/IPython/parallel/client/view.pyc in sync_results(f, self, *args, **kwargs) |
|
727 | 727 | 55 def sync_results(f, self, *args, **kwargs): |
|
728 | 728 | 56 """sync relevant results from self.client to our results attribute.""" |
|
729 | 729 | ---> 57 ret = f(self, *args, **kwargs) |
|
730 | 730 | 58 delta = self.outstanding.difference(self.client.outstanding) |
|
731 | 731 | 59 completed = self.outstanding.intersection(delta) |
|
732 | 732 | |
|
733 | 733 | /home/user/<string> in _really_apply(self, f, args, kwargs, targets, block, track) |
|
734 | 734 | |
|
735 | 735 | /path/to/site-packages/IPython/parallel/client/view.pyc in save_ids(f, self, *args, **kwargs) |
|
736 | 736 | 44 n_previous = len(self.client.history) |
|
737 | 737 | 45 try: |
|
738 | 738 | ---> 46 ret = f(self, *args, **kwargs) |
|
739 | 739 | 47 finally: |
|
740 | 740 | 48 nmsgs = len(self.client.history) - n_previous |
|
741 | 741 | |
|
742 | 742 | /path/to/site-packages/IPython/parallel/client/view.pyc in _really_apply(self, f, args, kwargs, targets, block, track) |
|
743 | 743 | 529 if block: |
|
744 | 744 | 530 try: |
|
745 | 745 | --> 531 return ar.get() |
|
746 | 746 | 532 except KeyboardInterrupt: |
|
747 | 747 | 533 pass |
|
748 | 748 | |
|
749 | 749 | /path/to/site-packages/IPython/parallel/client/asyncresult.pyc in get(self, timeout) |
|
750 | 750 | 101 return self._result |
|
751 | 751 | 102 else: |
|
752 | 752 | --> 103 raise self._exception |
|
753 | 753 | 104 else: |
|
754 | 754 | 105 raise error.TimeoutError("Result not ready.") |
|
755 | 755 | |
|
756 | 756 | CompositeError: one or more exceptions from call to method: _execute |
|
757 | 757 | [0:apply]: ZeroDivisionError: integer division or modulo by zero |
|
758 | 758 | [1:apply]: ZeroDivisionError: integer division or modulo by zero |
|
759 | 759 | [2:apply]: ZeroDivisionError: integer division or modulo by zero |
|
760 | 760 | [3:apply]: ZeroDivisionError: integer division or modulo by zero |
|
761 | 761 | |
|
762 | 762 | In [82]: %debug |
|
763 | 763 | > /path/to/site-packages/IPython/parallel/client/asyncresult.py(103)get() |
|
764 | 764 | 102 else: |
|
765 | 765 | --> 103 raise self._exception |
|
766 | 766 | 104 else: |
|
767 | 767 | |
|
768 | 768 | # With the debugger running, self._exception is the exceptions instance. We can tab complete |
|
769 | 769 | # on it and see the extra methods that are available. |
|
770 | 770 | ipdb> self._exception.<tab> |
|
771 | 771 | e.__class__ e.__getitem__ e.__new__ e.__setstate__ e.args |
|
772 | 772 | e.__delattr__ e.__getslice__ e.__reduce__ e.__str__ e.elist |
|
773 | 773 | e.__dict__ e.__hash__ e.__reduce_ex__ e.__weakref__ e.message |
|
774 | 774 | e.__doc__ e.__init__ e.__repr__ e._get_engine_str e.print_tracebacks |
|
775 | 775 | e.__getattribute__ e.__module__ e.__setattr__ e._get_traceback e.raise_exception |
|
776 | 776 | ipdb> self._exception.print_tracebacks() |
|
777 | 777 | [0:apply]: |
|
778 | 778 | Traceback (most recent call last): |
|
779 | 779 | File "/path/to/site-packages/IPython/parallel/engine/streamkernel.py", line 330, in apply_request |
|
780 | 780 | exec code in working,working |
|
781 | 781 | File "<string>", line 1, in <module> |
|
782 | 782 | File "/path/to/site-packages/IPython/parallel/util.py", line 354, in _execute |
|
783 | 783 | exec code in globals() |
|
784 | 784 | File "<string>", line 1, in <module> |
|
785 | 785 | ZeroDivisionError: integer division or modulo by zero |
|
786 | 786 | |
|
787 | 787 | |
|
788 | 788 | [1:apply]: |
|
789 | 789 | Traceback (most recent call last): |
|
790 | 790 | File "/path/to/site-packages/IPython/parallel/engine/streamkernel.py", line 330, in apply_request |
|
791 | 791 | exec code in working,working |
|
792 | 792 | File "<string>", line 1, in <module> |
|
793 | 793 | File "/path/to/site-packages/IPython/parallel/util.py", line 354, in _execute |
|
794 | 794 | exec code in globals() |
|
795 | 795 | File "<string>", line 1, in <module> |
|
796 | 796 | ZeroDivisionError: integer division or modulo by zero |
|
797 | 797 | |
|
798 | 798 | |
|
799 | 799 | [2:apply]: |
|
800 | 800 | Traceback (most recent call last): |
|
801 | 801 | File "/path/to/site-packages/IPython/parallel/engine/streamkernel.py", line 330, in apply_request |
|
802 | 802 | exec code in working,working |
|
803 | 803 | File "<string>", line 1, in <module> |
|
804 | 804 | File "/path/to/site-packages/IPython/parallel/util.py", line 354, in _execute |
|
805 | 805 | exec code in globals() |
|
806 | 806 | File "<string>", line 1, in <module> |
|
807 | 807 | ZeroDivisionError: integer division or modulo by zero |
|
808 | 808 | |
|
809 | 809 | |
|
810 | 810 | [3:apply]: |
|
811 | 811 | Traceback (most recent call last): |
|
812 | 812 | File "/path/to/site-packages/IPython/parallel/engine/streamkernel.py", line 330, in apply_request |
|
813 | 813 | exec code in working,working |
|
814 | 814 | File "<string>", line 1, in <module> |
|
815 | 815 | File "/path/to/site-packages/IPython/parallel/util.py", line 354, in _execute |
|
816 | 816 | exec code in globals() |
|
817 | 817 | File "<string>", line 1, in <module> |
|
818 | 818 | ZeroDivisionError: integer division or modulo by zero |
|
819 | 819 | |
|
820 | 820 | |
|
821 | 821 | All of this same error handling magic even works in non-blocking mode: |
|
822 | 822 | |
|
823 | 823 | .. sourcecode:: ipython |
|
824 | 824 | |
|
825 | 825 | In [83]: dview.block=False |
|
826 | 826 | |
|
827 | 827 | In [84]: ar = dview.execute('1/0') |
|
828 | 828 | |
|
829 | 829 | In [85]: ar.get() |
|
830 | 830 | --------------------------------------------------------------------------- |
|
831 | 831 | CompositeError Traceback (most recent call last) |
|
832 | 832 | /home/user/<ipython-input-21-8531eb3d26fb> in <module>() |
|
833 | 833 | ----> 1 ar.get() |
|
834 | 834 | |
|
835 | 835 | /path/to/site-packages/IPython/parallel/client/asyncresult.pyc in get(self, timeout) |
|
836 | 836 | 101 return self._result |
|
837 | 837 | 102 else: |
|
838 | 838 | --> 103 raise self._exception |
|
839 | 839 | 104 else: |
|
840 | 840 | 105 raise error.TimeoutError("Result not ready.") |
|
841 | 841 | |
|
842 | 842 | CompositeError: one or more exceptions from call to method: _execute |
|
843 | 843 | [0:apply]: ZeroDivisionError: integer division or modulo by zero |
|
844 | 844 | [1:apply]: ZeroDivisionError: integer division or modulo by zero |
|
845 | 845 | [2:apply]: ZeroDivisionError: integer division or modulo by zero |
|
846 | 846 | [3:apply]: ZeroDivisionError: integer division or modulo by zero |
|
847 | 847 |
General Comments 0
You need to be logged in to leave comments.
Login now