deepspeed_checkpoint.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  1. '''Copyright The Microsoft DeepSpeed Team'''
  2. import os
  3. from typing import Dict
  4. import torch
  5. from .reshape_3d_utils import model_3d_desc
  6. from .reshape_utils import (basic_folder_validation,
  7. merge_state,
  8. partition_data,
  9. get_files,
  10. get_files_with_prefix)
  11. from .constants import (MODEL_FILE_PREFIX, LAYER_FILE_PREFIX)
  12. from .reshape_meg_2d import reshape_meg_2d_parallel, meg_2d_parallel_map
  13. from .zero_checkpoint import ZeROCheckpoint
  14. from .constants import *
  15. EMBEDDING_LAYER_INDEX = 0
  16. FINAL_LAYER_NORM_INDEX = -1
  17. ARGS_KEY = 'args'
  18. CHECKPOINT_INFO_KEY = 'checkpoint_info'
  19. ITERATION_KEY = 'iteration'
  20. SEQUENTIAL_LAYERS = [
  21. 'input_layernorm.weight',
  22. 'input_layernorm.bias',
  23. 'self_attention.dense.bias',
  24. 'post_attention_layernorm.weight',
  25. 'post_attention_layernorm.bias',
  26. 'mlp.dense_4h_to_h.bias',
  27. 'position_embeddings.weight'
  28. ]
  29. LAYER_CONCAT_DIM = {'self_attention.dense.weight': 1, 'mlp.dense_4h_to_h.weight': 1}
  30. class DeepSpeedCheckpoint(object):
  31. def __init__(self, dir, tp_degree=None, pp_degree=None, dp_degree=None):
  32. self.dir = dir
  33. self._validate_folder(dir)
  34. self.zero_checkpoint = ZeROCheckpoint(dir)
  35. self.file_list = get_files(dir)
  36. self.layer_files = get_files_with_prefix(self.file_list, LAYER_FILE_PREFIX)
  37. self.mp_rank_files = get_files_with_prefix(self.file_list, MODEL_FILE_PREFIX)
  38. self.layer_keys = self._get_layer_keys()
  39. self.layer_count = len(self.layer_keys)
  40. self.tp_degree = self.zero_checkpoint.get_src_tp_degree(
  41. ) if tp_degree is None else tp_degree
  42. self.pp_degree = self.zero_checkpoint.get_src_pp_degree(
  43. ) if pp_degree is None else pp_degree
  44. self.dp_degree = self.zero_checkpoint.get_src_dp_degree(
  45. ) if dp_degree is None else dp_degree
  46. self.original_world_size = self.zero_checkpoint.get_src_tp_degree(
  47. ) * self.zero_checkpoint.get_src_pp_degree(
  48. ) * self.zero_checkpoint.get_src_dp_degree()
  49. self.world_size = self.tp_degree * self.pp_degree * self.dp_degree
  50. self.old_2d_map = meg_2d_parallel_map(self.zero_checkpoint.get_src_pp_degree(),
  51. self.zero_checkpoint.get_src_tp_degree())
  52. self.old_2d_map.simple_init()
  53. self.new_2d_map = reshape_meg_2d_parallel(
  54. old_pp_degree=self.zero_checkpoint.get_src_pp_degree(),
  55. old_tp_degree=self.zero_checkpoint.get_src_tp_degree(),
  56. new_pp_degree=self.pp_degree,
  57. new_tp_degree=self.tp_degree)
  58. if self.is_change_pp_degree() or self.is_change_tp_degree(
  59. ) or self.is_change_dp_degree():
  60. self.zero_checkpoint.reshape(
  61. model_3d_desc(self.pp_degree,
  62. self.tp_degree,
  63. self.dp_degree))
  64. self.global_state = {}
  65. self._sanity_check()
  66. self.pp_to_transformer_map = self._build_pp_transformer_map()
  67. self.transformer_file_map = self._build_transformer_file_map()
  68. self.tp_to_embedding_map = self._build_tp_other_layer_map(EMBEDDING_LAYER_INDEX)
  69. self.tp_to_final_norm_map = self._build_tp_other_layer_map(
  70. FINAL_LAYER_NORM_INDEX)
  71. self._build_global_state()
  72. def is_change_tp_degree(self):
  73. return self.tp_degree != self.zero_checkpoint.get_src_tp_degree()
  74. def is_change_pp_degree(self):
  75. return self.pp_degree != self.zero_checkpoint.get_src_pp_degree()
  76. def is_change_dp_degree(self):
  77. return self.dp_degree != self.zero_checkpoint.get_src_dp_degree()
  78. def show_2d_mapping(self):
  79. print(f'reshaped 2d map ---- begin')
  80. for i in range(self.pp_degree):
  81. for j in range(self.tp_degree):
  82. file_list = self.get_2d_parallel_files(pp_index=i, tp_index=j)
  83. print(f'[{i}, {j}] = {file_list}')
  84. print(f'reshaped 2d map ---- end')
  85. def show_tp_embedding_map(self):
  86. self._dump_mapping(self.tp_to_embedding_map, 'tp_to_embedding_layers')
  87. def show_tp_final_norm_map(self):
  88. self._dump_mapping(self.tp_to_final_norm_map, 'tp_to_final_norm_layers')
  89. def show_pp_tranformer_map(self):
  90. self._dump_mapping(self.pp_to_transformer_map, 'pp_to_tranformer_layers')
  91. def show_transformer_file_map(self):
  92. self._dump_mapping(self.transformer_file_map, 'rank_to_tranformer_files')
  93. def _build_global_state(self):
  94. sd = torch.load(self.mp_rank_files[0], map_location=torch.device('cpu'))
  95. self.global_state[ITERATION_KEY] = sd.get(ITERATION_KEY, 0)
  96. self.global_state[ARGS_KEY] = sd.get(ARGS_KEY, None)
  97. def get_zero_checkpoint_state(self, pp_index, tp_index, dp_index) -> dict:
  98. return self.zero_checkpoint.get_state_for_rank(pp_index=pp_index,
  99. tp_index=tp_index,
  100. dp_index=dp_index,
  101. keys_to_ignore=[PARAM_SHAPES])
  102. def get_zero_files(self, pp_index, tp_index, dp_index) -> list:
  103. return self.zero_checkpoint.get_files_for_rank(pp_index=pp_index,
  104. tp_index=tp_index,
  105. dp_index=dp_index)
  106. def get_embedding_layer_id(self):
  107. return self.layer_keys[EMBEDDING_LAYER_INDEX]
  108. def get_final_norm_layer_id(self):
  109. return self.layer_keys[FINAL_LAYER_NORM_INDEX]
  110. def get_iteration(self):
  111. if not ITERATION_KEY in self.global_state:
  112. sd = torch.load(self.mp_rank_files[0], map_location=torch.device('cpu'))
  113. self.global_state[ITERATION_KEY] = sd.get(ITERATION_KEY, 0)
  114. return self.global_state[ITERATION_KEY]
  115. def get_embedding_state(self, tp_index: int) -> Dict:
  116. assert tp_index in self.tp_to_embedding_map.keys()
  117. sd_list = [
  118. torch.load(fname,
  119. map_location=torch.device('cpu'))
  120. for fname in self.tp_to_embedding_map[tp_index]
  121. ]
  122. sd = self._merge_state_dicts(sd_list)
  123. return sd
  124. def get_embedding_files(self, tp_index: int) -> list:
  125. assert tp_index in self.tp_to_embedding_map.keys()
  126. return self.tp_to_embedding_map[tp_index]
  127. def _get_checkpoint_value(self, key):
  128. if not key in self.global_state:
  129. sd = torch.load(self.mp_rank_files[0], map_location=torch.device('cpu'))
  130. self.global_state[key] = sd.get(key, None)
  131. return self.global_state[key]
  132. def get_args(self):
  133. return self._get_checkpoint_value(ARGS_KEY)
  134. def get_checkpoint_info(self, info_key=CHECKPOINT_INFO_KEY):
  135. return self._get_checkpoint_value(info_key)
  136. def get_2d_parallel_state(self, tp_index: int, pp_index: int) -> dict:
  137. assert tp_index < self.tp_degree
  138. assert pp_index < self.pp_degree
  139. fname_list = self.get_2d_parallel_files(tp_index=tp_index, pp_index=pp_index)
  140. sd_list = [
  141. torch.load(fname,
  142. map_location=torch.device('cpu')) for fname in fname_list
  143. ]
  144. merged_sd = None
  145. for sd in sd_list:
  146. if merged_sd is None:
  147. merged_sd = sd
  148. else:
  149. merged_sd = merge_state(merged_sd, sd)
  150. return merged_sd
  151. def get_transformer_state(self, tp_index: int, pp_index: int) -> list:
  152. assert tp_index < self.tp_degree
  153. assert pp_index < self.pp_degree
  154. t_list = []
  155. for fname_list in self.transformer_file_map[(tp_index, pp_index)]:
  156. sd_list = [
  157. torch.load(fname,
  158. map_location=torch.device('cpu')) for fname in fname_list
  159. ]
  160. sd = self._merge_state_dicts(sd_list)
  161. t_list.append(sd)
  162. return t_list
  163. def get_pp_transformer_map(self, pp_index: int) -> list:
  164. assert pp_index < self.pp_degree
  165. return self.pp_to_transformer_map[pp_index]
  166. def get_final_norm_state(self, tp_index: int) -> Dict:
  167. assert tp_index in self.tp_to_final_norm_map.keys()
  168. sd = torch.load(self.tp_to_final_norm_map[tp_index][0],
  169. map_location=torch.device('cpu'))
  170. return sd
  171. def get_final_norm_files(self, tp_index: int) -> list:
  172. assert tp_index in self.tp_to_final_norm_map.keys()
  173. return self.tp_to_final_norm_map[tp_index]
  174. def _build_tp_other_layer_map(self, layer_index: int):
  175. assert layer_index < len(self.layer_files)
  176. layer_files = get_files_with_prefix(self.layer_files,
  177. self.layer_keys[layer_index])
  178. layer_file_partitions = partition_data(layer_files, self.tp_degree)
  179. data_map = {i: flist for i, flist in enumerate(layer_file_partitions)}
  180. return data_map
  181. def get_2d_parallel_files(self, tp_index: int, pp_index: int) -> list:
  182. assert tp_index < self.tp_degree
  183. assert pp_index < self.pp_degree
  184. file_indices = self.new_2d_map.get_data(pp_index=pp_index, tp_index=tp_index)
  185. return [self.mp_rank_files[i] for i in file_indices]
  186. def _build_pp_transformer_map(self):
  187. data_map = {}
  188. transformer_layers = self.layer_keys[1:-1]
  189. layers_per_pp = len(transformer_layers) // self.pp_degree
  190. data_map = {
  191. i: transformer_layers[i * layers_per_pp:(i + 1) * layers_per_pp]
  192. for i in range(0,
  193. self.pp_degree)
  194. }
  195. return data_map
  196. def _dump_mapping(self, data_map, map_tag=None):
  197. if map_tag is not None:
  198. print(f'Dump mapping: {map_tag}')
  199. for k, v in data_map.items():
  200. print(f'{k} = {v}')
  201. def _build_transformer_file_map(self):
  202. transformer_layer_keys = self.layer_keys[1:-1]
  203. file_map = {}
  204. # XXX: this is not guaranteed
  205. layers_per_pp = len(transformer_layer_keys) // self.pp_degree
  206. if layers_per_pp == 0:
  207. layers_per_pp = 1
  208. #print(f"{transformer_layer_keys} {layers_per_pp}")
  209. for key_index, layer_key in enumerate(transformer_layer_keys):
  210. pp_index = key_index // layers_per_pp
  211. layer_files = get_files_with_prefix(self.layer_files, layer_key)
  212. layer_file_partitions = partition_data(layer_files, self.tp_degree)
  213. for tp_index in range(self.tp_degree):
  214. map_key = (tp_index, pp_index)
  215. if not map_key in file_map.keys():
  216. file_map[map_key] = []
  217. file_map[map_key].append(layer_file_partitions[tp_index])
  218. return file_map
  219. def _sanity_check(self):
  220. assert len(self.mp_rank_files) % self.tp_degree == 0
  221. assert len(self.layer_keys) > 2
  222. assert self.zero_checkpoint.num_files % (self.pp_degree * self.tp_degree) == 0
  223. # XXX: fix me - isn't always the case
  224. # only true with --pp-partition-method 'type:transformer|embedding' \
  225. # assert (len(self.layer_keys) - 2) % self.pp_degree == 0
  226. def validate_files(self):
  227. for file in self.file_list:
  228. if not os.path.isfile(file):
  229. print(f'Error: {file} is not existent')
  230. def _get_layer_keys(self):
  231. key_set = set()
  232. key_len = len(LAYER_FILE_PREFIX) + 2
  233. for file_path in self.layer_files:
  234. _, fname = os.path.split(file_path)
  235. key_set.add(fname[:key_len])
  236. return sorted(list(key_set))
  237. def _merge_state_dicts(self, sd_list):
  238. merged_sd = {}
  239. for key in sd_list[0].keys():
  240. if not key in SEQUENTIAL_LAYERS:
  241. cat_dim = LAYER_CONCAT_DIM.get(key, 0)
  242. merged_sd[key] = torch.cat([sd[key] for sd in sd_list], dim=cat_dim)
  243. else:
  244. merged_sd[key] = sd_list[0][key]
  245. return merged_sd
  246. def _validate_folder(self, dir):
  247. basic_folder_validation(dir)
  248. file_list = get_files(dir)
  249. for file_prefix in [
  250. MODEL_FILE_PREFIX,
  251. LAYER_FILE_PREFIX,
  252. f'{LAYER_FILE_PREFIX}01'
  253. ]:
  254. ckpt_files = get_files_with_prefix(file_list, file_prefix)
  255. assert len(ckpt_files) > 0, f'{dir} seems a bogus DeepSpeed checkpoint folder: Cannot find {file_prefix}* files in there.'