1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
# Owner(s): ["module: unknown"]
import threading
import time
import torch
import unittest
from torch.futures import Future
from torch.testing._internal.common_utils import IS_WINDOWS, TestCase, TemporaryFileName, run_tests
from typing import TypeVar
T = TypeVar("T")
def add_one(fut):
return fut.wait() + 1
class TestFuture(TestCase):
def test_set_exception(self) -> None:
# This test is to ensure errors can propagate across futures.
error_msg = "Intentional Value Error"
value_error = ValueError(error_msg)
f = Future[T]()
# Set exception
f.set_exception(value_error)
# Exception should throw on wait
with self.assertRaisesRegex(ValueError, "Intentional"):
f.wait()
# Exception should also throw on value
f = Future()
f.set_exception(value_error)
with self.assertRaisesRegex(ValueError, "Intentional"):
f.value()
def cb(fut):
fut.value()
f = Future()
f.set_exception(value_error)
with self.assertRaisesRegex(RuntimeError, "Got the following error"):
cb_fut = f.then(cb)
cb_fut.wait()
def test_set_exception_multithreading(self) -> None:
# Ensure errors can propagate when one thread waits on future result
# and the other sets it with an error.
error_msg = "Intentional Value Error"
value_error = ValueError(error_msg)
def wait_future(f):
with self.assertRaisesRegex(ValueError, "Intentional"):
f.wait()
f = Future[T]()
t = threading.Thread(target=wait_future, args=(f, ))
t.start()
f.set_exception(value_error)
t.join()
def cb(fut):
fut.value()
def then_future(f):
fut = f.then(cb)
with self.assertRaisesRegex(RuntimeError, "Got the following error"):
fut.wait()
f = Future[T]()
t = threading.Thread(target=then_future, args=(f, ))
t.start()
f.set_exception(value_error)
t.join()
def test_done(self) -> None:
f = Future[torch.Tensor]()
self.assertFalse(f.done())
f.set_result(torch.ones(2, 2))
self.assertTrue(f.done())
def test_done_exception(self) -> None:
err_msg = "Intentional Value Error"
def raise_exception(unused_future):
raise RuntimeError(err_msg)
f1 = Future[torch.Tensor]()
self.assertFalse(f1.done())
f1.set_result(torch.ones(2, 2))
self.assertTrue(f1.done())
f2 = f1.then(raise_exception)
self.assertTrue(f2.done())
with self.assertRaisesRegex(RuntimeError, err_msg):
f2.wait()
def test_wait(self) -> None:
f = Future[torch.Tensor]()
f.set_result(torch.ones(2, 2))
self.assertEqual(f.wait(), torch.ones(2, 2))
def test_wait_multi_thread(self) -> None:
def slow_set_future(fut, value):
time.sleep(0.5)
fut.set_result(value)
f = Future[torch.Tensor]()
t = threading.Thread(target=slow_set_future, args=(f, torch.ones(2, 2)))
t.start()
self.assertEqual(f.wait(), torch.ones(2, 2))
t.join()
def test_mark_future_twice(self) -> None:
fut = Future[int]()
fut.set_result(1)
with self.assertRaisesRegex(
RuntimeError,
"Future can only be marked completed once"
):
fut.set_result(1)
def test_pickle_future(self):
fut = Future[int]()
errMsg = "Can not pickle torch.futures.Future"
with TemporaryFileName() as fname:
with self.assertRaisesRegex(RuntimeError, errMsg):
torch.save(fut, fname)
def test_then(self):
fut = Future[torch.Tensor]()
then_fut = fut.then(lambda x: x.wait() + 1)
fut.set_result(torch.ones(2, 2))
self.assertEqual(fut.wait(), torch.ones(2, 2))
self.assertEqual(then_fut.wait(), torch.ones(2, 2) + 1)
def test_chained_then(self):
fut = Future[torch.Tensor]()
futs = []
last_fut = fut
for _ in range(20):
last_fut = last_fut.then(add_one)
futs.append(last_fut)
fut.set_result(torch.ones(2, 2))
for i in range(len(futs)):
self.assertEqual(futs[i].wait(), torch.ones(2, 2) + i + 1)
def _test_then_error(self, cb, errMsg):
fut = Future[int]()
then_fut = fut.then(cb)
fut.set_result(5)
self.assertEqual(5, fut.wait())
with self.assertRaisesRegex(RuntimeError, errMsg):
then_fut.wait()
def test_then_wrong_arg(self):
def wrong_arg(tensor):
return tensor + 1
self._test_then_error(wrong_arg, "unsupported operand type.*Future.*int")
def test_then_no_arg(self):
def no_arg():
return True
self._test_then_error(no_arg, "takes 0 positional arguments but 1 was given")
def test_then_raise(self):
def raise_value_error(fut):
raise ValueError("Expected error")
self._test_then_error(raise_value_error, "Expected error")
def test_add_done_callback_simple(self):
callback_result = False
def callback(fut):
nonlocal callback_result
fut.wait()
callback_result = True
fut = Future[torch.Tensor]()
fut.add_done_callback(callback)
self.assertFalse(callback_result)
fut.set_result(torch.ones(2, 2))
self.assertEqual(fut.wait(), torch.ones(2, 2))
self.assertTrue(callback_result)
def test_add_done_callback_maintains_callback_order(self):
callback_result = 0
def callback_set1(fut):
nonlocal callback_result
fut.wait()
callback_result = 1
def callback_set2(fut):
nonlocal callback_result
fut.wait()
callback_result = 2
fut = Future[torch.Tensor]()
fut.add_done_callback(callback_set1)
fut.add_done_callback(callback_set2)
fut.set_result(torch.ones(2, 2))
self.assertEqual(fut.wait(), torch.ones(2, 2))
# set2 called last, callback_result = 2
self.assertEqual(callback_result, 2)
def _test_add_done_callback_error_ignored(self, cb):
fut = Future[int]()
fut.add_done_callback(cb)
fut.set_result(5)
# error msg logged to stdout
self.assertEqual(5, fut.wait())
def test_add_done_callback_error_is_ignored(self):
def raise_value_error(fut):
raise ValueError("Expected error")
self._test_add_done_callback_error_ignored(raise_value_error)
def test_add_done_callback_no_arg_error_is_ignored(self):
def no_arg():
return True
# Adding another level of function indirection here on purpose.
# Otherwise mypy will pick up on no_arg having an incompatible type and fail CI
self._test_add_done_callback_error_ignored(no_arg)
def test_interleaving_then_and_add_done_callback_maintains_callback_order(self):
callback_result = 0
def callback_set1(fut):
nonlocal callback_result
fut.wait()
callback_result = 1
def callback_set2(fut):
nonlocal callback_result
fut.wait()
callback_result = 2
def callback_then(fut):
nonlocal callback_result
return fut.wait() + callback_result
fut = Future[torch.Tensor]()
fut.add_done_callback(callback_set1)
then_fut = fut.then(callback_then)
fut.add_done_callback(callback_set2)
fut.set_result(torch.ones(2, 2))
self.assertEqual(fut.wait(), torch.ones(2, 2))
# then_fut's callback is called with callback_result = 1
self.assertEqual(then_fut.wait(), torch.ones(2, 2) + 1)
# set2 called last, callback_result = 2
self.assertEqual(callback_result, 2)
def test_interleaving_then_and_add_done_callback_propagates_error(self):
def raise_value_error(fut):
raise ValueError("Expected error")
fut = Future[torch.Tensor]()
then_fut = fut.then(raise_value_error)
fut.add_done_callback(raise_value_error)
fut.set_result(torch.ones(2, 2))
# error from add_done_callback's callback is swallowed
# error from then's callback is not
self.assertEqual(fut.wait(), torch.ones(2, 2))
with self.assertRaisesRegex(RuntimeError, "Expected error"):
then_fut.wait()
def test_collect_all(self):
fut1 = Future[int]()
fut2 = Future[int]()
fut_all = torch.futures.collect_all([fut1, fut2])
def slow_in_thread(fut, value):
time.sleep(0.1)
fut.set_result(value)
t = threading.Thread(target=slow_in_thread, args=(fut1, 1))
fut2.set_result(2)
t.start()
res = fut_all.wait()
self.assertEqual(res[0].wait(), 1)
self.assertEqual(res[1].wait(), 2)
t.join()
@unittest.skipIf(IS_WINDOWS, "TODO: need to fix this testcase for Windows")
def test_wait_all(self):
fut1 = Future[int]()
fut2 = Future[int]()
# No error version
fut1.set_result(1)
fut2.set_result(2)
res = torch.futures.wait_all([fut1, fut2])
print(res)
self.assertEqual(res, [1, 2])
# Version with an exception
def raise_in_fut(fut):
raise ValueError("Expected error")
fut3 = fut1.then(raise_in_fut)
with self.assertRaisesRegex(RuntimeError, "Expected error"):
torch.futures.wait_all([fut3, fut2])
def test_wait_none(self):
fut1 = Future[int]()
with self.assertRaisesRegex(RuntimeError, "Future can't be None"):
torch.jit.wait(None)
with self.assertRaisesRegex(RuntimeError, "Future can't be None"):
torch.futures.wait_all((None,)) # type: ignore[arg-type]
with self.assertRaisesRegex(RuntimeError, "Future can't be None"):
torch.futures.collect_all((fut1, None,)) # type: ignore[arg-type]
if __name__ == '__main__':
run_tests()
|
