File size: 5,739 Bytes
901e06a | 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 | # Copyright (c) Facebook, Inc. and its affiliates.
# All rights reserved.
#
# This source code is licensed under the license found in the
# LICENSE file in the root directory of this source tree.
from inspect import signature
from argparse import Namespace, ArgumentParser
from simuleval.data.segments import Segment, TextSegment, SpeechSegment, EmptySegment
from typing import Optional
from .states import AgentStates
from .actions import Action
SEGMENT_TYPE_DICT = {"text": TextSegment, "speech": SpeechSegment}
class GenericAgent:
"""
Generic Agent class.
"""
source_type = None
target_type = None
def __init__(self, args: Optional[Namespace] = None) -> None:
if args is not None:
self.args = args
assert self.source_type
assert self.target_type
self.device = "cpu"
self.states = self.build_states()
self.reset()
def build_states(self) -> AgentStates:
"""
Build states instance for agent
Returns:
AgentStates: agent states
"""
return AgentStates()
def reset(self) -> None:
"""
Reset agent, called every time when a new sentence coming in.
"""
self.states.reset()
def policy(self, states: Optional[AgentStates] = None) -> Action:
"""
The policy to make decision every time
when the system has new input.
The function has to return an Action instance
Args:
states (Optional[AgentStates]): an optional states for stateless agent
Returns:
Action: The actions to make at certain point.
.. note:
WriteAction means that the system has a prediction.
ReadAction means that the system needs more source.
When states are provided, the agent will become stateless and ignore self.states.
"""
assert NotImplementedError
def push(
self, source_segment: Segment, states: Optional[AgentStates] = None
) -> None:
"""
The function to process the incoming information.
Args:
source_info (dict): incoming information dictionary
states (Optional[AgentStates]): an optional states for stateless agent
"""
if states is None:
states = self.states
states.update_source(source_segment)
def pop(self, states: Optional[AgentStates] = None) -> Segment:
"""
The function to generate system output.
By default, it first runs policy,
and than returns the output segment.
If the policy decide to read,
it will return an empty segment.
Args:
states (Optional[AgentStates]): an optional states for stateless agent
Returns:
Segment: segment to return.
"""
if len(signature(self.policy).parameters) == 0:
is_stateless = False
if states:
raise RuntimeError("Feeding states to stateful agents.")
else:
is_stateless = True
if states is None:
states = self.states
if states.target_finished:
return EmptySegment(finished=True)
if is_stateless:
action = self.policy(states)
else:
action = self.policy()
if not isinstance(action, Action):
raise RuntimeError(
f"The return value of {self.policy.__qualname__} is not an {Action.__qualname__} instance"
)
if action.is_read():
return EmptySegment()
else:
if isinstance(action.content, Segment):
return action.content
segment = SEGMENT_TYPE_DICT[self.target_type](
index=0, content=action.content, finished=action.finished
)
states.update_target(segment)
return segment
def pushpop(
self, segment: Segment, states: Optional[AgentStates] = None
) -> Segment:
"""
Operate pop immediately after push.
Args:
segment (Segment): input segment
Returns:
Segment: output segment
"""
self.push(segment, states)
return self.pop(states)
@staticmethod
def add_args(parser: ArgumentParser):
"""
Add agent arguments to parser.
Has to be a static method.
Args:
parser (ArgumentParser): cli argument parser
"""
pass
@classmethod
def from_args(cls, args):
return cls(args)
def to(self, device: str, *args, **kwargs) -> None:
"""
Move agent to specified device.
Args:
device (str): Device to move agent to.
"""
pass
def __repr__(self) -> str:
return f"{self.__class__.__name__}[{self.source_type} -> {self.target_type}]"
def __str__(self) -> str:
return self.__repr__()
class SpeechToTextAgent(GenericAgent):
"""
Same as generic agent, but with explicit types
speech -> text
"""
source_type: str = "speech"
target_type: str = "text"
class SpeechToSpeechAgent(GenericAgent):
"""
Same as generic agent, but with explicit types
speech -> speech
"""
source_type: str = "speech"
target_type: str = "speech"
class TextToSpeechAgent(GenericAgent):
"""
Same as generic agent, but with explicit types
text -> speech
"""
source_type: str = "text"
target_type: str = "speech"
class TextToTextAgent(GenericAgent):
"""
Same as generic agent, but with explicit types
text -> text
"""
source_type: str = "text"
target_type: str = "text"
|