launcher.py 27.6 KB
Newer Older
liuzhe-lz's avatar
liuzhe-lz committed
1
2
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT license.
Deshui Yu's avatar
Deshui Yu committed
3
4
5

import json
import os
6
from pathlib import Path
7
import sys
8
import string
chicm-ms's avatar
chicm-ms committed
9
10
import random
import time
Deshui Yu's avatar
Deshui Yu committed
11
import tempfile
12
import re
13
from subprocess import Popen, check_call, CalledProcessError, PIPE, STDOUT
liuzhe-lz's avatar
liuzhe-lz committed
14
from nni.experiment.config import ExperimentConfig, convert
15
16
from nni.tools.annotation import expand_annotations, generate_search_space
from nni.tools.package_utils import get_builtin_module_class_name
17
import nni_node  # pylint: disable=import-error
Deshui Yu's avatar
Deshui Yu committed
18
from .launcher_utils import validate_all_content
chicm-ms's avatar
chicm-ms committed
19
from .rest_utils import rest_put, rest_post, check_rest_server, check_response
20
from .url_utils import cluster_metadata_url, experiment_url, get_local_urls, setPrefixUrl, formatURLPath
21
from .config_utils import Config, Experiments
22
from .common_utils import get_yml_content, get_json_content, print_error, print_normal, print_warning, \
chicm-ms's avatar
chicm-ms committed
23
24
                          detect_port, get_user

J-shang's avatar
J-shang committed
25
from .constants import NNI_HOME_DIR, ERROR_INFO, REST_TIME_OUT, EXPERIMENT_SUCCESS_INFO, LOG_HEADER
26
from .command_utils import check_output_command, kill_command
27
from .nnictl_utils import update_experiment
Gems Guo's avatar
Gems Guo committed
28

29
30
k8s_training_services = ['kubeflow', 'frameworkcontroller', 'adl']

31
def get_log_path(experiment_id):
32
    '''generate stdout and stderr log path'''
J-shang's avatar
J-shang committed
33
34
35
    os.makedirs(os.path.join(NNI_HOME_DIR, experiment_id, 'log'), exist_ok=True)
    stdout_full_path = os.path.join(NNI_HOME_DIR, experiment_id, 'log', 'nnictl_stdout.log')
    stderr_full_path = os.path.join(NNI_HOME_DIR, experiment_id, 'log', 'nnictl_stderr.log')
36
37
38
39
40
41
    return stdout_full_path, stderr_full_path

def print_log_content(config_file_name):
    '''print log information'''
    stdout_full_path, stderr_full_path = get_log_path(config_file_name)
    print_normal(' Stdout:')
42
    print(check_output_command(stdout_full_path))
43
44
    print('\n\n')
    print_normal(' Stderr:')
45
    print(check_output_command(stderr_full_path))
46

47
def start_rest_server(port, platform, mode, experiment_id, foreground=False, log_dir=None, log_level=None, url_prefix=None):
Deshui Yu's avatar
Deshui Yu committed
48
    '''Run nni manager process'''
SparkSnail's avatar
SparkSnail committed
49
    if detect_port(port):
50
        print_error('Port %s is used by another process, please reset the port!\n' \
SparkSnail's avatar
SparkSnail committed
51
        'You could use \'nnictl create --help\' to get help information' % port)
52
        exit(1)
53

54
55
    if (platform not in ['local', 'aml']) and detect_port(int(port) + 1):
        print_error('%s mode need an additional adjacent port %d, and the port %d is used by another process!\n' \
56
        'You could set another port to start experiment!\n' \
57
        'You could use \'nnictl create --help\' to get help information' % (platform, (int(port) + 1), (int(port) + 1)))
58
        exit(1)
Deshui Yu's avatar
Deshui Yu committed
59
60

    print_normal('Starting restful server...')
61

62
    entry_dir = nni_node.__path__[0]
chicm-ms's avatar
chicm-ms committed
63
64
65
    if (not entry_dir) or (not os.path.exists(entry_dir)):
        print_error('Fail to find nni under python library')
        exit(1)
Zejun Lin's avatar
Zejun Lin committed
66
    entry_file = os.path.join(entry_dir, 'main.js')
chicm-ms's avatar
chicm-ms committed
67

demianzhang's avatar
demianzhang committed
68
    if sys.platform == 'win32':
69
70
        node_command = os.path.join(entry_dir, 'node.exe')
    else:
liuzhe-lz's avatar
liuzhe-lz committed
71
        node_command = os.path.join(entry_dir, 'node')
72
73
    cmds = [node_command, '--max-old-space-size=4096', entry_file, '--port', str(port), '--mode', platform, \
            '--experiment_id', experiment_id]
SparkSnail's avatar
SparkSnail committed
74
75
76
77
78
    if mode == 'view':
        cmds += ['--start_mode', 'resume']
        cmds += ['--readonly', 'true']
    else:
        cmds += ['--start_mode', mode]
79
80
81
82
    if log_dir is not None:
        cmds += ['--log_dir', log_dir]
    if log_level is not None:
        cmds += ['--log_level', log_level]
SparkSnail's avatar
SparkSnail committed
83
    if foreground:
84
        cmds += ['--foreground', 'true']
85
86
87
88
89
    if url_prefix:
        _validate_prefix_path(url_prefix)
        setPrefixUrl(url_prefix)
        cmds += ['--url_prefix', url_prefix]

90
    stdout_full_path, stderr_full_path = get_log_path(experiment_id)
91
    with open(stdout_full_path, 'a+') as stdout_file, open(stderr_full_path, 'a+') as stderr_file:
92
93
        start_time = time.time()
        time_now = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(start_time))
94
95
96
97
98
99
        #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)
        if sys.platform == 'win32':
            from subprocess import CREATE_NEW_PROCESS_GROUP
SparkSnail's avatar
SparkSnail committed
100
            if foreground:
101
102
103
                process = Popen(cmds, cwd=entry_dir, stdout=PIPE, stderr=STDOUT, creationflags=CREATE_NEW_PROCESS_GROUP)
            else:
                process = Popen(cmds, cwd=entry_dir, stdout=stdout_file, stderr=stderr_file, creationflags=CREATE_NEW_PROCESS_GROUP)
104
        else:
SparkSnail's avatar
SparkSnail committed
105
            if foreground:
106
107
108
                process = Popen(cmds, cwd=entry_dir, stdout=PIPE, stderr=PIPE)
            else:
                process = Popen(cmds, cwd=entry_dir, stdout=stdout_file, stderr=stderr_file)
109
    return process, int(start_time * 1000)
Deshui Yu's avatar
Deshui Yu committed
110

111
def set_trial_config(experiment_config, port, config_file_name):
112
    '''set trial configuration'''
Deshui Yu's avatar
Deshui Yu committed
113
    request_data = dict()
114
    request_data['trial_config'] = experiment_config['trial']
115
    response = rest_put(cluster_metadata_url(port), json.dumps(request_data), REST_TIME_OUT)
116
117
118
    if check_response(response):
        return True
    else:
119
        print('Error message is {}'.format(response.text))
120
        _, stderr_full_path = get_log_path(config_file_name)
SparkSnail's avatar
SparkSnail committed
121
122
123
        if response:
            with open(stderr_full_path, 'a+') as fout:
                fout.write(json.dumps(json.loads(response.text), indent=4, sort_keys=True, separators=(',', ':')))
124
        return False
125

126
127
def set_adl_config(experiment_config, port, config_file_name):
    '''set adl configuration'''
128
129
130
131
132
133
134
135
136
137
138
139
    adl_config_data = dict()
    # hack for supporting v2 config, need refactor
    adl_config_data['adl_config'] = {}
    response = rest_put(cluster_metadata_url(port), json.dumps(adl_config_data), REST_TIME_OUT)
    err_message = None
    if not response or not response.status_code == 200:
        if response is not None:
            err_message = response.text
            _, stderr_full_path = get_log_path(config_file_name)
            with open(stderr_full_path, 'a+') as fout:
                fout.write(json.dumps(json.loads(err_message), indent=4, sort_keys=True, separators=(',', ':')))
        return False, err_message
140
    set_V1_common_config(experiment_config, port, config_file_name)
141
142
143
144
145
146
    result, message = setNNIManagerIp(experiment_config, port, config_file_name)
    if not result:
        return result, message
    #set trial_config
    return set_trial_config(experiment_config, port, config_file_name), None

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
def validate_response(response, config_file_name):
    err_message = None
    if not response or not response.status_code == 200:
        if response is not None:
            err_message = response.text
            _, stderr_full_path = get_log_path(config_file_name)
            with open(stderr_full_path, 'a+') as fout:
                fout.write(json.dumps(json.loads(err_message), indent=4, sort_keys=True, separators=(',', ':')))
        print_error('Error:' + err_message)
        exit(1)

# hack to fix v1 version_check and log_collection bug, need refactor
def set_V1_common_config(experiment_config, port, config_file_name):
    version_check = True
    #debug mode should disable version check
    if experiment_config.get('debug') is not None:
        version_check = not experiment_config.get('debug')
    #validate version check
    if experiment_config.get('versionCheck') is not None:
        version_check = experiment_config.get('versionCheck')
    response = rest_put(cluster_metadata_url(port), json.dumps({'version_check': version_check}), REST_TIME_OUT)
    validate_response(response, config_file_name)
    if experiment_config.get('logCollection'):
        response = rest_put(cluster_metadata_url(port), json.dumps({'log_collection': experiment_config.get('logCollection')}), REST_TIME_OUT)
        validate_response(response, config_file_name)

173
174
175
176
177
def setNNIManagerIp(experiment_config, port, config_file_name):
    '''set nniManagerIp'''
    if experiment_config.get('nniManagerIp') is None:
        return True, None
    ip_config_dict = dict()
chicm-ms's avatar
chicm-ms committed
178
    ip_config_dict['nni_manager_ip'] = {'nniManagerIp': experiment_config['nniManagerIp']}
179
    response = rest_put(cluster_metadata_url(port), json.dumps(ip_config_dict), REST_TIME_OUT)
180
181
182
183
184
185
186
187
188
189
    err_message = None
    if not response or not response.status_code == 200:
        if response is not None:
            err_message = response.text
            _, stderr_full_path = get_log_path(config_file_name)
            with open(stderr_full_path, 'a+') as fout:
                fout.write(json.dumps(json.loads(err_message), indent=4, sort_keys=True, separators=(',', ':')))
        return False, err_message
    return True, None

190
def set_kubeflow_config(experiment_config, port, config_file_name):
191
    '''set kubeflow configuration'''
192
193
    kubeflow_config_data = dict()
    kubeflow_config_data['kubeflow_config'] = experiment_config['kubeflowConfig']
194
    response = rest_put(cluster_metadata_url(port), json.dumps(kubeflow_config_data), REST_TIME_OUT)
195
196
197
198
199
200
201
202
    err_message = None
    if not response or not response.status_code == 200:
        if response is not None:
            err_message = response.text
            _, stderr_full_path = get_log_path(config_file_name)
            with open(stderr_full_path, 'a+') as fout:
                fout.write(json.dumps(json.loads(err_message), indent=4, sort_keys=True, separators=(',', ':')))
        return False, err_message
203
    set_V1_common_config(experiment_config, port, config_file_name)
204
205
206
    result, message = setNNIManagerIp(experiment_config, port, config_file_name)
    if not result:
        return result, message
207
208
209
    #set trial_config
    return set_trial_config(experiment_config, port, config_file_name), err_message

210
def set_frameworkcontroller_config(experiment_config, port, config_file_name):
211
    '''set kubeflow configuration'''
212
213
    frameworkcontroller_config_data = dict()
    frameworkcontroller_config_data['frameworkcontroller_config'] = experiment_config['frameworkcontrollerConfig']
214
    response = rest_put(cluster_metadata_url(port), json.dumps(frameworkcontroller_config_data), REST_TIME_OUT)
215
216
217
218
219
220
221
222
    err_message = None
    if not response or not response.status_code == 200:
        if response is not None:
            err_message = response.text
            _, stderr_full_path = get_log_path(config_file_name)
            with open(stderr_full_path, 'a+') as fout:
                fout.write(json.dumps(json.loads(err_message), indent=4, sort_keys=True, separators=(',', ':')))
        return False, err_message
223
    set_V1_common_config(experiment_config, port, config_file_name)
224
225
226
227
228
229
    result, message = setNNIManagerIp(experiment_config, port, config_file_name)
    if not result:
        return result, message
    #set trial_config
    return set_trial_config(experiment_config, port, config_file_name), err_message

230
231
232
233
234
235
236
237
238
239
240
241
242
def set_shared_storage(experiment_config, port, config_file_name):
    if 'sharedStorage' in experiment_config:
        response = rest_put(cluster_metadata_url(port), json.dumps({'shared_storage_config': experiment_config['sharedStorage']}), REST_TIME_OUT)
        err_message = None
        if not response or not response.status_code == 200:
            if response is not None:
                err_message = response.text
                _, stderr_full_path = get_log_path(config_file_name)
                with open(stderr_full_path, 'a+') as fout:
                    fout.write(json.dumps(json.loads(err_message), indent=4, sort_keys=True, separators=(',', ':')))
            return False, err_message
    return True, None

243
def set_experiment_v1(experiment_config, mode, port, config_file_name):
Deshui Yu's avatar
Deshui Yu committed
244
245
246
247
248
249
    '''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']
liuzhe-lz's avatar
liuzhe-lz committed
250
    request_data['maxExperimentDuration'] = str(experiment_config['maxExecDuration']) + 's'
Deshui Yu's avatar
Deshui Yu committed
251
    request_data['maxTrialNum'] = experiment_config['maxTrialNum']
liuzhe-lz's avatar
liuzhe-lz committed
252
    request_data['maxTrialNumber'] = experiment_config['maxTrialNum']
253
    request_data['searchSpace'] = experiment_config.get('searchSpace')
254
    request_data['trainingServicePlatform'] = experiment_config.get('trainingServicePlatform')
255
256
    # hack for hotfix, fix config.trainingService undefined error, need refactor
    request_data['trainingService'] = {'platform': experiment_config.get('trainingServicePlatform')}
257
258
    if experiment_config.get('description'):
        request_data['description'] = experiment_config['description']
chicm-ms's avatar
chicm-ms committed
259
260
    if experiment_config.get('multiPhase'):
        request_data['multiPhase'] = experiment_config.get('multiPhase')
261
262
    if experiment_config.get('multiThread'):
        request_data['multiThread'] = experiment_config.get('multiThread')
J-shang's avatar
J-shang committed
263
264
    if experiment_config.get('nniManagerIp'):
        request_data['nniManagerIp'] = experiment_config.get('nniManagerIp')
QuanluZhang's avatar
QuanluZhang committed
265
266
    if experiment_config.get('advisor'):
        request_data['advisor'] = experiment_config['advisor']
267
268
269
270
        if request_data['advisor'].get('gpuNum'):
            print_error('gpuNum is deprecated, please use gpuIndices instead.')
        if request_data['advisor'].get('gpuIndices') and isinstance(request_data['advisor'].get('gpuIndices'), int):
            request_data['advisor']['gpuIndices'] = str(request_data['advisor'].get('gpuIndices'))
QuanluZhang's avatar
QuanluZhang committed
271
272
    else:
        request_data['tuner'] = experiment_config['tuner']
273
274
275
276
        if request_data['tuner'].get('gpuNum'):
            print_error('gpuNum is deprecated, please use gpuIndices instead.')
        if request_data['tuner'].get('gpuIndices') and isinstance(request_data['tuner'].get('gpuIndices'), int):
            request_data['tuner']['gpuIndices'] = str(request_data['tuner'].get('gpuIndices'))
QuanluZhang's avatar
QuanluZhang committed
277
278
        if 'assessor' in experiment_config:
            request_data['assessor'] = experiment_config['assessor']
279
280
            if request_data['assessor'].get('gpuNum'):
                print_error('gpuNum is deprecated, please remove it from your config file.')
SparkSnail's avatar
SparkSnail committed
281
    #debug mode should disable version check
282
    if experiment_config.get('debug') is not None:
SparkSnail's avatar
SparkSnail committed
283
        request_data['versionCheck'] = not experiment_config.get('debug')
284
285
286
    #validate version check
    if experiment_config.get('versionCheck') is not None:
        request_data['versionCheck'] = experiment_config.get('versionCheck')
SparkSnail's avatar
SparkSnail committed
287
288
    if experiment_config.get('logCollection'):
        request_data['logCollection'] = experiment_config.get('logCollection')
Deshui Yu's avatar
Deshui Yu committed
289
    request_data['clusterMetaData'] = []
290
    if experiment_config['trainingServicePlatform'] == 'kubeflow':
291
292
293
294
        request_data['clusterMetaData'].append(
            {'key': 'kubeflow_config', 'value': experiment_config['kubeflowConfig']})
        request_data['clusterMetaData'].append(
            {'key': 'trial_config', 'value': experiment_config['trial']})
295
296
297
298
299
    elif experiment_config['trainingServicePlatform'] == 'frameworkcontroller':
        request_data['clusterMetaData'].append(
            {'key': 'frameworkcontroller_config', 'value': experiment_config['frameworkcontrollerConfig']})
        request_data['clusterMetaData'].append(
            {'key': 'trial_config', 'value': experiment_config['trial']})
J-shang's avatar
J-shang committed
300
301
302
    elif experiment_config['trainingServicePlatform'] == 'adl':
        request_data['clusterMetaData'].append(
            {'key': 'trial_config', 'value': experiment_config['trial']})
303
    response = rest_post(experiment_url(port), json.dumps(request_data), REST_TIME_OUT, show_error=True)
304
305
306
    if check_response(response):
        return response
    else:
307
        _, stderr_full_path = get_log_path(config_file_name)
308
        if response is not None:
SparkSnail's avatar
SparkSnail committed
309
310
            with open(stderr_full_path, 'a+') as fout:
                fout.write(json.dumps(json.loads(response.text), indent=4, sort_keys=True, separators=(',', ':')))
SparkSnail's avatar
SparkSnail committed
311
            print_error('Setting experiment error, error message is {}'.format(response.text))
312
        return None
Deshui Yu's avatar
Deshui Yu committed
313

314
315
316
317
318
319
320
321
322
323
324
325
326
def set_experiment_v2(experiment_config, mode, port, config_file_name):
    '''Call startExperiment (rest POST /experiment) with yaml file content'''
    response = rest_post(experiment_url(port), json.dumps(experiment_config), REST_TIME_OUT, show_error=True)
    if check_response(response):
        return response
    else:
        _, stderr_full_path = get_log_path(config_file_name)
        if response is not None:
            with open(stderr_full_path, 'a+') as fout:
                fout.write(json.dumps(json.loads(response.text), indent=4, sort_keys=True, separators=(',', ':')))
            print_error('Setting experiment error, error message is {}'.format(response.text))
        return None

SparkSnail's avatar
SparkSnail committed
327
328
329
330
def set_platform_config(platform, experiment_config, port, config_file_name, rest_process):
    '''call set_cluster_metadata for specific platform'''
    print_normal('Setting {0} config...'.format(platform))
    config_result, err_msg = None, None
331
332
    if platform == 'adl':
        config_result, err_msg = set_adl_config(experiment_config, port, config_file_name)
SparkSnail's avatar
SparkSnail committed
333
334
335
336
337
338
339
    elif platform == 'kubeflow':
        config_result, err_msg = set_kubeflow_config(experiment_config, port, config_file_name)
    elif platform == 'frameworkcontroller':
        config_result, err_msg = set_frameworkcontroller_config(experiment_config, port, config_file_name)
    else:
        raise Exception(ERROR_INFO % 'Unsupported platform!')
        exit(1)
340
341
    if config_result:
        config_result, err_msg = set_shared_storage(experiment_config, port, config_file_name)
SparkSnail's avatar
SparkSnail committed
342
343
344
345
346
347
348
349
350
351
    if config_result:
        print_normal('Successfully set {0} config!'.format(platform))
    else:
        print_error('Failed! Error is: {}'.format(err_msg))
        try:
            kill_command(rest_process.pid)
        except Exception:
            raise Exception(ERROR_INFO % 'Rest server stopped!')
        exit(1)

352
def launch_experiment(args, experiment_config, mode, experiment_id, config_version):
Deshui Yu's avatar
Deshui Yu committed
353
    '''follow steps to start rest server and start experiment'''
354
    # check packages for tuner
355
    package_name, module_name = None, None
356
    if experiment_config.get('tuner') and experiment_config['tuner'].get('builtinTunerName'):
357
        package_name = experiment_config['tuner']['builtinTunerName']
chicm-ms's avatar
chicm-ms committed
358
        module_name, _ = get_builtin_module_class_name('tuners', package_name)
359
360
    elif experiment_config.get('advisor') and experiment_config['advisor'].get('builtinAdvisorName'):
        package_name = experiment_config['advisor']['builtinAdvisorName']
chicm-ms's avatar
chicm-ms committed
361
        module_name, _ = get_builtin_module_class_name('advisors', package_name)
362
    if package_name and module_name:
363
        try:
364
            stdout_full_path, stderr_full_path = get_log_path(experiment_id)
365
366
            with open(stdout_full_path, 'a+') as stdout_file, open(stderr_full_path, 'a+') as stderr_file:
                check_call([sys.executable, '-c', 'import %s'%(module_name)], stdout=stdout_file, stderr=stderr_file)
chicm-ms's avatar
chicm-ms committed
367
        except CalledProcessError:
368
            print_error('some errors happen when import package %s.' %(package_name))
369
            print_log_content(experiment_id)
370
371
372
            if package_name in ['SMAC', 'BOHB', 'PPOTuner']:
                print_error(f'The dependencies for {package_name} can be installed through pip install nni[{package_name}]')
            raise
373
374
375
376
    if config_version == 1:
        log_dir = experiment_config['logDir'] if experiment_config.get('logDir') else NNI_HOME_DIR
    else:
        log_dir = experiment_config['experimentWorkingDirectory'] if experiment_config.get('experimentWorkingDirectory') else NNI_HOME_DIR
377
    log_level = experiment_config['logLevel'] if experiment_config.get('logLevel') else 'info'
SparkSnail's avatar
SparkSnail committed
378
    #view experiment mode do not need debug function, when view an experiment, there will be no new logs created
SparkSnail's avatar
SparkSnail committed
379
    foreground = False
SparkSnail's avatar
SparkSnail committed
380
    if mode != 'view':
SparkSnail's avatar
SparkSnail committed
381
        foreground = args.foreground
SparkSnail's avatar
SparkSnail committed
382
383
        if log_level not in ['trace', 'debug'] and (args.debug or experiment_config.get('debug') is True):
            log_level = 'debug'
Deshui Yu's avatar
Deshui Yu committed
384
    # start rest server
385
386
    if config_version == 1:
        platform = experiment_config['trainingServicePlatform']
liuzhe-lz's avatar
liuzhe-lz committed
387
388
    elif isinstance(experiment_config['trainingService'], list):
        platform = 'hybrid'
389
390
391
392
    else:
        platform = experiment_config['trainingService']['platform']

    rest_process, start_time = start_rest_server(args.port, platform, \
393
                                                 mode, experiment_id, foreground, log_dir, log_level, args.url_prefix)
394
    # save experiment information
J-shang's avatar
J-shang committed
395
    Experiments().add_experiment(experiment_id, args.port, start_time,
396
                                 platform,
397
398
                                 experiment_config.get('experimentName', 'N/A')
                                 , pid=rest_process.pid, logDir=log_dir, prefixUrl=args.url_prefix)
Deshui Yu's avatar
Deshui Yu committed
399
400
    # Deal with annotation
    if experiment_config.get('useAnnotation'):
401
        path = os.path.join(tempfile.gettempdir(), get_user(), 'nni', 'annotation')
QuanluZhang's avatar
QuanluZhang committed
402
403
        if not os.path.isdir(path):
            os.makedirs(path)
liuzhe-lz's avatar
liuzhe-lz committed
404
        path = tempfile.mkdtemp(dir=path)
405
406
        nas_mode = experiment_config['trial'].get('nasMode', 'classic_mode')
        code_dir = expand_annotations(experiment_config['trial']['codeDir'], path, nas_mode=nas_mode)
liuzhe-lz's avatar
liuzhe-lz committed
407
408
        experiment_config['trial']['codeDir'] = code_dir
        search_space = generate_search_space(code_dir)
liuzhe-lz's avatar
liuzhe-lz committed
409
        experiment_config['searchSpace'] = search_space
Deshui Yu's avatar
Deshui Yu committed
410
        assert search_space, ERROR_INFO % 'Generated search space is empty'
411
412
413
    elif config_version == 1:
        if experiment_config.get('searchSpacePath'):
            search_space = get_json_content(experiment_config.get('searchSpacePath'))
liuzhe-lz's avatar
liuzhe-lz committed
414
            experiment_config['searchSpace'] = search_space
415
        else:
liuzhe-lz's avatar
liuzhe-lz committed
416
            experiment_config['searchSpace'] = ''
Deshui Yu's avatar
Deshui Yu committed
417
418

    # check rest server
goooxu's avatar
goooxu committed
419
    running, _ = check_rest_server(args.port)
420
    if running:
421
        print_normal('Successfully started Restful server!')
Deshui Yu's avatar
Deshui Yu committed
422
423
    else:
        print_error('Restful server start failed!')
424
        print_log_content(experiment_id)
Deshui Yu's avatar
Deshui Yu committed
425
        try:
426
            kill_command(rest_process.pid)
Deshui Yu's avatar
Deshui Yu committed
427
428
        except Exception:
            raise Exception(ERROR_INFO % 'Rest server stopped!')
goooxu's avatar
goooxu committed
429
        exit(1)
430
431
432
433
    if config_version == 1 and mode != 'view':
        # set platform configuration
        set_platform_config(experiment_config['trainingServicePlatform'], experiment_config, args.port,\
                            experiment_id, rest_process)
chicm-ms's avatar
chicm-ms committed
434

Deshui Yu's avatar
Deshui Yu committed
435
436
    # start a new experiment
    print_normal('Starting experiment...')
437
    # set debug configuration
SparkSnail's avatar
SparkSnail committed
438
    if mode != 'view' and experiment_config.get('debug') is None:
439
        experiment_config['debug'] = args.debug
440
441
442
443
    if config_version == 1:
        response = set_experiment_v1(experiment_config, mode, args.port, experiment_id)
    else:
        response = set_experiment_v2(experiment_config, mode, args.port, experiment_id)
Deshui Yu's avatar
Deshui Yu committed
444
445
446
447
    if response:
        if experiment_id is None:
            experiment_id = json.loads(response.text).get('experiment_id')
    else:
448
        print_error('Start experiment failed!')
449
        print_log_content(experiment_id)
Deshui Yu's avatar
Deshui Yu committed
450
        try:
451
            kill_command(rest_process.pid)
Deshui Yu's avatar
Deshui Yu committed
452
        except Exception:
453
            raise Exception(ERROR_INFO % 'Restful server stopped!')
goooxu's avatar
goooxu committed
454
        exit(1)
455
    if experiment_config.get('nniManagerIp'):
456
        web_ui_url_list = ['http://{0}:{1}{2}'.format(experiment_config['nniManagerIp'], str(args.port), formatURLPath(args.url_prefix))]
457
    else:
458
        web_ui_url_list = get_local_urls(args.port, args.url_prefix)
J-shang's avatar
J-shang committed
459
    Experiments().update_experiment(experiment_id, 'webuiUrl', web_ui_url_list)
460

461
    print_normal(EXPERIMENT_SUCCESS_INFO % (experiment_id, '   '.join(web_ui_url_list)))
SparkSnail's avatar
SparkSnail committed
462
    if mode != 'view' and args.foreground:
463
464
465
466
467
468
469
        try:
            while True:
                log_content = rest_process.stdout.readline().strip().decode('utf-8')
                print(log_content)
        except KeyboardInterrupt:
            kill_command(rest_process.pid)
            print_normal('Stopping experiment...')
Deshui Yu's avatar
Deshui Yu committed
470

liuzhe-lz's avatar
liuzhe-lz committed
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
def _validate_v1(config, path):
    try:
        validate_all_content(config, path)
    except Exception as e:
        print_error(f'Config V1 validation failed: {repr(e)}')
        exit(1)

def _validate_v2(config, path):
    base_path = Path(path).parent
    try:
        conf = ExperimentConfig(_base_path=base_path, **config)
        return conf.json()
    except Exception as e:
        print_error(f'Config V2 validation failed: {repr(e)}')

486
487
488
def _validate_prefix_path(path):
    assert re.match("^[A-Za-z0-9_-]*$", path), "prefix url is invalid."

SparkSnail's avatar
SparkSnail committed
489
490
def create_experiment(args):
    '''start a new experiment'''
491
    experiment_id = ''.join(random.sample(string.ascii_letters + string.digits, 8))
SparkSnail's avatar
SparkSnail committed
492
493
494
495
    config_path = os.path.abspath(args.config)
    if not os.path.exists(config_path):
        print_error('Please set correct config path!')
        exit(1)
496
    config_yml = get_yml_content(config_path)
497

liuzhe-lz's avatar
liuzhe-lz committed
498
499
500
501
502
503
504
505
506
507
508
509
510
    if 'trainingServicePlatform' in config_yml:
        _validate_v1(config_yml, config_path)
        platform = config_yml['trainingServicePlatform']
        if platform in k8s_training_services:
            schema = 1
            config_v1 = config_yml
        else:
            schema = 2
            from nni.experiment.config import convert
            config_v2 = convert.to_v2(config_yml).json()
    else:
        config_v2 = _validate_v2(config_yml, config_path)
        schema = 2
SparkSnail's avatar
SparkSnail committed
511

512
    try:
liuzhe-lz's avatar
liuzhe-lz committed
513
514
        if schema == 1:
            launch_experiment(args, config_v1, 'new', experiment_id, 1)
515
516
        else:
            launch_experiment(args, config_v2, 'new', experiment_id, 2)
517
    except Exception as exception:
518
        restServerPid = Experiments().get_all_experiments().get(experiment_id, {}).get('pid')
519
520
521
522
        if restServerPid:
            kill_command(restServerPid)
        print_error(exception)
        exit(1)
SparkSnail's avatar
SparkSnail committed
523
524
525

def manage_stopped_experiment(args, mode):
    '''view a stopped experiment'''
SparkSnail's avatar
SparkSnail committed
526
    update_experiment()
J-shang's avatar
J-shang committed
527
528
    experiments_config = Experiments()
    experiments_dict = experiments_config.get_all_experiments()
529
530
531
    experiment_id = None
    #find the latest stopped experiment
    if not args.id:
532
        print_error('Please set experiment id! \nYou could use \'nnictl {0} id\' to {0} a stopped experiment!\n' \
SparkSnail's avatar
SparkSnail committed
533
        'You could use \'nnictl experiment list --all\' to show all experiments!'.format(mode))
SparkSnail's avatar
SparkSnail committed
534
        exit(1)
535
    else:
J-shang's avatar
J-shang committed
536
        if experiments_dict.get(args.id) is None:
537
538
            print_error('Id %s not exist!' % args.id)
            exit(1)
J-shang's avatar
J-shang committed
539
        if experiments_dict[args.id]['status'] != 'STOPPED':
SparkSnail's avatar
SparkSnail committed
540
            print_error('Only stopped experiments can be {0}ed!'.format(mode))
541
542
            exit(1)
        experiment_id = args.id
SparkSnail's avatar
SparkSnail committed
543
    print_normal('{0} experiment {1}...'.format(mode, experiment_id))
J-shang's avatar
J-shang committed
544
545
    experiment_config = Config(experiment_id, experiments_dict[args.id]['logDir']).get_config()
    experiments_config.update_experiment(args.id, 'port', args.port)
546
    args.url_prefix = experiments_dict[args.id]['prefixUrl']
547
    assert 'trainingService' in experiment_config or 'trainingServicePlatform' in experiment_config
548
    try:
SparkSnail's avatar
SparkSnail committed
549
        if 'trainingServicePlatform' in experiment_config:
550
            experiment_config['logDir'] = experiments_dict[args.id]['logDir']
551
            launch_experiment(args, experiment_config, mode, experiment_id, 1)
SparkSnail's avatar
SparkSnail committed
552
553
554
        else:
            experiment_config['experimentWorkingDirectory'] = experiments_dict[args.id]['logDir']
            launch_experiment(args, experiment_config, mode, experiment_id, 2)
555
    except Exception as exception:
556
        restServerPid = Experiments().get_all_experiments().get(experiment_id, {}).get('pid')
557
558
559
560
        if restServerPid:
            kill_command(restServerPid)
        print_error(exception)
        exit(1)
Deshui Yu's avatar
Deshui Yu committed
561

SparkSnail's avatar
SparkSnail committed
562
563
564
def view_experiment(args):
    '''view a stopped experiment'''
    manage_stopped_experiment(args, 'view')
Deshui Yu's avatar
Deshui Yu committed
565

SparkSnail's avatar
SparkSnail committed
566
567
def resume_experiment(args):
    '''resume an experiment'''
liuzhe-lz's avatar
liuzhe-lz committed
568
    manage_stopped_experiment(args, 'resume')