inputs.py 10.2 KB
Newer Older
André Anjos's avatar
André Anjos committed
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
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :

###############################################################################
#                                                                             #
# Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/           #
# Contact: beat.support@idiap.ch                                              #
#                                                                             #
# This file is part of the beat.backend.python module of the BEAT platform.   #
#                                                                             #
# Commercial License Usage                                                    #
# Licensees holding valid commercial BEAT licenses may use this file in       #
# accordance with the terms contained in a written agreement between you      #
# and Idiap. For further information contact tto@idiap.ch                     #
#                                                                             #
# Alternatively, this file may be used under the terms of the GNU Affero      #
# Public License version 3 as published by the Free Software and appearing    #
# in the file LICENSE.AGPL included in the packaging of this file.            #
# The BEAT platform is distributed in the hope that it will be useful, but    #
# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
# or FITNESS FOR A PARTICULAR PURPOSE.                                        #
#                                                                             #
# You should have received a copy of the GNU Affero Public License along      #
# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
#                                                                             #
###############################################################################


import time
import logging
logger = logging.getLogger(__name__)

from functools import reduce

import six
import zmq


class Input:
  """Represents the input of a processing block

  A list of those inputs must be provided to the algorithms (see
  :py:class:`beat.backend.python.inputs.InputList`)


  Parameters:

    name (str): Name of the input

    data_format (object): An object with the preloaded data format for this
      input (see :py:class:`beat.backend.python.dataformat.DataFormat`).

    socket (object): A 0MQ socket for writing the data to the server process


  Attributes:

    group (beat.backend.python.inputs.InputGroup): Group containing this input

    data (beat.core.baseformat.baseformat): The last block of data received on
      the input

  """

  def __init__(self, name, data_format, socket):

    self.name = name
    self.data_format = data_format
    self.socket = socket
    self.data = None
71
72
    self.data_index = -1
    self.data_index_end = -1
André Anjos's avatar
André Anjos committed
73
74
    self.group = None
    self.comm_time = 0. #total time spent on communication
75
    self.nb_data_blocks_read = 0
André Anjos's avatar
André Anjos committed
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


  def isDataUnitDone(self):
    """Indicates if the current data unit will change at the next iteration"""

    logger.debug('send: (idd) is-dataunit-done %s', self.name)
    _start = time.time()
    self.socket.send('idd', zmq.SNDMORE)
    self.socket.send(self.group.channel, zmq.SNDMORE)
    self.socket.send(self.name)
    answer = self.socket.recv()
    self.comm_time += time.time() - _start
    logger.debug('recv: %s', answer)
    return answer == 'tru'


  def hasMoreData(self):
    """Indicates if there is more data to process on the input"""

    logger.debug('send: (hmd) has-more-data %s %s', self.group.channel, self.name)
    _start = time.time()
    self.socket.send('hmd', zmq.SNDMORE)
    self.socket.send(self.group.channel, zmq.SNDMORE)
    self.socket.send(self.name)
    answer = self.socket.recv()
    self.comm_time += time.time() - _start
    logger.debug('recv: %s', answer)
    return answer == 'tru'


  def next(self):
    """Retrieves the next block of data"""

    logger.debug('send: (nxt) next %s %s', self.group.channel, self.name)
    _start = time.time()
    self.socket.send('nxt', zmq.SNDMORE)
    self.socket.send(self.group.channel, zmq.SNDMORE)
    self.socket.send(self.name)
114
115
    self.data_index = int(self.socket.recv())
    self.data_index_end = int(self.socket.recv())
André Anjos's avatar
André Anjos committed
116
117
    self.unpack(self.socket.recv())
    self.comm_time += time.time() - _start
118
    self.nb_data_blocks_read += 1
André Anjos's avatar
André Anjos committed
119
120
121
122
123
124


  def unpack(self, packed):
    """Receives data through socket"""

    self.data = self.data_format.type()
125
126
    logger.debug('recv: <bin> (size=%d), indexes=(%d, %d)', len(packed),
                 self.data_index, self.data_index_end)
André Anjos's avatar
André Anjos committed
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
    self.data.unpack(packed)


class InputGroup:
  """Represents a group of inputs synchronized together

  A group implementing this interface is provided to the algorithms (see
  :py:class:`beat.core.inputs.InputList`).

  See :py:class:`beat.core.inputs.Input`

  Example:

    .. code-block:: python

       inputs = InputList()

       print inputs['labels'].data_format

       for index in range(0, len(inputs)):
           print inputs[index].data_format

       for input in inputs:
           print input.data_format

       for input in inputs[0:2]:
           print input.data_format


  Parameters:

    channel (str): Name of the data channel of the group

    restricted_access (bool): Indicates if the algorithm can freely use the
      inputs

    socket (object): A 0MQ socket for writing the data to the server process

  """


  def __init__(self, channel, restricted_access, socket):

    self._inputs = []
    self.channel = channel
    self.restricted_access = restricted_access
    self.socket = socket
    self.comm_time = 0.


  def __getitem__(self, index):

    if isinstance(index, six.string_types):
      try:
        return [x for x in self._inputs if x.name == index][0]
      except:
        pass
    elif isinstance(index, int):
      if index < len(self._inputs):
        return self._inputs[index]
    return None


  def __iter__(self):
    for k in self._inputs: yield k


  def __len__(self):
    return len(self._inputs)


  def add(self, input):
    """Add an input to the group

    Parameters:

      input (beat.backend.python.inputs.Input): The input to add

    """
    input.group = self
    self._inputs.append(input)


  def hasMoreData(self):
    """Indicates if there is more data to process in the group"""

    logger.debug('send: (hmd) has-more-data %s', self.channel)
    _start = time.time()
    self.socket.send('hmd', zmq.SNDMORE)
    self.socket.send(self.channel)
    answer = self.socket.recv()
    self.comm_time += time.time() - _start
    logger.debug('recv: %s', answer)
    return answer == 'tru'


  def next(self):
    """Retrieve the next block of data on all the inputs"""

    logger.debug('send: (nxt) next %s', self.channel)
    self.socket.send('nxt', zmq.SNDMORE)
    self.socket.send(self.channel)

    # read all incomming data
    _start = time.time()
    more = True
    parts = []
    while more:
      parts.append(self.socket.recv())
      more = self.socket.getsockopt(zmq.RCVMORE)

    n = int(parts.pop(0))
    logger.debug('recv: %d (inputs)', n)
    for k in range(n):
      name = parts.pop(0)
      logger.debug('recv: %s (data follows)', name)
      inpt = self[name]
      if inpt is None:
        raise RuntimeError("Could not find input `%s' at input group for " \
            "channel `%s' while performing `next' operation on this group " \
            "(current reading position is %d/%d)" % \
            (name, self.channel, k, n))
249
250
      inpt.data_index = int(parts.pop(0))
      inpt.data_index_end = int(parts.pop(0))
André Anjos's avatar
André Anjos committed
251
      inpt.unpack(parts.pop(0))
252
      inpt.nb_data_blocks_read += 1
André Anjos's avatar
André Anjos committed
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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
    self.comm_time += time.time() - _start


class InputList:
  """Represents the list of inputs of a processing block

  Inputs are organized by groups. The inputs inside a group are all
  synchronized together (see the section *Inputs synchronization* of the User's
  Guide).

  A list implementing this interface is provided to the algorithms

  One group of inputs is always considered as the **main** one, and is used to
  drive the algorithm. The usage of the other groups is left to the algorithm.

  See :py:class:`beat.core.inputs.Input`
  See :py:class:`beat.core.inputs.InputGroup`


  Example:

    .. code-block:: python

       inputs = InputList()
       ...

       # Retrieve an input by name
       input = inputs['labels']

       # Retrieve an input by index
       for index in range(0, len(inputs)):
           input = inputs[index]

       # Iteration over all inputs
       for input in inputs:
           ...

       # Iteration over some inputs
       for input in inputs[0:2]:
           ...

       # Retrieve the group an input belongs to, by input name
       group = inputs.groupOf('label')

       # Retrieve the group an input belongs to
       input = inputs['labels']
       group = input.group


  Attributes:

    group (beat.core.inputs.InputGroup): Main group (for data-driven
      algorithms)

  """

  def __init__(self):
    self._groups = []
    self.main_group = None


  def add(self, group):
    """Add a group to the list

    :param beat.core.platform.inputs.InputGroup group: The group to add
    """
    if group.restricted_access and (self.main_group is None):
      self.main_group = group

    self._groups.append(group)

  def __getitem__(self, index):
    if isinstance(index, six.string_types):
      try:
        return [k for k in map(lambda x: x[index], self._groups) \
                if k is not None][0]
      except:
        pass

    elif isinstance(index, int):
      for group in self._groups:
        if index < len(group): return group[index]
        index -= len(group)

    return None

  def __iter__(self):
    for i in range(len(self)): yield self[i]

  def __len__(self):
    return reduce(lambda x, y: x + len(y), self._groups, 0)

  def nbGroups(self):
    return len(self._groups)

  def groupOf(self, input_name):
    try:
      return [k for k in self._groups if k[input_name] is not None][0]
    except:
      return None

  def hasMoreData(self):
    """Indicates if there is more data to process in any group"""
    return bool([x for x in self._groups if x.hasMoreData()])


  def group(self, name):
    try:
      return [x for x in self._groups if x.channel == name][0]
    except:
      return None