custom_keras_model.py 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. """Example of using a custom ModelV2 Keras-style model."""
  2. import argparse
  3. import os
  4. import ray
  5. from ray import tune
  6. from ray.rllib.agents.dqn.distributional_q_tf_model import \
  7. DistributionalQTFModel
  8. from ray.rllib.models import ModelCatalog
  9. from ray.rllib.models.tf.misc import normc_initializer
  10. from ray.rllib.models.tf.tf_modelv2 import TFModelV2
  11. from ray.rllib.models.tf.visionnet import VisionNetwork as MyVisionNetwork
  12. from ray.rllib.policy.sample_batch import DEFAULT_POLICY_ID
  13. from ray.rllib.utils.framework import try_import_tf
  14. from ray.rllib.utils.metrics.learner_info import LEARNER_INFO, \
  15. LEARNER_STATS_KEY
  16. tf1, tf, tfv = try_import_tf()
  17. parser = argparse.ArgumentParser()
  18. parser.add_argument(
  19. "--run",
  20. type=str,
  21. default="DQN",
  22. help="The RLlib-registered algorithm to use.")
  23. parser.add_argument("--stop", type=int, default=200)
  24. parser.add_argument("--use-vision-network", action="store_true")
  25. parser.add_argument("--num-cpus", type=int, default=0)
  26. class MyKerasModel(TFModelV2):
  27. """Custom model for policy gradient algorithms."""
  28. def __init__(self, obs_space, action_space, num_outputs, model_config,
  29. name):
  30. super(MyKerasModel, self).__init__(obs_space, action_space,
  31. num_outputs, model_config, name)
  32. self.inputs = tf.keras.layers.Input(
  33. shape=obs_space.shape, name="observations")
  34. layer_1 = tf.keras.layers.Dense(
  35. 128,
  36. name="my_layer1",
  37. activation=tf.nn.relu,
  38. kernel_initializer=normc_initializer(1.0))(self.inputs)
  39. layer_out = tf.keras.layers.Dense(
  40. num_outputs,
  41. name="my_out",
  42. activation=None,
  43. kernel_initializer=normc_initializer(0.01))(layer_1)
  44. value_out = tf.keras.layers.Dense(
  45. 1,
  46. name="value_out",
  47. activation=None,
  48. kernel_initializer=normc_initializer(0.01))(layer_1)
  49. self.base_model = tf.keras.Model(self.inputs, [layer_out, value_out])
  50. def forward(self, input_dict, state, seq_lens):
  51. model_out, self._value_out = self.base_model(input_dict["obs"])
  52. return model_out, state
  53. def value_function(self):
  54. return tf.reshape(self._value_out, [-1])
  55. def metrics(self):
  56. return {"foo": tf.constant(42.0)}
  57. class MyKerasQModel(DistributionalQTFModel):
  58. """Custom model for DQN."""
  59. def __init__(self, obs_space, action_space, num_outputs, model_config,
  60. name, **kw):
  61. super(MyKerasQModel, self).__init__(
  62. obs_space, action_space, num_outputs, model_config, name, **kw)
  63. # Define the core model layers which will be used by the other
  64. # output heads of DistributionalQModel
  65. self.inputs = tf.keras.layers.Input(
  66. shape=obs_space.shape, name="observations")
  67. layer_1 = tf.keras.layers.Dense(
  68. 128,
  69. name="my_layer1",
  70. activation=tf.nn.relu,
  71. kernel_initializer=normc_initializer(1.0))(self.inputs)
  72. layer_out = tf.keras.layers.Dense(
  73. num_outputs,
  74. name="my_out",
  75. activation=tf.nn.relu,
  76. kernel_initializer=normc_initializer(1.0))(layer_1)
  77. self.base_model = tf.keras.Model(self.inputs, layer_out)
  78. # Implement the core forward method.
  79. def forward(self, input_dict, state, seq_lens):
  80. model_out = self.base_model(input_dict["obs"])
  81. return model_out, state
  82. def metrics(self):
  83. return {"foo": tf.constant(42.0)}
  84. if __name__ == "__main__":
  85. args = parser.parse_args()
  86. ray.init(num_cpus=args.num_cpus or None)
  87. ModelCatalog.register_custom_model(
  88. "keras_model", MyVisionNetwork
  89. if args.use_vision_network else MyKerasModel)
  90. ModelCatalog.register_custom_model(
  91. "keras_q_model", MyVisionNetwork
  92. if args.use_vision_network else MyKerasQModel)
  93. # Tests https://github.com/ray-project/ray/issues/7293
  94. def check_has_custom_metric(result):
  95. r = result["result"]["info"][LEARNER_INFO]
  96. if DEFAULT_POLICY_ID in r:
  97. r = r[DEFAULT_POLICY_ID].get(LEARNER_STATS_KEY,
  98. r[DEFAULT_POLICY_ID])
  99. assert r["model"]["foo"] == 42, result
  100. if args.run == "DQN":
  101. extra_config = {"learning_starts": 0}
  102. else:
  103. extra_config = {}
  104. tune.run(
  105. args.run,
  106. stop={"episode_reward_mean": args.stop},
  107. config=dict(
  108. extra_config,
  109. **{
  110. "env": "BreakoutNoFrameskip-v4"
  111. if args.use_vision_network else "CartPole-v0",
  112. # Use GPUs iff `RLLIB_NUM_GPUS` env var set to > 0.
  113. "num_gpus": int(os.environ.get("RLLIB_NUM_GPUS", "0")),
  114. "callbacks": {
  115. "on_train_result": check_has_custom_metric,
  116. },
  117. "model": {
  118. "custom_model": "keras_q_model"
  119. if args.run == "DQN" else "keras_model"
  120. },
  121. "framework": "tf",
  122. }))