config_utils.py 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254
  1. #!/usr/bin/env python
  2. import argparse
  3. import os.path as osp
  4. from collections.abc import Mapping
  5. import yaml
  6. def _chain_maps(*maps):
  7. chained = dict()
  8. keys = set().union(*maps)
  9. for key in keys:
  10. vals = [m[key] for m in maps if key in m]
  11. if isinstance(vals[0], Mapping):
  12. chained[key] = _chain_maps(*vals)
  13. else:
  14. chained[key] = vals[0]
  15. return chained
  16. def read_config(config_path):
  17. with open(config_path, 'r', encoding='utf-8') as f:
  18. cfg = yaml.safe_load(f)
  19. return cfg or {}
  20. def parse_configs(cfg_path, inherit=True):
  21. if inherit:
  22. cfgs = []
  23. cfgs.append(read_config(cfg_path))
  24. while cfgs[-1].get('_base_'):
  25. base_path = cfgs[-1].pop('_base_')
  26. curr_dir = osp.dirname(cfg_path)
  27. cfgs.append(
  28. read_config(osp.normpath(osp.join(curr_dir, base_path))))
  29. return _chain_maps(*cfgs)
  30. else:
  31. return read_config(cfg_path)
  32. def _cfg2args(cfg, parser, prefix=''):
  33. node_keys = set()
  34. for k, v in cfg.items():
  35. opt = prefix + k
  36. if isinstance(v, list):
  37. if len(v) == 0:
  38. parser.add_argument(
  39. '--' + opt, type=object, nargs='*', default=v)
  40. else:
  41. # Only apply to homogeneous lists
  42. if isinstance(v[0], CfgNode):
  43. node_keys.add(opt)
  44. parser.add_argument(
  45. '--' + opt, type=type(v[0]), nargs='*', default=v)
  46. elif isinstance(v, dict):
  47. # Recursively parse a dict
  48. _, new_node_keys = _cfg2args(v, parser, opt + '.')
  49. node_keys.update(new_node_keys)
  50. elif isinstance(v, CfgNode):
  51. node_keys.add(opt)
  52. _, new_node_keys = _cfg2args(v.to_dict(), parser, opt + '.')
  53. node_keys.update(new_node_keys)
  54. elif isinstance(v, bool):
  55. parser.add_argument('--' + opt, action='store_true', default=v)
  56. else:
  57. parser.add_argument('--' + opt, type=type(v), default=v)
  58. return parser, node_keys
  59. def _args2cfg(cfg, args, node_keys):
  60. args = vars(args)
  61. for k, v in args.items():
  62. pos = k.find('.')
  63. if pos != -1:
  64. # Iteratively parse a dict
  65. dict_ = cfg
  66. while pos != -1:
  67. dict_.setdefault(k[:pos], {})
  68. dict_ = dict_[k[:pos]]
  69. k = k[pos + 1:]
  70. pos = k.find('.')
  71. dict_[k] = v
  72. else:
  73. cfg[k] = v
  74. for k in node_keys:
  75. pos = k.find('.')
  76. if pos != -1:
  77. # Iteratively parse a dict
  78. dict_ = cfg
  79. while pos != -1:
  80. dict_.setdefault(k[:pos], {})
  81. dict_ = dict_[k[:pos]]
  82. k = k[pos + 1:]
  83. pos = k.find('.')
  84. v = dict_[k]
  85. dict_[k] = [CfgNode(v_) for v_ in v] if isinstance(
  86. v, list) else CfgNode(v)
  87. else:
  88. v = cfg[k]
  89. cfg[k] = [CfgNode(v_) for v_ in v] if isinstance(
  90. v, list) else CfgNode(v)
  91. return cfg
  92. def parse_args(*args, **kwargs):
  93. cfg_parser = argparse.ArgumentParser(add_help=False)
  94. cfg_parser.add_argument('--config', type=str, default='')
  95. cfg_parser.add_argument('--inherit_off', action='store_true')
  96. cfg_args = cfg_parser.parse_known_args(*args, **kwargs)[0]
  97. cfg_path = cfg_args.config
  98. inherit_on = not cfg_args.inherit_off
  99. # Main parser
  100. parser = argparse.ArgumentParser(
  101. conflict_handler='resolve', parents=[cfg_parser])
  102. # Global settings
  103. parser.add_argument('cmd', choices=['train', 'eval'])
  104. parser.add_argument('task', choices=['cd', 'clas', 'det', 'res', 'seg'])
  105. parser.add_argument('--seed', type=int, default=None)
  106. # Data
  107. parser.add_argument('--datasets', type=dict, default={})
  108. parser.add_argument('--transforms', type=dict, default={})
  109. parser.add_argument('--download_on', action='store_true')
  110. parser.add_argument('--download_url', type=str, default='')
  111. parser.add_argument('--download_path', type=str, default='./')
  112. # Optimizer
  113. parser.add_argument('--optimizer', type=dict, default={})
  114. # Training related
  115. parser.add_argument('--num_epochs', type=int, default=100)
  116. parser.add_argument('--train_batch_size', type=int, default=8)
  117. parser.add_argument('--save_interval_epochs', type=int, default=1)
  118. parser.add_argument('--log_interval_steps', type=int, default=1)
  119. parser.add_argument('--save_dir', default='../exp/')
  120. parser.add_argument('--learning_rate', type=float, default=0.01)
  121. parser.add_argument('--early_stop', action='store_true')
  122. parser.add_argument('--early_stop_patience', type=int, default=5)
  123. parser.add_argument('--use_vdl', action='store_true')
  124. parser.add_argument('--resume_checkpoint', type=str)
  125. parser.add_argument('--train', type=dict, default={})
  126. # Loss
  127. parser.add_argument('--losses', type=dict, nargs='+', default={})
  128. # Model
  129. parser.add_argument('--model', type=dict, default={})
  130. if osp.exists(cfg_path):
  131. cfg = parse_configs(cfg_path, inherit_on)
  132. parser, node_keys = _cfg2args(cfg, parser, '')
  133. node_keys = sorted(node_keys, reverse=True)
  134. args = parser.parse_args(*args, **kwargs)
  135. return _args2cfg(dict(), args, node_keys)
  136. elif cfg_path != '':
  137. raise FileNotFoundError
  138. else:
  139. args = parser.parse_args(*args, **kwargs)
  140. return _args2cfg(dict(), args, set())
  141. class _CfgNodeMeta(yaml.YAMLObjectMetaclass):
  142. def __call__(cls, obj):
  143. if isinstance(obj, CfgNode):
  144. return obj
  145. return super(_CfgNodeMeta, cls).__call__(obj)
  146. class CfgNode(yaml.YAMLObject, metaclass=_CfgNodeMeta):
  147. yaml_tag = u'!Node'
  148. yaml_loader = yaml.SafeLoader
  149. # By default use a lexical scope
  150. ctx = globals()
  151. def __init__(self, dict_):
  152. super().__init__()
  153. self.type = dict_['type']
  154. self.args = dict_.get('args', [])
  155. self.module = dict_.get('module', '')
  156. @classmethod
  157. def set_context(cls, ctx):
  158. # TODO: Implement dynamic scope with inspect.stack()
  159. old_ctx = cls.ctx
  160. cls.ctx = ctx
  161. return old_ctx
  162. def build_object(self, mod=None):
  163. if mod is None:
  164. mod = self._get_module(self.module)
  165. cls = getattr(mod, self.type)
  166. if isinstance(self.args, list):
  167. args = build_objects(self.args)
  168. obj = cls(*args)
  169. elif isinstance(self.args, dict):
  170. args = build_objects(self.args)
  171. obj = cls(**args)
  172. else:
  173. raise NotImplementedError
  174. return obj
  175. def _get_module(self, s):
  176. mod = None
  177. while s:
  178. idx = s.find('.')
  179. if idx == -1:
  180. next_ = s
  181. s = ''
  182. else:
  183. next_ = s[:idx]
  184. s = s[idx + 1:]
  185. if mod is None:
  186. mod = self.ctx[next_]
  187. else:
  188. mod = getattr(mod, next_)
  189. return mod
  190. @staticmethod
  191. def build_objects(cfg, mod=None):
  192. if isinstance(cfg, list):
  193. return [CfgNode.build_objects(c, mod=mod) for c in cfg]
  194. elif isinstance(cfg, CfgNode):
  195. return cfg.build_object(mod=mod)
  196. elif isinstance(cfg, dict):
  197. return {
  198. k: CfgNode.build_objects(
  199. v, mod=mod)
  200. for k, v in cfg.items()
  201. }
  202. else:
  203. return cfg
  204. def __repr__(self):
  205. return f"(type={self.type}, args={self.args}, module={self.module or ' '})"
  206. @classmethod
  207. def from_yaml(cls, loader, node):
  208. map_ = loader.construct_mapping(node)
  209. return cls(map_)
  210. def items(self):
  211. yield from [('type', self.type), ('args', self.args), ('module',
  212. self.module)]
  213. def to_dict(self):
  214. return dict(self.items())
  215. def build_objects(cfg, mod=None):
  216. return CfgNode.build_objects(cfg, mod=mod)