forked from docarray/docarray
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmap.py
More file actions
217 lines (174 loc) 路 7.56 KB
/
Copy pathmap.py
File metadata and controls
217 lines (174 loc) 路 7.56 KB
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
__all__ = ['map_docs', 'map_docs_batched']
from contextlib import nullcontext
from math import ceil
from multiprocessing.pool import Pool, ThreadPool
from typing import Callable, Generator, Optional, TypeVar, Union
from rich.progress import track
from docarray import BaseDoc
from docarray.array.any_array import AnyDocArray
from docarray.helper import _is_lambda_or_partial_or_local_function
T = TypeVar('T', bound=AnyDocArray)
T_doc = TypeVar('T_doc', bound=BaseDoc)
def map_docs(
docs: T,
func: Callable[[T_doc], T_doc],
backend: str = 'thread',
num_worker: Optional[int] = None,
pool: Optional[Union[Pool, ThreadPool]] = None,
show_progress: bool = False,
) -> Generator[T_doc, None, None]:
"""
Return an iterator that applies `func` to every Document in `docs` in parallel,
yielding the results.
---
```python
from docarray import DocList
from docarray.documents import ImageDoc
from docarray.utils.map import map_docs
def load_url_to_tensor(img: ImageDoc) -> ImageDoc:
img.tensor = img.url.load()
return img
url = (
'https://upload.wikimedia.org/wikipedia/commons/8/80/'
'Dag_Sebastian_Ahlander_at_G%C3%B6teborg_Book_Fair_2012b.jpg'
)
docs = DocList[ImageDoc]([ImageDoc(url=url) for _ in range(100)])
docs = DocList[ImageDoc](
list(map_docs(docs, load_url_to_tensor, backend='thread'))
) # threading is usually a good option for IO-bound tasks such as loading an
# ImageDoc from url
for doc in docs:
assert doc.tensor is not None
```
---
:param docs: DocList to apply function to
:param func: a function that takes a [`BaseDoc`][docarray.base_doc.doc.BaseDoc]
as input and outputs a [`BaseDoc`][docarray.base_doc.doc.BaseDoc].
:param backend: `thread` for multithreading and `process` for multiprocessing.
Defaults to `thread`.
In general, if `func` is IO-bound then `thread` is a good choice.
On the other hand, if `func` is CPU-bound, then you may use `process`.
In practice, you should try yourselves to figure out the best value.
However, if you wish to modify the elements in-place, regardless of IO/CPU-bound,
you should always use `thread` backend.
Note that computation that is offloaded to non-python code (e.g. through np/torch/tf)
falls under the "IO-bound" category.
!!! warning
When using `process` backend, your `func` should not modify elements in-place.
This is because the multiprocessing backend passes the variable via pickle
and works in another process.
The passed object and the original object do **not** share the same memory.
:param num_worker: the number of parallel workers. If not given, the number of CPUs
in the system will be used.
:param pool: use an existing/external process or thread pool. If given, you will
be responsible for closing the pool.
:param show_progress: show a progress bar. Defaults to False.
:return: yield Documents returned from `func`
"""
if backend == 'process' and _is_lambda_or_partial_or_local_function(func):
raise ValueError(
f'Multiprocessing does not allow functions that are local, lambda or partial: {func}'
)
context_pool: Union[nullcontext, Union[Pool, ThreadPool]]
if pool:
p = pool
context_pool = nullcontext()
else:
p = _get_pool(backend, num_worker)
context_pool = p
with context_pool:
imap = p.imap(func, docs)
for x in track(imap, total=len(docs), disable=not show_progress):
yield x
def map_docs_batched(
docs: T,
func: Callable[[T], Union[T, T_doc]],
batch_size: int,
backend: str = 'thread',
num_worker: Optional[int] = None,
shuffle: bool = False,
pool: Optional[Union[Pool, ThreadPool]] = None,
show_progress: bool = False,
) -> Generator[Union[T, T_doc], None, None]:
"""
Return an iterator that applies `func` to every **minibatch** of iterable in parallel,
yielding the results.
Each element in the returned iterator is an `AnyDocArray`.
---
```python
from docarray import BaseDoc, DocList
from docarray.utils.map import map_docs_batched
class MyDoc(BaseDoc):
name: str
def upper_case_name(docs: DocList[MyDoc]) -> DocList[MyDoc]:
docs.name = [n.upper() for n in docs.name]
return docs
batch_size = 16
docs = DocList[MyDoc]([MyDoc(name='my orange cat') for _ in range(100)])
it = map_docs_batched(docs, upper_case_name, batch_size=batch_size)
for i, d in enumerate(it):
docs[i * batch_size : (i + 1) * batch_size] = d
assert len(docs) == 100
print(docs.name[:3])
```
---
```
['MY ORANGE CAT', 'MY ORANGE CAT', 'MY ORANGE CAT']
```
---
:param docs: DocList to apply function to
:param batch_size: Size of each generated batch (except the last one, which might
be smaller).
:param shuffle: If set, shuffle the Documents before dividing into minibatches.
:param func: a function that takes an :class:`AnyDocArray` as input and outputs
an :class:`AnyDocArray` or a :class:`BaseDoc`.
:param backend: `thread` for multithreading and `process` for multiprocessing.
Defaults to `thread`.
In general, if `func` is IO-bound then `thread` is a good choice.
On the other hand, if `func` is CPU-bound, then you may use `process`.
In practice, you should try yourselves to figure out the best value.
However, if you wish to modify the elements in-place, regardless of IO/CPU-bound,
you should always use `thread` backend.
Note that computation that is offloaded to non-python code (e.g. through np/torch/tf)
falls under the "IO-bound" category.
!!! warning
When using `process` backend, your `func` should not modify elements in-place.
This is because the multiprocessing backend passes the variable via pickle
and works in another process.
The passed object and the original object do **not** share the same memory.
:param num_worker: the number of parallel workers. If not given, then the number of CPUs
in the system will be used.
:param show_progress: show a progress bar
:param pool: use an existing/external pool. If given, `backend` is ignored and you will
be responsible for closing the pool.
:return: yield DocLists returned from `func`
"""
if backend == 'process' and _is_lambda_or_partial_or_local_function(func):
raise ValueError(
f'Multiprocessing does not allow functions that are local, lambda or partial: {func}'
)
context_pool: Union[nullcontext, Union[Pool, ThreadPool]]
if pool:
p = pool
context_pool = nullcontext()
else:
p = _get_pool(backend, num_worker)
context_pool = p
with context_pool:
imap = p.imap(func, docs._batch(batch_size=batch_size, shuffle=shuffle))
for x in track(
imap, total=ceil(len(docs) / batch_size), disable=not show_progress
):
yield x
def _get_pool(backend, num_worker) -> Union[Pool, ThreadPool]:
"""
Get Pool instance for multiprocessing or ThreadPool instance for multithreading.
"""
if backend == 'thread':
return ThreadPool(processes=num_worker)
elif backend == 'process':
return Pool(processes=num_worker)
else:
raise ValueError(
f'`backend` must be either `process` or `thread`, receiving {backend}'
)