launcher.py 16.4 KB
Newer Older
Deshui Yu's avatar
Deshui Yu committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Copyright (c) Microsoft Corporation
# All rights reserved.
#
# MIT License
#
# Permission is hereby granted, free of charge,
# to any person obtaining a copy of this software and associated
# documentation files (the "Software"), to deal in the Software without restriction,
# including without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and
# to permit persons to whom the Software is furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
# BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


import json
import os
import shutil
25
import string
26
from subprocess import Popen, PIPE, call
Deshui Yu's avatar
Deshui Yu committed
27
import tempfile
28
from nni_annotation import *
Deshui Yu's avatar
Deshui Yu committed
29
from .launcher_utils import validate_all_content
30
from .rest_utils import rest_put, rest_post, check_rest_server, check_rest_server_quick, check_response
Deshui Yu's avatar
Deshui Yu committed
31
from .url_utils import cluster_metadata_url, experiment_url
32
33
from .config_utils import Config, Experiments
from .common_utils import get_yml_content, get_json_content, print_error, print_normal, print_warning, detect_process, detect_port
34
from .constants import *
35
36
from .webui_utils import *
import time
37
38
import random
import string
Deshui Yu's avatar
Deshui Yu committed
39

40
def start_rest_server(port, platform, mode, config_file_name, experiment_id=None):
Deshui Yu's avatar
Deshui Yu committed
41
    '''Run nni manager process'''
42
    nni_config = Config(config_file_name)
43
44
45
    if detect_port(port):
        print_error('Port %s is used by another process, please reset the port!' % port)
        exit(1)
Deshui Yu's avatar
Deshui Yu committed
46
47

    print_normal('Starting restful server...')
48
    manager = os.environ.get('NNI_MANAGER', 'nnimanager')
Deshui Yu's avatar
Deshui Yu committed
49
50
51
    cmds = [manager, '--port', str(port), '--mode', platform, '--start_mode', mode]
    if mode == 'resume':
        cmds += ['--experiment_id', experiment_id]
52
53
    stdout_full_path = os.path.join(NNICTL_HOME_DIR, config_file_name, 'stdout')
    stderr_full_path = os.path.join(NNICTL_HOME_DIR, config_file_name, 'stderr')
goooxu's avatar
goooxu committed
54
55
    stdout_file = open(stdout_full_path, 'a+')
    stderr_file = open(stderr_full_path, 'a+')
56
57
58
59
60
    time_now = time.strftime('%Y-%m-%d %H:%M:%S',time.localtime(time.time()))
    #add time information in the header of log files
    log_header = LOG_HEADER % str(time_now)
    stdout_file.write(log_header)
    stderr_file.write(log_header)
Deshui Yu's avatar
Deshui Yu committed
61
    process = Popen(cmds, stdout=stdout_file, stderr=stderr_file)
62
    return process, str(time_now)
Deshui Yu's avatar
Deshui Yu committed
63

64
def set_trial_config(experiment_config, port, config_file_name):
65
    '''set trial configuration'''
Deshui Yu's avatar
Deshui Yu committed
66
    request_data = dict()
67
    value_dict = dict()
68
69
70
    value_dict['command'] = experiment_config['trial']['command']
    value_dict['codeDir'] = experiment_config['trial']['codeDir']
    value_dict['gpuNum'] = experiment_config['trial']['gpuNum']
71
72
73
74
75
76
77
78
79
80
    if experiment_config['trial'].get('cpuNum'):
        value_dict['cpuNum'] = experiment_config['trial']['cpuNum']
    if experiment_config['trial'].get('memoryMB'):
        value_dict['memoryMB'] = experiment_config['trial']['memoryMB']
    if experiment_config['trial'].get('image'):
        value_dict['image'] = experiment_config['trial']['image']
    if experiment_config['trial'].get('dataDir'):
        value_dict['dataDir'] = experiment_config['trial']['dataDir']
    if experiment_config['trial'].get('outputDir'):
        value_dict['outputDir'] = experiment_config['trial']['outputDir']
81
    request_data['trial_config'] = value_dict
Deshui Yu's avatar
Deshui Yu committed
82
    response = rest_put(cluster_metadata_url(port), json.dumps(request_data), 20)
83
84
85
    if check_response(response):
        return True
    else:
86
        print('Error message is {}'.format(response.text))
87
        stderr_full_path = os.path.join(NNICTL_HOME_DIR, config_file_name, 'stderr')
goooxu's avatar
goooxu committed
88
        with open(stderr_full_path, 'a+') as fout:
89
90
            fout.write(json.dumps(json.loads(response.text), indent=4, sort_keys=True, separators=(',', ':')))
        return False
91

92
def set_local_config(experiment_config, port, config_file_name):
93
    '''set local configuration'''
94
    return set_trial_config(experiment_config, port, config_file_name)
Deshui Yu's avatar
Deshui Yu committed
95

96
def set_remote_config(experiment_config, port, config_file_name):
Deshui Yu's avatar
Deshui Yu committed
97
98
99
100
101
    '''Call setClusterMetadata to pass trial'''
    #set machine_list
    request_data = dict()
    request_data['machine_list'] = experiment_config['machineList']
    response = rest_put(cluster_metadata_url(port), json.dumps(request_data), 20)
102
    err_message = ''
103
    if not response or not check_response(response):
104
105
        if response is not None:
            err_message = response.text
106
            stderr_full_path = os.path.join(NNICTL_HOME_DIR, config_file_name, 'stderr')
goooxu's avatar
goooxu committed
107
            with open(stderr_full_path, 'a+') as fout:
108
                fout.write(json.dumps(json.loads(err_message), indent=4, sort_keys=True, separators=(',', ':')))
109
        return False, err_message
Deshui Yu's avatar
Deshui Yu committed
110
111

    #set trial_config
112
    return set_trial_config(experiment_config, port, config_file_name), err_message
Deshui Yu's avatar
Deshui Yu committed
113

114
def set_pai_config(experiment_config, port, config_file_name):
115
116
117
118
    '''set pai configuration''' 
    pai_config_data = dict()
    pai_config_data['pai_config'] = experiment_config['paiConfig']
    response = rest_put(cluster_metadata_url(port), json.dumps(pai_config_data), 20)
119
    err_message = None
120
121
122
    if not response or not response.status_code == 200:
        if response is not None:
            err_message = response.text
123
            stderr_full_path = os.path.join(NNICTL_HOME_DIR, config_file_name, 'stderr')
124
            with open(stderr_full_path, 'a+') as fout:
chicm-ms's avatar
chicm-ms committed
125
                fout.write(json.dumps(json.loads(err_message), indent=4, sort_keys=True, separators=(',', ':')))
126
127
128
        return False, err_message

    #set trial_config
129
    return set_trial_config(experiment_config, port, config_file_name), err_message
130

131
def set_experiment(experiment_config, mode, port, config_file_name):
Deshui Yu's avatar
Deshui Yu committed
132
133
134
135
136
137
138
    '''Call startExperiment (rest POST /experiment) with yaml file content'''
    request_data = dict()
    request_data['authorName'] = experiment_config['authorName']
    request_data['experimentName'] = experiment_config['experimentName']
    request_data['trialConcurrency'] = experiment_config['trialConcurrency']
    request_data['maxExecDuration'] = experiment_config['maxExecDuration']
    request_data['maxTrialNum'] = experiment_config['maxTrialNum']
139
    request_data['searchSpace'] = experiment_config.get('searchSpace')
140
141
142
143
    request_data['trainingServicePlatform'] = experiment_config.get('trainingServicePlatform')

    if experiment_config.get('description'):
        request_data['description'] = experiment_config['description']
chicm-ms's avatar
chicm-ms committed
144
145
    if experiment_config.get('multiPhase'):
        request_data['multiPhase'] = experiment_config.get('multiPhase')
Deshui Yu's avatar
Deshui Yu committed
146
147
148
149
150
151
152
    request_data['tuner'] = experiment_config['tuner']
    if 'assessor' in experiment_config:
        request_data['assessor'] = experiment_config['assessor']

    request_data['clusterMetaData'] = []
    if experiment_config['trainingServicePlatform'] == 'local':
        request_data['clusterMetaData'].append(
153
            {'key':'codeDir', 'value':experiment_config['trial']['codeDir']})
Deshui Yu's avatar
Deshui Yu committed
154
        request_data['clusterMetaData'].append(
155
            {'key': 'command', 'value': experiment_config['trial']['command']})
156
    elif experiment_config['trainingServicePlatform'] == 'remote':
Deshui Yu's avatar
Deshui Yu committed
157
158
159
        request_data['clusterMetaData'].append(
            {'key': 'machine_list', 'value': experiment_config['machineList']})
        value_dict = dict()
160
161
162
        value_dict['command'] = experiment_config['trial']['command']
        value_dict['codeDir'] = experiment_config['trial']['codeDir']
        value_dict['gpuNum'] = experiment_config['trial']['gpuNum']
Deshui Yu's avatar
Deshui Yu committed
163
164
        request_data['clusterMetaData'].append(
            {'key': 'trial_config', 'value': value_dict})
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
    elif experiment_config['trainingServicePlatform'] == 'pai':
        request_data['clusterMetaData'].append(
            {'key': 'pai_config', 'value': experiment_config['paiConfig']})
        value_dict = dict()
        value_dict['command'] = experiment_config['trial']['command']
        value_dict['codeDir'] = experiment_config['trial']['codeDir']
        value_dict['gpuNum'] = experiment_config['trial']['gpuNum']
        if experiment_config['trial'].get('cpuNum'):
            value_dict['cpuNum'] = experiment_config['trial']['cpuNum']
        if experiment_config['trial'].get('memoryMB'):
            value_dict['memoryMB'] = experiment_config['trial']['memoryMB']
        if experiment_config['trial'].get('image'):
            value_dict['image'] = experiment_config['trial']['image']
        if experiment_config['trial'].get('dataDir'):
            value_dict['dataDir'] = experiment_config['trial']['dataDir']
        if experiment_config['trial'].get('outputDir'):
            value_dict['outputDir'] = experiment_config['trial']['outputDir']
        request_data['clusterMetaData'].append(
            {'key': 'trial_config', 'value': value_dict})
Deshui Yu's avatar
Deshui Yu committed
184
185

    response = rest_post(experiment_url(port), json.dumps(request_data), 20)
186
187
188
    if check_response(response):
        return response
    else:
189
        stderr_full_path = os.path.join(NNICTL_HOME_DIR, config_file_name, 'stderr')
goooxu's avatar
goooxu committed
190
        with open(stderr_full_path, 'a+') as fout:
191
            fout.write(json.dumps(json.loads(response.text), indent=4, sort_keys=True, separators=(',', ':')))
192
        print_error('Setting experiment error, error message is {}'.format(response.text))
193
        return None
Deshui Yu's avatar
Deshui Yu committed
194

195
def launch_experiment(args, experiment_config, mode, config_file_name, experiment_id=None):
Deshui Yu's avatar
Deshui Yu committed
196
    '''follow steps to start rest server and start experiment'''
197
    nni_config = Config(config_file_name)
Deshui Yu's avatar
Deshui Yu committed
198
    # start rest server
199
    rest_process, start_time = start_rest_server(args.port, experiment_config['trainingServicePlatform'], mode, config_file_name, experiment_id)
Deshui Yu's avatar
Deshui Yu committed
200
201
202
    nni_config.set_config('restServerPid', rest_process.pid)
    # Deal with annotation
    if experiment_config.get('useAnnotation'):
liuzhe-lz's avatar
liuzhe-lz committed
203
        path = os.path.join(tempfile.gettempdir(), 'nni', 'annotation')
QuanluZhang's avatar
QuanluZhang committed
204
205
        if not os.path.isdir(path):
            os.makedirs(path)
liuzhe-lz's avatar
liuzhe-lz committed
206
207
208
209
        path = tempfile.mkdtemp(dir=path)
        code_dir = expand_annotations(experiment_config['trial']['codeDir'], path)
        experiment_config['trial']['codeDir'] = code_dir
        search_space = generate_search_space(code_dir)
210
        experiment_config['searchSpace'] = json.dumps(search_space)
Deshui Yu's avatar
Deshui Yu committed
211
        assert search_space, ERROR_INFO % 'Generated search space is empty'
212
213
214
    elif experiment_config.get('searchSpacePath'):
            search_space = get_json_content(experiment_config.get('searchSpacePath'))
            experiment_config['searchSpace'] = json.dumps(search_space)
Deshui Yu's avatar
Deshui Yu committed
215
    else:
216
        experiment_config['searchSpace'] = json.dumps('')
Deshui Yu's avatar
Deshui Yu committed
217
218

    # check rest server
goooxu's avatar
goooxu committed
219
    running, _ = check_rest_server(args.port)
220
    if running:
221
        print_normal('Successfully started Restful server!')
Deshui Yu's avatar
Deshui Yu committed
222
223
224
    else:
        print_error('Restful server start failed!')
        try:
225
226
            cmds = ['pkill', '-P', str(rest_process.pid)]
            call(cmds)
Deshui Yu's avatar
Deshui Yu committed
227
228
        except Exception:
            raise Exception(ERROR_INFO % 'Rest server stopped!')
goooxu's avatar
goooxu committed
229
        exit(1)
Deshui Yu's avatar
Deshui Yu committed
230
231
232
233

    # set remote config
    if experiment_config['trainingServicePlatform'] == 'remote':
        print_normal('Setting remote config...')
234
        config_result, err_msg = set_remote_config(experiment_config, args.port, config_file_name)
235
        if config_result:
236
            print_normal('Successfully set remote config!')
Deshui Yu's avatar
Deshui Yu committed
237
        else:
238
            print_error('Failed! Error is: {}'.format(err_msg))
Deshui Yu's avatar
Deshui Yu committed
239
            try:
240
241
                cmds = ['pkill', '-P', str(rest_process.pid)]
                call(cmds)
Deshui Yu's avatar
Deshui Yu committed
242
243
            except Exception:
                raise Exception(ERROR_INFO % 'Rest server stopped!')
goooxu's avatar
goooxu committed
244
            exit(1)
Deshui Yu's avatar
Deshui Yu committed
245
246
247
248

    # set local config
    if experiment_config['trainingServicePlatform'] == 'local':
        print_normal('Setting local config...')
249
        if set_local_config(experiment_config, args.port, config_file_name):
250
            print_normal('Successfully set local config!')
Deshui Yu's avatar
Deshui Yu committed
251
252
253
        else:
            print_error('Failed!')
            try:
254
255
                cmds = ['pkill', '-P', str(rest_process.pid)]
                call(cmds)
Deshui Yu's avatar
Deshui Yu committed
256
257
            except Exception:
                raise Exception(ERROR_INFO % 'Rest server stopped!')
goooxu's avatar
goooxu committed
258
            exit(1)
259
260
261
262
    
    #set pai config
    if experiment_config['trainingServicePlatform'] == 'pai':
        print_normal('Setting pai config...')
263
        config_result, err_msg = set_pai_config(experiment_config, args.port, config_file_name)
264
        if config_result:
265
            print_normal('Successfully set pai config!')
266
        else:
267
268
            if err_msg:
                print_error('Failed! Error is: {}'.format(err_msg))
269
270
271
272
            try:
                cmds = ['pkill', '-P', str(rest_process.pid)]
                call(cmds)
            except Exception:
273
                raise Exception(ERROR_INFO % 'Restful server stopped!')
goooxu's avatar
goooxu committed
274
            exit(1)
Deshui Yu's avatar
Deshui Yu committed
275
276
277

    # start a new experiment
    print_normal('Starting experiment...')
278
    response = set_experiment(experiment_config, mode, args.port, config_file_name)
Deshui Yu's avatar
Deshui Yu committed
279
280
281
282
283
284
285
    if response:
        if experiment_id is None:
            experiment_id = json.loads(response.text).get('experiment_id')
        nni_config.set_config('experimentId', experiment_id)
    else:
        print_error('Failed!')
        try:
286
287
            cmds = ['pkill', '-P', str(rest_process.pid)]
            call(cmds)
Deshui Yu's avatar
Deshui Yu committed
288
        except Exception:
289
            raise Exception(ERROR_INFO % 'Restful server stopped!')
goooxu's avatar
goooxu committed
290
        exit(1)
291
    web_ui_url_list = get_web_ui_urls(args.port, config_file_name)
292
293
294
    
    #save experiment information
    experiment_config = Experiments()
295
    experiment_config.add_experiment(experiment_id, args.port, start_time, config_file_name)
296
297

    print_normal(EXPERIMENT_SUCCESS_INFO % (experiment_id, '   '.join(web_ui_url_list)))
Deshui Yu's avatar
Deshui Yu committed
298

299
300
301
302
303
304
305
306
307
def cmp_time(time1, time2):
    '''compare the time'''
    try:
        time1 = time.strptime(time1,'%Y-%m-%d %H:%M:%S')
        time2 = time.strptime(time2,'%Y-%m-%d %H:%M:%S')
        return int(time1) - int(time2)
    except:
        return 0

Deshui Yu's avatar
Deshui Yu committed
308
309
def resume_experiment(args):
    '''resume an experiment'''
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
    experiment_config = Experiments()
    experiment_dict = experiment_config.get_all_experiments()
    experiment_id = None
    experiment_endTime = None
    #find the latest stopped experiment
    if not args.id:
        for key in experiment_dict.keys():
            if experiment_dict[key]['status'] == 'stopped':
                if experiment_id is None:
                    experiment_id = key
                    experiment_endTime = experiment_dict[key]['endTime']
                else:
                    if cmp_time(experiment_dict[key]['endTime'], experiment_endTime) > 0:
                        experiment_id = key
                        experiment_endTime = experiment_dict[key]['endTime']
        if experiment_id is None:
            print_error('There is no experiment stopped!')
            exit(1)
    else:
        if experiment_dict.get(args.id) is None:
            print_error('Id %s not exist!' % args.id)
            exit(1)
        if experiment_dict[args.id]['status'] == 'running':
            print_error('Experiment %s is running!' % args.id)
            exit(1)
        experiment_id = args.id
    print_normal('Resuming experiment %s...' % experiment_id)
    nni_config = Config(experiment_dict[experiment_id]['fileName'])
Deshui Yu's avatar
Deshui Yu committed
338
339
    experiment_config = nni_config.get_config('experimentConfig')
    experiment_id = nni_config.get_config('experimentId')
340
    launch_experiment(args, experiment_config, 'resume', experiment_dict[experiment_id]['fileName'], experiment_id)
Deshui Yu's avatar
Deshui Yu committed
341
342
343

def create_experiment(args):
    '''start a new experiment'''
344
345
    config_file_name = ''.join(random.sample(string.ascii_letters + string.digits, 8))
    nni_config = Config(config_file_name)
346
    config_path = os.path.abspath(args.config)
goooxu's avatar
goooxu committed
347
348
349
    if not os.path.exists(config_path):
        print_error('Please set correct config path!')
        exit(1)
350
351
    experiment_config = get_yml_content(config_path)
    validate_all_content(experiment_config, config_path)
Deshui Yu's avatar
Deshui Yu committed
352
353

    nni_config.set_config('experimentConfig', experiment_config)
354
    launch_experiment(args, experiment_config, 'new', config_file_name)
goooxu's avatar
goooxu committed
355
    nni_config.set_config('restServerPort', args.port)