cpu_accelerator.py 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344
  1. # Copyright (c) Microsoft Corporation.
  2. # SPDX-License-Identifier: Apache-2.0
  3. # DeepSpeed Team
  4. import torch
  5. from .abstract_accelerator import DeepSpeedAccelerator
  6. try:
  7. import oneccl_bindings_for_pytorch # noqa: F401 # type: ignore
  8. oneccl_imported_p = True
  9. except ImportError as e:
  10. oneccl_imported_p = False
  11. import os
  12. # accelerator for Intel CPU
  13. class CPU_Accelerator(DeepSpeedAccelerator):
  14. def __init__(self):
  15. self._name = 'cpu'
  16. self._compile_backend = "inductor"
  17. if oneccl_imported_p:
  18. self._communication_backend_name = 'ccl'
  19. else:
  20. # fallback to gloo if oneccl_binding_for_pytorch is not installed
  21. self._communication_backend_name = 'gloo'
  22. try:
  23. import psutil
  24. mem = psutil.Process().memory_info().rss
  25. self.max_mem = mem
  26. except ImportError as e:
  27. self.max_mem = 0
  28. def is_synchronized_device(self):
  29. return True
  30. def use_host_timers(self):
  31. return self.is_synchronized_device()
  32. def resolves_data_dependency(self):
  33. return self.is_synchronized_device()
  34. def handles_memory_backpressure(self):
  35. return self.is_synchronized_device()
  36. # Device APIs
  37. def device_name(self, device_index=None):
  38. return 'cpu'
  39. def device(self, device_index=None):
  40. return None
  41. def set_device(self, device_index):
  42. return
  43. def current_device(self):
  44. return os.environ.get('LOCAL_RANK', 0)
  45. def current_device_name(self):
  46. return 'cpu'
  47. def device_count(self):
  48. device_count = int(os.environ.get('LOCAL_SIZE', 0))
  49. if device_count > 0:
  50. return device_count
  51. else:
  52. from deepspeed.utils.numa import get_numa_cores
  53. # Count NUMA node for number of cpu accelerators. On machine with HBM
  54. # In flat mode, HBM is in separate NUMA node with no cores on this node.
  55. # Ignore these NUMA nodes with no cores.
  56. numa_core_lists = get_numa_cores()
  57. numa_count = 0
  58. prev_core_list = []
  59. for core_list in numa_core_lists:
  60. if len(core_list) > 0 and core_list != prev_core_list:
  61. numa_count += 1
  62. prev_core_list = core_list
  63. return numa_count
  64. def synchronize(self, device_index=None):
  65. return
  66. # RNG APIs
  67. def random(self):
  68. return torch.random
  69. def set_rng_state(self, new_state, device_index=None):
  70. if device_index is None:
  71. return torch.set_rng_state(new_state)
  72. return torch.set_rng_state(new_state, device_index)
  73. def get_rng_state(self, device_index=None):
  74. return torch.get_rng_state()
  75. def manual_seed(self, seed):
  76. return torch.manual_seed(seed)
  77. def manual_seed_all(self, seed):
  78. return torch.manual_seed(seed)
  79. def initial_seed(self):
  80. return torch.initial_seed()
  81. def default_generator(self, device_index):
  82. return torch.default_generator
  83. # Streams/Events
  84. @property
  85. def Stream(self):
  86. return None
  87. def stream(self, stream):
  88. from deepspeed.runtime.utils import noop_context
  89. return noop_context()
  90. def current_stream(self, device_index=None):
  91. return None
  92. def default_stream(self, device_index=None):
  93. return None
  94. @property
  95. def Event(self):
  96. return None
  97. # Memory management
  98. def empty_cache(self):
  99. return
  100. def get_rss(self):
  101. import psutil
  102. mem = psutil.Process().memory_info().rss
  103. if mem > self.max_mem:
  104. self.max_mem = mem
  105. return mem
  106. def reset_rss(self):
  107. import psutil
  108. mem = psutil.Process().memory_info().rss
  109. self.max_mem = mem
  110. return mem
  111. def memory_allocated(self, device_index=None):
  112. return self.get_rss()
  113. def max_memory_allocated(self, device_index=None):
  114. self.get_rss()
  115. return self.max_mem
  116. def reset_max_memory_allocated(self, device_index=None):
  117. self.reset_rss()
  118. return
  119. def memory_cached(self, device_index=None):
  120. return self.get_rss()
  121. def max_memory_cached(self, device_index=None):
  122. self.get_rss()
  123. return self.max_mem
  124. def reset_max_memory_cached(self, device_index=None):
  125. self.reset_rss()
  126. return
  127. def memory_stats(self, device_index=None):
  128. mem = self.get_rss()
  129. mem_stat = {}
  130. mem_stat['allocated_bytes.all.current'] = mem
  131. mem_stat['allocated_bytes.all.peak'] = self.max_mem
  132. return mem_stat
  133. def reset_peak_memory_stats(self, device_index=None):
  134. self.reset_rss()
  135. return
  136. def memory_reserved(self, device_index=None):
  137. return self.get_rss()
  138. def max_memory_reserved(self, device_index=None):
  139. self.get_rss()
  140. return self.max_mem
  141. def total_memory(self, device_index=None):
  142. import psutil
  143. return psutil.virtual_memory().total
  144. def available_memory(self, device_index=None):
  145. import psutil
  146. return psutil.virtual_memory().available
  147. # Misc
  148. def amp(self):
  149. return torch.cpu.amp
  150. def is_available(self):
  151. return True
  152. def range_push(self, msg):
  153. # TODO itt is currently not supported yet
  154. # return torch.profiler.itt.range_push(msg)
  155. return
  156. def range_pop(self):
  157. # TODO itt is currently not supported yet
  158. # return torch.profiler.itt.range_pop()
  159. return
  160. def lazy_call(self, callback):
  161. return callback()
  162. def communication_backend_name(self):
  163. return self._communication_backend_name
  164. def is_triton_supported(self):
  165. return False
  166. # Data types
  167. def is_bf16_supported(self):
  168. return True
  169. def is_fp16_supported(self):
  170. return False
  171. def supported_dtypes(self):
  172. return [torch.float, torch.bfloat16]
  173. # Graph operations
  174. def create_graph(self):
  175. return None
  176. def capture_to_graph(self, graph, pool=None, stream=None):
  177. from deepspeed.runtime.utils import noop_context
  178. return noop_context()
  179. def replay_graph(self, graph):
  180. return
  181. # Tensor operations
  182. @property
  183. def BFloat16Tensor(self):
  184. return torch.BFloat16Tensor
  185. @property
  186. def ByteTensor(self):
  187. return torch.ByteTensor
  188. @property
  189. def DoubleTensor(self):
  190. return torch.DoubleTensor
  191. @property
  192. def FloatTensor(self):
  193. return torch.FloatTensor
  194. @property
  195. def HalfTensor(self):
  196. return torch.HalfTensor
  197. @property
  198. def IntTensor(self):
  199. return torch.IntTensor
  200. @property
  201. def LongTensor(self):
  202. return torch.LongTensor
  203. def pin_memory(self, tensor, align_bytes=1):
  204. return tensor
  205. def is_pinned(self, tensor):
  206. return tensor.is_pinned()
  207. def op_builder_dir(self):
  208. try:
  209. # is op_builder from deepspeed or a 3p version? this should only succeed if it's deepspeed
  210. # if successful this also means we're doing a local install and not JIT compile path
  211. from op_builder import __deepspeed__ # noqa: F401 # type: ignore
  212. return "op_builder.cpu"
  213. except ImportError:
  214. return "deepspeed.ops.op_builder.cpu"
  215. def on_accelerator(self, tensor):
  216. device_str = str(tensor.device)
  217. if device_str.startswith('cpu'):
  218. return True
  219. else:
  220. return False
  221. # create an instance of op builder and return, name specified by class_name
  222. def create_op_builder(self, op_name):
  223. builder_class = self.get_op_builder(op_name)
  224. if builder_class is not None:
  225. return builder_class()
  226. return None
  227. # return an op builder class, name specified by class_name
  228. def get_op_builder(self, class_name):
  229. try:
  230. # is op_builder from deepspeed or a 3p version? this should only succeed if it's deepspeed
  231. # if successful this also means we're doing a local install and not JIT compile path
  232. from op_builder import __deepspeed__ # noqa: F401 # type: ignore
  233. from op_builder.cpu import CCLCommBuilder, ShareMemCommBuilder, FusedAdamBuilder, CPUAdamBuilder, NotImplementedBuilder
  234. except ImportError:
  235. from deepspeed.ops.op_builder.cpu import CCLCommBuilder, ShareMemCommBuilder, FusedAdamBuilder, CPUAdamBuilder, NotImplementedBuilder
  236. if class_name == "CCLCommBuilder":
  237. return CCLCommBuilder
  238. elif class_name == "ShareMemCommBuilder":
  239. return ShareMemCommBuilder
  240. elif class_name == "FusedAdamBuilder":
  241. return FusedAdamBuilder
  242. elif class_name == "CPUAdamBuilder":
  243. return CPUAdamBuilder
  244. else:
  245. # return a NotImplementedBuilder to avoid get NoneType[Name] in unit tests
  246. return NotImplementedBuilder
  247. def build_extension(self):
  248. from torch.utils.cpp_extension import BuildExtension
  249. return BuildExtension
  250. def export_envs(self):
  251. return []
  252. # TODO: cpu's visible envs is confirmed, keep as CUDA_VISIBLE_DEVICES
  253. def visible_devices_envs(self):
  254. return ['CUDA_VISIBLE_DEVICES']
  255. def set_visible_devices_envs(self, current_env, local_accelerator_ids):
  256. for env in self.visible_devices_envs():
  257. current_env[env] = ",".join(map(str, local_accelerator_ids))
  258. def get_compile_backend(self):
  259. return self._compile_backend
  260. def set_compile_backend(self, backend):
  261. supported_backends = torch._dynamo.list_backends(exclude_tags=())
  262. if backend in supported_backends:
  263. self._compile_backend = backend
  264. else:
  265. raise ValueError(
  266. f"{backend} not supported by {self.device_name()}. Supported Backends are {supported_backends}")