visionnet.py 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438
  1. import gym
  2. from typing import Dict, List, Optional, Sequence
  3. from ray.rllib.models.tf.tf_modelv2 import TFModelV2
  4. from ray.rllib.models.tf.misc import normc_initializer
  5. from ray.rllib.models.utils import get_activation_fn, get_filter_config
  6. from ray.rllib.policy.sample_batch import SampleBatch
  7. from ray.rllib.utils.framework import try_import_tf
  8. from ray.rllib.utils.typing import ModelConfigDict, TensorType
  9. tf1, tf, tfv = try_import_tf()
  10. # TODO: (sven) obsolete this class once we only support native keras models.
  11. class VisionNetwork(TFModelV2):
  12. """Generic vision network implemented in ModelV2 API.
  13. An additional post-conv fully connected stack can be added and configured
  14. via the config keys:
  15. `post_fcnet_hiddens`: Dense layer sizes after the Conv2D stack.
  16. `post_fcnet_activation`: Activation function to use for this FC stack.
  17. """
  18. def __init__(self, obs_space: gym.spaces.Space,
  19. action_space: gym.spaces.Space, num_outputs: int,
  20. model_config: ModelConfigDict, name: str):
  21. if not model_config.get("conv_filters"):
  22. model_config["conv_filters"] = get_filter_config(obs_space.shape)
  23. super(VisionNetwork, self).__init__(obs_space, action_space,
  24. num_outputs, model_config, name)
  25. activation = get_activation_fn(
  26. self.model_config.get("conv_activation"), framework="tf")
  27. filters = self.model_config["conv_filters"]
  28. assert len(filters) > 0,\
  29. "Must provide at least 1 entry in `conv_filters`!"
  30. # Post FC net config.
  31. post_fcnet_hiddens = model_config.get("post_fcnet_hiddens", [])
  32. post_fcnet_activation = get_activation_fn(
  33. model_config.get("post_fcnet_activation"), framework="tf")
  34. no_final_linear = self.model_config.get("no_final_linear")
  35. vf_share_layers = self.model_config.get("vf_share_layers")
  36. input_shape = obs_space.shape
  37. self.data_format = "channels_last"
  38. inputs = tf.keras.layers.Input(shape=input_shape, name="observations")
  39. last_layer = inputs
  40. # Whether the last layer is the output of a Flattened (rather than
  41. # a n x (1,1) Conv2D).
  42. self.last_layer_is_flattened = False
  43. # Build the action layers
  44. for i, (out_size, kernel, stride) in enumerate(filters[:-1], 1):
  45. last_layer = tf.keras.layers.Conv2D(
  46. out_size,
  47. kernel,
  48. strides=stride
  49. if isinstance(stride, (list, tuple)) else (stride, stride),
  50. activation=activation,
  51. padding="same",
  52. data_format="channels_last",
  53. name="conv{}".format(i))(last_layer)
  54. out_size, kernel, stride = filters[-1]
  55. # No final linear: Last layer has activation function and exits with
  56. # num_outputs nodes (this could be a 1x1 conv or a FC layer, depending
  57. # on `post_fcnet_...` settings).
  58. if no_final_linear and num_outputs:
  59. last_layer = tf.keras.layers.Conv2D(
  60. out_size if post_fcnet_hiddens else num_outputs,
  61. kernel,
  62. strides=stride
  63. if isinstance(stride, (list, tuple)) else (stride, stride),
  64. activation=activation,
  65. padding="valid",
  66. data_format="channels_last",
  67. name="conv_out")(last_layer)
  68. # Add (optional) post-fc-stack after last Conv2D layer.
  69. layer_sizes = post_fcnet_hiddens[:-1] + ([num_outputs]
  70. if post_fcnet_hiddens else
  71. [])
  72. feature_out = last_layer
  73. for i, out_size in enumerate(layer_sizes):
  74. feature_out = last_layer
  75. last_layer = tf.keras.layers.Dense(
  76. out_size,
  77. name="post_fcnet_{}".format(i),
  78. activation=post_fcnet_activation,
  79. kernel_initializer=normc_initializer(1.0))(last_layer)
  80. # Finish network normally (w/o overriding last layer size with
  81. # `num_outputs`), then add another linear one of size `num_outputs`.
  82. else:
  83. last_layer = tf.keras.layers.Conv2D(
  84. out_size,
  85. kernel,
  86. strides=stride
  87. if isinstance(stride, (list, tuple)) else (stride, stride),
  88. activation=activation,
  89. padding="valid",
  90. data_format="channels_last",
  91. name="conv{}".format(len(filters)))(last_layer)
  92. # num_outputs defined. Use that to create an exact
  93. # `num_output`-sized (1,1)-Conv2D.
  94. if num_outputs:
  95. if post_fcnet_hiddens:
  96. last_cnn = last_layer = tf.keras.layers.Conv2D(
  97. post_fcnet_hiddens[0], [1, 1],
  98. activation=post_fcnet_activation,
  99. padding="same",
  100. data_format="channels_last",
  101. name="conv_out")(last_layer)
  102. # Add (optional) post-fc-stack after last Conv2D layer.
  103. for i, out_size in enumerate(post_fcnet_hiddens[1:] +
  104. [num_outputs]):
  105. feature_out = last_layer
  106. last_layer = tf.keras.layers.Dense(
  107. out_size,
  108. name="post_fcnet_{}".format(i + 1),
  109. activation=post_fcnet_activation
  110. if i < len(post_fcnet_hiddens) - 1 else None,
  111. kernel_initializer=normc_initializer(1.0))(
  112. last_layer)
  113. else:
  114. feature_out = last_layer
  115. last_cnn = last_layer = tf.keras.layers.Conv2D(
  116. num_outputs, [1, 1],
  117. activation=None,
  118. padding="same",
  119. data_format="channels_last",
  120. name="conv_out")(last_layer)
  121. if last_cnn.shape[1] != 1 or last_cnn.shape[2] != 1:
  122. raise ValueError(
  123. "Given `conv_filters` ({}) do not result in a [B, 1, "
  124. "1, {} (`num_outputs`)] shape (but in {})! Please "
  125. "adjust your Conv2D stack such that the dims 1 and 2 "
  126. "are both 1.".format(self.model_config["conv_filters"],
  127. self.num_outputs,
  128. list(last_cnn.shape)))
  129. # num_outputs not known -> Flatten, then set self.num_outputs
  130. # to the resulting number of nodes.
  131. else:
  132. self.last_layer_is_flattened = True
  133. last_layer = tf.keras.layers.Flatten(
  134. data_format="channels_last")(last_layer)
  135. # Add (optional) post-fc-stack after last Conv2D layer.
  136. for i, out_size in enumerate(post_fcnet_hiddens):
  137. last_layer = tf.keras.layers.Dense(
  138. out_size,
  139. name="post_fcnet_{}".format(i),
  140. activation=post_fcnet_activation,
  141. kernel_initializer=normc_initializer(1.0))(last_layer)
  142. feature_out = last_layer
  143. self.num_outputs = last_layer.shape[1]
  144. logits_out = last_layer
  145. # Build the value layers
  146. if vf_share_layers:
  147. if not self.last_layer_is_flattened:
  148. feature_out = tf.keras.layers.Lambda(
  149. lambda x: tf.squeeze(x, axis=[1, 2]))(feature_out)
  150. value_out = tf.keras.layers.Dense(
  151. 1,
  152. name="value_out",
  153. activation=None,
  154. kernel_initializer=normc_initializer(0.01))(feature_out)
  155. else:
  156. # build a parallel set of hidden layers for the value net
  157. last_layer = inputs
  158. for i, (out_size, kernel, stride) in enumerate(filters[:-1], 1):
  159. last_layer = tf.keras.layers.Conv2D(
  160. out_size,
  161. kernel,
  162. strides=stride
  163. if isinstance(stride, (list, tuple)) else (stride, stride),
  164. activation=activation,
  165. padding="same",
  166. data_format="channels_last",
  167. name="conv_value_{}".format(i))(last_layer)
  168. out_size, kernel, stride = filters[-1]
  169. last_layer = tf.keras.layers.Conv2D(
  170. out_size,
  171. kernel,
  172. strides=stride
  173. if isinstance(stride, (list, tuple)) else (stride, stride),
  174. activation=activation,
  175. padding="valid",
  176. data_format="channels_last",
  177. name="conv_value_{}".format(len(filters)))(last_layer)
  178. last_layer = tf.keras.layers.Conv2D(
  179. 1, [1, 1],
  180. activation=None,
  181. padding="same",
  182. data_format="channels_last",
  183. name="conv_value_out")(last_layer)
  184. value_out = tf.keras.layers.Lambda(
  185. lambda x: tf.squeeze(x, axis=[1, 2]))(last_layer)
  186. self.base_model = tf.keras.Model(inputs, [logits_out, value_out])
  187. def forward(self, input_dict: Dict[str, TensorType],
  188. state: List[TensorType],
  189. seq_lens: TensorType) -> (TensorType, List[TensorType]):
  190. obs = input_dict["obs"]
  191. if self.data_format == "channels_first":
  192. obs = tf.transpose(obs, [0, 2, 3, 1])
  193. # Explicit cast to float32 needed in eager.
  194. model_out, self._value_out = self.base_model(tf.cast(obs, tf.float32))
  195. # Our last layer is already flat.
  196. if self.last_layer_is_flattened:
  197. return model_out, state
  198. # Last layer is a n x [1,1] Conv2D -> Flatten.
  199. else:
  200. return tf.squeeze(model_out, axis=[1, 2]), state
  201. def value_function(self) -> TensorType:
  202. return tf.reshape(self._value_out, [-1])
  203. class Keras_VisionNetwork(tf.keras.Model if tf else object):
  204. """Generic vision network implemented in tf keras.
  205. An additional post-conv fully connected stack can be added and configured
  206. via the config keys:
  207. `post_fcnet_hiddens`: Dense layer sizes after the Conv2D stack.
  208. `post_fcnet_activation`: Activation function to use for this FC stack.
  209. """
  210. def __init__(
  211. self,
  212. input_space: gym.spaces.Space,
  213. action_space: gym.spaces.Space,
  214. num_outputs: Optional[int] = None,
  215. *,
  216. name: str = "",
  217. conv_filters: Optional[Sequence[Sequence[int]]] = None,
  218. conv_activation: Optional[str] = None,
  219. post_fcnet_hiddens: Optional[Sequence[int]] = (),
  220. post_fcnet_activation: Optional[str] = None,
  221. no_final_linear: bool = False,
  222. vf_share_layers: bool = False,
  223. free_log_std: bool = False,
  224. **kwargs,
  225. ):
  226. super().__init__(name=name)
  227. if not conv_filters:
  228. conv_filters = get_filter_config(input_space.shape)
  229. assert len(conv_filters) > 0,\
  230. "Must provide at least 1 entry in `conv_filters`!"
  231. conv_activation = get_activation_fn(conv_activation, framework="tf")
  232. post_fcnet_activation = get_activation_fn(
  233. post_fcnet_activation, framework="tf")
  234. input_shape = input_space.shape
  235. self.data_format = "channels_last"
  236. inputs = tf.keras.layers.Input(shape=input_shape, name="observations")
  237. last_layer = inputs
  238. # Whether the last layer is the output of a Flattened (rather than
  239. # a n x (1,1) Conv2D).
  240. self.last_layer_is_flattened = False
  241. # Build the action layers
  242. for i, (out_size, kernel, stride) in enumerate(conv_filters[:-1], 1):
  243. last_layer = tf.keras.layers.Conv2D(
  244. out_size,
  245. kernel,
  246. strides=stride
  247. if isinstance(stride, (list, tuple)) else (stride, stride),
  248. activation=conv_activation,
  249. padding="same",
  250. data_format="channels_last",
  251. name="conv{}".format(i))(last_layer)
  252. out_size, kernel, stride = conv_filters[-1]
  253. # No final linear: Last layer has activation function and exits with
  254. # num_outputs nodes (this could be a 1x1 conv or a FC layer, depending
  255. # on `post_fcnet_...` settings).
  256. if no_final_linear and num_outputs:
  257. last_layer = tf.keras.layers.Conv2D(
  258. out_size if post_fcnet_hiddens else num_outputs,
  259. kernel,
  260. strides=stride
  261. if isinstance(stride, (list, tuple)) else (stride, stride),
  262. activation=conv_activation,
  263. padding="valid",
  264. data_format="channels_last",
  265. name="conv_out")(last_layer)
  266. # Add (optional) post-fc-stack after last Conv2D layer.
  267. layer_sizes = post_fcnet_hiddens[:-1] + ([num_outputs]
  268. if post_fcnet_hiddens else
  269. [])
  270. for i, out_size in enumerate(layer_sizes):
  271. last_layer = tf.keras.layers.Dense(
  272. out_size,
  273. name="post_fcnet_{}".format(i),
  274. activation=post_fcnet_activation,
  275. kernel_initializer=normc_initializer(1.0))(last_layer)
  276. # Finish network normally (w/o overriding last layer size with
  277. # `num_outputs`), then add another linear one of size `num_outputs`.
  278. else:
  279. last_layer = tf.keras.layers.Conv2D(
  280. out_size,
  281. kernel,
  282. strides=stride
  283. if isinstance(stride, (list, tuple)) else (stride, stride),
  284. activation=conv_activation,
  285. padding="valid",
  286. data_format="channels_last",
  287. name="conv{}".format(len(conv_filters)))(last_layer)
  288. # num_outputs defined. Use that to create an exact
  289. # `num_output`-sized (1,1)-Conv2D.
  290. if num_outputs:
  291. if post_fcnet_hiddens:
  292. last_cnn = last_layer = tf.keras.layers.Conv2D(
  293. post_fcnet_hiddens[0], [1, 1],
  294. activation=post_fcnet_activation,
  295. padding="same",
  296. data_format="channels_last",
  297. name="conv_out")(last_layer)
  298. # Add (optional) post-fc-stack after last Conv2D layer.
  299. for i, out_size in enumerate(post_fcnet_hiddens[1:] +
  300. [num_outputs]):
  301. last_layer = tf.keras.layers.Dense(
  302. out_size,
  303. name="post_fcnet_{}".format(i + 1),
  304. activation=post_fcnet_activation
  305. if i < len(post_fcnet_hiddens) - 1 else None,
  306. kernel_initializer=normc_initializer(1.0))(
  307. last_layer)
  308. else:
  309. last_cnn = last_layer = tf.keras.layers.Conv2D(
  310. num_outputs, [1, 1],
  311. activation=None,
  312. padding="same",
  313. data_format="channels_last",
  314. name="conv_out")(last_layer)
  315. if last_cnn.shape[1] != 1 or last_cnn.shape[2] != 1:
  316. raise ValueError(
  317. "Given `conv_filters` ({}) do not result in a [B, 1, "
  318. "1, {} (`num_outputs`)] shape (but in {})! Please "
  319. "adjust your Conv2D stack such that the dims 1 and 2 "
  320. "are both 1.".format(
  321. self.model_config["conv_filters"], num_outputs,
  322. list(last_cnn.shape)))
  323. # num_outputs not known -> Flatten.
  324. else:
  325. self.last_layer_is_flattened = True
  326. last_layer = tf.keras.layers.Flatten(
  327. data_format="channels_last")(last_layer)
  328. # Add (optional) post-fc-stack after last Conv2D layer.
  329. for i, out_size in enumerate(post_fcnet_hiddens):
  330. last_layer = tf.keras.layers.Dense(
  331. out_size,
  332. name="post_fcnet_{}".format(i),
  333. activation=post_fcnet_activation,
  334. kernel_initializer=normc_initializer(1.0))(last_layer)
  335. logits_out = last_layer
  336. # Build the value layers
  337. if vf_share_layers:
  338. if not self.last_layer_is_flattened:
  339. last_layer = tf.keras.layers.Lambda(
  340. lambda x: tf.squeeze(x, axis=[1, 2]))(last_layer)
  341. value_out = tf.keras.layers.Dense(
  342. 1,
  343. name="value_out",
  344. activation=None,
  345. kernel_initializer=normc_initializer(0.01))(last_layer)
  346. else:
  347. # build a parallel set of hidden layers for the value net
  348. last_layer = inputs
  349. for i, (out_size, kernel, stride) in enumerate(
  350. conv_filters[:-1], 1):
  351. last_layer = tf.keras.layers.Conv2D(
  352. out_size,
  353. kernel,
  354. strides=stride
  355. if isinstance(stride, (list, tuple)) else (stride, stride),
  356. activation=conv_activation,
  357. padding="same",
  358. data_format="channels_last",
  359. name="conv_value_{}".format(i))(last_layer)
  360. out_size, kernel, stride = conv_filters[-1]
  361. last_layer = tf.keras.layers.Conv2D(
  362. out_size,
  363. kernel,
  364. strides=stride
  365. if isinstance(stride, (list, tuple)) else (stride, stride),
  366. activation=conv_activation,
  367. padding="valid",
  368. data_format="channels_last",
  369. name="conv_value_{}".format(len(conv_filters)))(last_layer)
  370. last_layer = tf.keras.layers.Conv2D(
  371. 1, [1, 1],
  372. activation=None,
  373. padding="same",
  374. data_format="channels_last",
  375. name="conv_value_out")(last_layer)
  376. value_out = tf.keras.layers.Lambda(
  377. lambda x: tf.squeeze(x, axis=[1, 2]))(last_layer)
  378. self.base_model = tf.keras.Model(inputs, [logits_out, value_out])
  379. def call(self, input_dict: SampleBatch) -> \
  380. (TensorType, List[TensorType], Dict[str, TensorType]):
  381. obs = input_dict["obs"]
  382. if self.data_format == "channels_first":
  383. obs = tf.transpose(obs, [0, 2, 3, 1])
  384. # Explicit cast to float32 needed in eager.
  385. model_out, self._value_out = self.base_model(tf.cast(obs, tf.float32))
  386. state = [v for k, v in input_dict.items() if k.startswith("state_in_")]
  387. extra_outs = {SampleBatch.VF_PREDS: tf.reshape(self._value_out, [-1])}
  388. # Our last layer is already flat.
  389. if self.last_layer_is_flattened:
  390. return model_out, state, extra_outs
  391. # Last layer is a n x [1,1] Conv2D -> Flatten.
  392. else:
  393. return tf.squeeze(model_out, axis=[1, 2]), state, extra_outs