forked from horovod/horovod
-
Notifications
You must be signed in to change notification settings - Fork 0
/
basics.py
197 lines (157 loc) · 7.03 KB
/
basics.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
# Copyright (C) 2019 Uber Technologies, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# =============================================================================
import atexit
import ctypes
import horovod.common.util as util
class HorovodBasics(object):
"""Wrapper class for the basic Horovod API."""
def __init__(self, pkg_path, *args):
full_path = util.get_extension_full_path(pkg_path, *args)
self.MPI_LIB_CTYPES = ctypes.CDLL(full_path, mode=ctypes.RTLD_GLOBAL)
def init(self, comm=None):
"""A function that initializes Horovod.
Args:
comm: List specifying ranks for the communicator, relative to the MPI_COMM_WORLD
communicator OR the MPI communicator to use. Given communicator will be duplicated.
If None, Horovod will use MPI_COMM_WORLD Communicator.
"""
if comm is None:
comm = []
atexit.register(self.shutdown)
if not isinstance(comm, list):
mpi_enabled = self.MPI_LIB_CTYPES.horovod_mpi_enabled()
if not bool(mpi_enabled):
raise ValueError(
'Horovod MPI is not enabled; Please make sure it\'s installed and enabled.')
from mpi4py import MPI
if MPI._sizeof(MPI.Comm) == ctypes.sizeof(ctypes.c_int):
MPI_Comm = ctypes.c_int
else:
MPI_Comm = ctypes.c_void_p
self.MPI_LIB_CTYPES.horovod_init_comm.argtypes = [MPI_Comm]
comm_obj = MPI_Comm.from_address(MPI._addressof(comm))
self.MPI_LIB_CTYPES.horovod_init_comm(comm_obj)
else:
comm_size = len(comm)
self.MPI_LIB_CTYPES.horovod_init(
(ctypes.c_int * comm_size)(*comm), ctypes.c_int(comm_size))
def shutdown(self):
"""A function that shuts Horovod down."""
self.MPI_LIB_CTYPES.horovod_shutdown()
def size(self):
"""A function that returns the number of Horovod processes.
Returns:
An integer scalar containing the number of Horovod processes.
"""
size = self.MPI_LIB_CTYPES.horovod_size()
if size == -1:
raise ValueError(
'Horovod has not been initialized; use hvd.init().')
return size
def local_size(self):
"""A function that returns the number of Horovod processes within the
node the current process is running on.
Returns:
An integer scalar containing the number of local Horovod processes.
"""
local_size = self.MPI_LIB_CTYPES.horovod_local_size()
if local_size == -1:
raise ValueError(
'Horovod has not been initialized; use hvd.init().')
return local_size
def rank(self):
"""A function that returns the Horovod rank of the calling process.
Returns:
An integer scalar with the Horovod rank of the calling process.
"""
rank = self.MPI_LIB_CTYPES.horovod_rank()
if rank == -1:
raise ValueError(
'Horovod has not been initialized; use hvd.init().')
return rank
def local_rank(self):
"""A function that returns the local Horovod rank of the calling process, within the
node that it is running on. For example, if there are seven processes running
on a node, their local ranks will be zero through six, inclusive.
Returns:
An integer scalar with the local Horovod rank of the calling process.
"""
local_rank = self.MPI_LIB_CTYPES.horovod_local_rank()
if local_rank == -1:
raise ValueError(
'Horovod has not been initialized; use hvd.init().')
return local_rank
def mpi_threads_supported(self):
"""A function that returns a flag indicating whether MPI multi-threading is supported.
If MPI multi-threading is supported, users may mix and match Horovod usage with other
MPI libraries, such as `mpi4py`.
Returns:
A boolean value indicating whether MPI multi-threading is supported.
"""
mpi_enabled = self.MPI_LIB_CTYPES.horovod_mpi_enabled()
if not bool(mpi_enabled):
raise ValueError(
'Horovod MPI is not enabled; Please make sure it\'s installed and enabled.')
mpi_threads_supported = self.MPI_LIB_CTYPES.horovod_mpi_threads_supported()
if mpi_threads_supported == -1:
raise ValueError(
'Horovod has not been initialized; use hvd.init().')
return bool(mpi_threads_supported)
def mpi_enabled(self):
"""Returns True if MPI is mode is currently enabled at runtime.
If MPI is enabled, users can use it for controller or data transfer operations.
Returns:
A boolean value indicating whether MPI is enabled.
"""
mpi_enabled = self.MPI_LIB_CTYPES.horovod_mpi_enabled()
return bool(mpi_enabled)
def mpi_built(self):
"""Returns True if Horovod was compiled with MPI support.
Returns:
A boolean value indicating whether MPI support was compiled.
"""
return bool(self.MPI_LIB_CTYPES.horovod_mpi_built())
def gloo_enabled(self):
"""Returns True if Gloo is mode is currently enabled at runtime.
If Gloo is enabled, users can use it for controller or data transfer operations.
Returns:
A boolean value indicating whether Gloo is enabled.
"""
gloo_enabled = self.MPI_LIB_CTYPES.horovod_gloo_enabled()
return bool(gloo_enabled)
def gloo_built(self):
"""Returns True if Horovod was compiled with Gloo support.
Returns:
A boolean value indicating whether Gloo support was compiled.
"""
return bool(self.MPI_LIB_CTYPES.horovod_gloo_built())
def nccl_built(self):
"""Returns True if Horovod was compiled with NCCL support.
Returns:
A boolean value indicating whether NCCL support was compiled.
"""
return bool(self.MPI_LIB_CTYPES.horovod_nccl_built())
def ddl_built(self):
"""Returns True if Horovod was compiled with DDL support.
Returns:
A boolean value indicating whether DDL support was compiled.
"""
return bool(self.MPI_LIB_CTYPES.horovod_ddl_built())
def mlsl_built(self):
"""Returns True if Horovod was compiled with MLSL support.
Returns:
A boolean value indicating whether MLSL support was compiled.
"""
return bool(self.MPI_LIB_CTYPES.horovod_mlsl_built())