File size: 11,270 Bytes
de7cd93 | 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 | from weakref import ReferenceType
import ray
from ray.dag.dag_node import DAGNode
from ray.dag.input_node import InputNode
from ray.dag.format_utils import get_dag_node_str
from ray.dag.constants import (
PARENT_CLASS_NODE_KEY,
PREV_CLASS_METHOD_CALL_KEY,
BIND_INDEX_KEY,
IS_CLASS_METHOD_OUTPUT_KEY,
)
from ray.util.annotations import DeveloperAPI
from typing import Any, Dict, List, Union, Tuple, Optional
@DeveloperAPI
class ClassNode(DAGNode):
"""Represents an actor creation in a Ray task DAG."""
def __init__(
self,
cls,
cls_args,
cls_kwargs,
cls_options,
other_args_to_resolve=None,
):
self._body = cls
self._last_call: Optional["ClassMethodNode"] = None
super().__init__(
cls_args,
cls_kwargs,
cls_options,
other_args_to_resolve=other_args_to_resolve,
)
if self._contains_input_node():
raise ValueError(
"InputNode handles user dynamic input the the DAG, and "
"cannot be used as args, kwargs, or other_args_to_resolve "
"in ClassNode constructor because it is not available at "
"class construction or binding time."
)
def _copy_impl(
self,
new_args: List[Any],
new_kwargs: Dict[str, Any],
new_options: Dict[str, Any],
new_other_args_to_resolve: Dict[str, Any],
):
return ClassNode(
self._body,
new_args,
new_kwargs,
new_options,
other_args_to_resolve=new_other_args_to_resolve,
)
def _execute_impl(self, *args, **kwargs):
"""Executor of ClassNode by ray.remote()
Args and kwargs are to match base class signature, but not in the
implementation. All args and kwargs should be resolved and replaced
with value in bound_args and bound_kwargs via bottom-up recursion when
current node is executed.
"""
return (
ray.remote(self._body)
.options(**self._bound_options)
.remote(*self._bound_args, **self._bound_kwargs)
)
def _contains_input_node(self) -> bool:
"""Check if InputNode is used in children DAGNodes with current node
as the root.
"""
children_dag_nodes = self._get_all_child_nodes()
for child in children_dag_nodes:
if isinstance(child, InputNode):
return True
return False
def __getattr__(self, method_name: str):
# User trying to call .bind() without a bind class method
if method_name == "bind" and "bind" not in dir(self._body):
raise AttributeError(f".bind() cannot be used again on {type(self)} ")
# Raise an error if the method is invalid.
getattr(self._body, method_name)
call_node = _UnboundClassMethodNode(self, method_name, {})
return call_node
def __str__(self) -> str:
return get_dag_node_str(self, str(self._body))
class _UnboundClassMethodNode(object):
def __init__(self, actor: ClassNode, method_name: str, options: dict):
# TODO(sang): Theoretically, We should use weakref cuz it is
# a circular dependency but when I used weakref, it fails
# because we cannot serialize the weakref.
self._actor = actor
self._method_name = method_name
self._options = options
def bind(self, *args, **kwargs):
other_args_to_resolve = {
PARENT_CLASS_NODE_KEY: self._actor,
PREV_CLASS_METHOD_CALL_KEY: self._actor._last_call,
}
node = ClassMethodNode(
self._method_name,
args,
kwargs,
self._options,
other_args_to_resolve=other_args_to_resolve,
)
self._actor._last_call = node
return node
def __getattr__(self, attr: str):
if attr == "remote":
raise AttributeError(
".remote() cannot be used on ClassMethodNodes. Use .bind() instead "
"to express an symbolic actor call."
)
else:
return self.__getattribute__(attr)
def options(self, **options):
self._options = options
return self
class _ClassMethodOutput:
"""Represents a class method output in a Ray function DAG."""
def __init__(self, class_method_call: "ClassMethodNode", output_idx: int):
# The upstream class method call that returns multiple values.
self._class_method_call = class_method_call
# The output index of the return value from the upstream class method call.
self._output_idx = output_idx
@property
def class_method_call(self) -> "ClassMethodNode":
return self._class_method_call
@property
def output_idx(self) -> int:
return self._output_idx
@DeveloperAPI
class ClassMethodNode(DAGNode):
"""Represents an actor method invocation in a Ray function DAG."""
def __init__(
self,
method_name: str,
method_args: Tuple[Any],
method_kwargs: Dict[str, Any],
method_options: Dict[str, Any],
other_args_to_resolve: Dict[str, Any],
):
self._bound_args = method_args or []
self._bound_kwargs = method_kwargs or {}
self._bound_options = method_options or {}
self._method_name: str = method_name
# Parse other_args_to_resolve and assign to variables
self._parent_class_node: Union[
ClassNode, ReferenceType["ray._private.actor.ActorHandle"]
] = other_args_to_resolve.get(PARENT_CLASS_NODE_KEY)
# Used to track lineage of ClassMethodCall to preserve deterministic
# submission and execution order.
self._prev_class_method_call: Optional[
ClassMethodNode
] = other_args_to_resolve.get(PREV_CLASS_METHOD_CALL_KEY, None)
# The index/order when bind() is called on this class method
self._bind_index: Optional[int] = other_args_to_resolve.get(
BIND_INDEX_KEY, None
)
# Represent if the ClassMethodNode is a class method output. If True,
# the node is a placeholder for a return value from the ClassMethodNode
# that returns multiple values. If False, the node is a class method call.
self._is_class_method_output: bool = other_args_to_resolve.get(
IS_CLASS_METHOD_OUTPUT_KEY, False
)
# Represents the return value from the upstream ClassMethodNode that
# returns multiple values. If the node is a class method call, this is None.
self._class_method_output: Optional[_ClassMethodOutput] = None
if self._is_class_method_output:
# Set the upstream ClassMethodNode and the output index of the return
# value from `method_args`.
self._class_method_output = _ClassMethodOutput(
method_args[0], method_args[1]
)
# The actor creation task dependency is encoded as the first argument,
# and the ordering dependency as the second, which ensures they are
# executed prior to this node.
super().__init__(
method_args,
method_kwargs,
method_options,
other_args_to_resolve=other_args_to_resolve,
)
def _copy_impl(
self,
new_args: List[Any],
new_kwargs: Dict[str, Any],
new_options: Dict[str, Any],
new_other_args_to_resolve: Dict[str, Any],
):
return ClassMethodNode(
self._method_name,
new_args,
new_kwargs,
new_options,
other_args_to_resolve=new_other_args_to_resolve,
)
def _execute_impl(self, *args, **kwargs):
"""Executor of ClassMethodNode by ray.remote()
Args and kwargs are to match base class signature, but not in the
implementation. All args and kwargs should be resolved and replaced
with value in bound_args and bound_kwargs via bottom-up recursion when
current node is executed.
"""
if self.is_class_method_call:
method_body = getattr(self._parent_class_node, self._method_name)
# Execute with bound args.
return method_body.options(**self._bound_options).remote(
*self._bound_args,
**self._bound_kwargs,
)
else:
assert self._class_method_output is not None
return self._bound_args[0][self._class_method_output.output_idx]
def __str__(self) -> str:
return get_dag_node_str(self, f"{self._method_name}()")
def __repr__(self) -> str:
return self.__str__()
def get_method_name(self) -> str:
return self._method_name
def _get_bind_index(self) -> int:
return self._bind_index
def _get_remote_method(self, method_name):
method_body = getattr(self._parent_class_node, method_name)
return method_body
def _get_actor_handle(self) -> Optional["ray.actor.ActorHandle"]:
if not isinstance(self._parent_class_node, ray.actor.ActorHandle):
return None
return self._parent_class_node
@property
def num_returns(self) -> int:
"""
Return the number of return values from the class method call. If the
node is a class method output, return the number of return values from
the upstream class method call.
"""
if self.is_class_method_call:
num_returns = self._bound_options.get("num_returns", None)
if num_returns is None:
method = self._get_remote_method(self._method_name)
num_returns = method.__getstate__()["num_returns"]
return num_returns
else:
assert self._class_method_output is not None
return self._class_method_output.class_method_call.num_returns
@property
def is_class_method_call(self) -> bool:
"""
Return True if the node is a class method call, False if the node is a
class method output.
"""
return not self._is_class_method_output
@property
def is_class_method_output(self) -> bool:
"""
Return True if the node is a class method output, False if the node is a
class method call.
"""
return self._is_class_method_output
@property
def class_method_call(self) -> Optional["ClassMethodNode"]:
"""
Return the upstream class method call that returns multiple values. If
the node is a class method output, return None.
"""
if self._class_method_output is None:
return None
return self._class_method_output.class_method_call
@property
def output_idx(self) -> Optional[int]:
"""
Return the output index of the return value from the upstream class
method call that returns multiple values. If the node is a class method
call, return None.
"""
if self._class_method_output is None:
return None
return self._class_method_output.output_idx
|