deepspeed_checkpoint.py 12 KB

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