nnictl_utils.py 31.2 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
# 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.

Yan Ni's avatar
Yan Ni committed
21
import csv
Deshui Yu's avatar
Deshui Yu committed
22
23
import os
import json
24
import time
SparkSnail's avatar
SparkSnail committed
25
26
import re
import shutil
chicm-ms's avatar
chicm-ms committed
27
28
29
from datetime import datetime, timezone
from pathlib import Path
from pyhdfs import HdfsClient
30
from nni_annotation import expand_annotations
31
from .rest_utils import rest_get, rest_delete, check_rest_server_quick, check_response
32
from .url_utils import trial_jobs_url, experiment_url, trial_job_id_url, export_data_url
33
from .config_utils import Config, Experiments
SparkSnail's avatar
SparkSnail committed
34
from .constants import NNICTL_HOME_DIR, EXPERIMENT_INFORMATION_FORMAT, EXPERIMENT_DETAIL_FORMAT, \
35
     EXPERIMENT_MONITOR_INFO, TRIAL_MONITOR_HEAD, TRIAL_MONITOR_CONTENT, TRIAL_MONITOR_TAIL, REST_TIME_OUT
SparkSnail's avatar
SparkSnail committed
36
from .common_utils import print_normal, print_error, print_warning, detect_process, get_yml_content
37
from .command_utils import check_output_command, kill_command
SparkSnail's avatar
SparkSnail committed
38
from .ssh_utils import create_ssh_sftp_client, remove_remote_directory
Deshui Yu's avatar
Deshui Yu committed
39

40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def get_experiment_time(port):
    '''get the startTime and endTime of an experiment'''
    response = rest_get(experiment_url(port), REST_TIME_OUT)
    if response and check_response(response):
        content = convert_time_stamp_to_date(json.loads(response.text))
        return content.get('startTime'), content.get('endTime')
    return None, None

def get_experiment_status(port):
    '''get the status of an experiment'''
    result, response = check_rest_server_quick(port)
    if result:
        return json.loads(response.text).get('status')
    return None

def update_experiment():
SparkSnail's avatar
SparkSnail committed
56
57
58
59
60
61
62
    '''Update the experiment status in config file'''
    experiment_config = Experiments()
    experiment_dict = experiment_config.get_all_experiments()
    if not experiment_dict:
        return None
    for key in experiment_dict.keys():
        if isinstance(experiment_dict[key], dict):
63
            if experiment_dict[key].get('status') != 'STOPPED':
SparkSnail's avatar
SparkSnail committed
64
65
66
                nni_config = Config(experiment_dict[key]['fileName'])
                rest_pid = nni_config.get_config('restServerPid')
                if not detect_process(rest_pid):
67
68
69
70
71
72
73
74
75
76
77
                    experiment_config.update_experiment(key, 'status', 'STOPPED')
                    continue
                rest_port = nni_config.get_config('restServerPort')
                startTime, endTime = get_experiment_time(rest_port)
                if startTime:
                    experiment_config.update_experiment(key, 'startTime', startTime)
                if endTime:
                    experiment_config.update_experiment(key, 'endTime', endTime)
                status = get_experiment_status(rest_port)
                if status:
                    experiment_config.update_experiment(key, 'status', status)
SparkSnail's avatar
SparkSnail committed
78

SparkSnail's avatar
SparkSnail committed
79
def check_experiment_id(args, update=True):
80
81
    '''check if the id is valid
    '''
SparkSnail's avatar
SparkSnail committed
82
83
    if update:
        update_experiment()
84
85
86
    experiment_config = Experiments()
    experiment_dict = experiment_config.get_all_experiments()
    if not experiment_dict:
87
        print_normal('There is no experiment running...')
chicm-ms's avatar
chicm-ms committed
88
        return None
89
    if not args.id:
90
91
        running_experiment_list = []
        for key in experiment_dict.keys():
SparkSnail's avatar
SparkSnail committed
92
            if isinstance(experiment_dict[key], dict):
93
                if experiment_dict[key].get('status') != 'STOPPED':
SparkSnail's avatar
SparkSnail committed
94
95
96
97
                    running_experiment_list.append(key)
            elif isinstance(experiment_dict[key], list):
                # if the config file is old version, remove the configuration from file
                experiment_config.remove_experiment(key)
98
        if len(running_experiment_list) > 1:
99
            print_error('There are multiple experiments, please set the experiment id...')
100
101
            experiment_information = ""
            for key in running_experiment_list:
102
103
104
105
106
107
108
                experiment_information += EXPERIMENT_DETAIL_FORMAT % (key,
                                                                      experiment_dict[key].get('experimentName', 'N/A'),
                                                                      experiment_dict[key]['status'],
                                                                      experiment_dict[key]['port'],
                                                                      experiment_dict[key].get('platform'),
                                                                      experiment_dict[key]['startTime'],
                                                                      experiment_dict[key]['endTime'])
109
110
111
            print(EXPERIMENT_INFORMATION_FORMAT % experiment_information)
            exit(1)
        elif not running_experiment_list:
SparkSnail's avatar
SparkSnail committed
112
            print_error('There is no experiment running.')
chicm-ms's avatar
chicm-ms committed
113
            return None
114
115
        else:
            return running_experiment_list[0]
116
117
118
    if experiment_dict.get(args.id):
        return args.id
    else:
SparkSnail's avatar
SparkSnail committed
119
        print_error('Id not correct.')
120
        return None
Deshui Yu's avatar
Deshui Yu committed
121

122
def parse_ids(args):
123
    '''Parse the arguments for nnictl stop
124
125
126
127
128
129
130
131
    1.If port is provided and id is not specified, return the id who owns the port
    2.If both port and id are provided, return the id if it owns the port, otherwise fail
    3.If there is an id specified, return the corresponding id
    4.If there is no id specified, and there is an experiment running, return the id, or return Error
    5.If the id matches an experiment, nnictl will return the id.
    6.If the id ends with *, nnictl will match all ids matchs the regular
    7.If the id does not exist but match the prefix of an experiment id, nnictl will return the matched id
    8.If the id does not exist but match multiple prefix of the experiment ids, nnictl will give id information
132
    '''
133
    update_experiment()
134
135
136
137
138
139
    experiment_config = Experiments()
    experiment_dict = experiment_config.get_all_experiments()
    if not experiment_dict:
        print_normal('Experiment is not running...')
        return None
    result_list = []
140
141
    running_experiment_list = []
    for key in experiment_dict.keys():
SparkSnail's avatar
SparkSnail committed
142
        if isinstance(experiment_dict[key], dict):
143
            if experiment_dict[key].get('status') != 'STOPPED':
SparkSnail's avatar
SparkSnail committed
144
145
146
147
                running_experiment_list.append(key)
        elif isinstance(experiment_dict[key], list):
            # if the config file is old version, remove the configuration from file
            experiment_config.remove_experiment(key)
148
149
    if args.all:
        return running_experiment_list
150
151
152
153
154
155
156
157
    if args.port is not None:
        for key in running_experiment_list:
            if str(experiment_dict[key]['port']) == args.port:
                result_list.append(key)
        if args.id and result_list and args.id != result_list[0]:
            print_error('Experiment id and resful server port not match')
            exit(1)
    elif not args.id:
158
        if len(running_experiment_list) > 1:
159
            print_error('There are multiple experiments, please set the experiment id...')
160
            experiment_information = ""
161
            for key in running_experiment_list:
162
163
164
165
166
167
168
                experiment_information += EXPERIMENT_DETAIL_FORMAT % (key,
                                                                      experiment_dict[key].get('experimentName', 'N/A'),
                                                                      experiment_dict[key]['status'],
                                                                      experiment_dict[key]['port'],
                                                                      experiment_dict[key].get('platform'),
                                                                      experiment_dict[key]['startTime'],
                                                                      experiment_dict[key]['endTime'])
169
170
171
172
            print(EXPERIMENT_INFORMATION_FORMAT % experiment_information)
            exit(1)
        else:
            result_list = running_experiment_list
173
    elif args.id.endswith('*'):
chicm-ms's avatar
chicm-ms committed
174
175
176
        for expId in running_experiment_list:
            if expId.startswith(args.id[:-1]):
                result_list.append(expId)
177
    elif args.id in running_experiment_list:
178
179
        result_list.append(args.id)
    else:
chicm-ms's avatar
chicm-ms committed
180
181
182
        for expId in running_experiment_list:
            if expId.startswith(args.id):
                result_list.append(expId)
183
        if len(result_list) > 1:
chicm-ms's avatar
chicm-ms committed
184
            print_error(args.id + ' is ambiguous, please choose ' + ' '.join(result_list))
185
            return None
186
    if not result_list and (args.id  or args.port):
187
        print_error('There are no experiments matched, please set correct experiment id or restful server port')
SparkSnail's avatar
SparkSnail committed
188
    elif not result_list:
SparkSnail's avatar
SparkSnail committed
189
        print_error('There is no experiment running...')
190
191
    return result_list

192
193
194
def get_config_filename(args):
    '''get the file name of config file'''
    experiment_id = check_experiment_id(args)
chicm-ms's avatar
chicm-ms committed
195
    if experiment_id is None:
SparkSnail's avatar
SparkSnail committed
196
        print_error('Please set correct experiment id.')
chicm-ms's avatar
chicm-ms committed
197
        exit(1)
198
199
200
201
202
203
204
    experiment_config = Experiments()
    experiment_dict = experiment_config.get_all_experiments()
    return experiment_dict[experiment_id]['fileName']

def get_experiment_port(args):
    '''get the port of experiment'''
    experiment_id = check_experiment_id(args)
chicm-ms's avatar
chicm-ms committed
205
    if experiment_id is None:
SparkSnail's avatar
SparkSnail committed
206
        print_error('Please set correct experiment id.')
chicm-ms's avatar
chicm-ms committed
207
        exit(1)
208
209
210
211
212
213
214
215
216
    experiment_config = Experiments()
    experiment_dict = experiment_config.get_all_experiments()
    return experiment_dict[experiment_id]['port']

def convert_time_stamp_to_date(content):
    '''Convert time stamp to date time format'''
    start_time_stamp = content.get('startTime')
    end_time_stamp = content.get('endTime')
    if start_time_stamp:
217
        start_time = datetime.fromtimestamp(start_time_stamp // 1000, timezone.utc).astimezone().strftime("%Y/%m/%d %H:%M:%S")
218
219
        content['startTime'] = str(start_time)
    if end_time_stamp:
220
        end_time = datetime.fromtimestamp(end_time_stamp // 1000, timezone.utc).astimezone().strftime("%Y/%m/%d %H:%M:%S")
221
222
223
224
225
226
227
228
229
230
231
232
233
        content['endTime'] = str(end_time)
    return content

def check_rest(args):
    '''check if restful server is running'''
    nni_config = Config(get_config_filename(args))
    rest_port = nni_config.get_config('restServerPort')
    running, _ = check_rest_server_quick(rest_port)
    if not running:
        print_normal('Restful server is running...')
    else:
        print_normal('Restful server is not running...')

Deshui Yu's avatar
Deshui Yu committed
234
235
def stop_experiment(args):
    '''Stop the experiment which is running'''
236
237
238
    if args.id and args.id == 'all':
        print_warning('\'nnictl stop all\' is abolished, please use \'nnictl stop --all\' to stop all of experiments!')
        exit(1)
239
240
241
242
243
244
    experiment_id_list = parse_ids(args)
    if experiment_id_list:
        experiment_config = Experiments()
        experiment_dict = experiment_config.get_all_experiments()
        for experiment_id in experiment_id_list:
            print_normal('Stoping experiment %s' % experiment_id)
245
            nni_config = Config(experiment_dict[experiment_id]['fileName'])
246
247
            rest_pid = nni_config.get_config('restServerPid')
            if rest_pid:
248
                kill_command(rest_pid)
SparkSnail's avatar
SparkSnail committed
249
250
251
252
                tensorboard_pid_list = nni_config.get_config('tensorboardPidList')
                if tensorboard_pid_list:
                    for tensorboard_pid in tensorboard_pid_list:
                        try:
253
                            kill_command(tensorboard_pid)
SparkSnail's avatar
SparkSnail committed
254
255
256
                        except Exception as exception:
                            print_error(exception)
                    nni_config.set_config('tensorboardPidList', [])
SparkSnail's avatar
SparkSnail committed
257
            print_normal('Stop experiment success.')
258
            experiment_config.update_experiment(experiment_id, 'status', 'STOPPED')
chicm-ms's avatar
chicm-ms committed
259
            time_now = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(time.time()))
260
            experiment_config.update_experiment(experiment_id, 'endTime', str(time_now))
Deshui Yu's avatar
Deshui Yu committed
261
262
263

def trial_ls(args):
    '''List trial'''
264
    nni_config = Config(get_config_filename(args))
Deshui Yu's avatar
Deshui Yu committed
265
266
267
268
269
    rest_port = nni_config.get_config('restServerPort')
    rest_pid = nni_config.get_config('restServerPid')
    if not detect_process(rest_pid):
        print_error('Experiment is not running...')
        return
270
271
    running, response = check_rest_server_quick(rest_port)
    if running:
272
        response = rest_get(trial_jobs_url(rest_port), REST_TIME_OUT)
273
        if response and check_response(response):
274
            content = json.loads(response.text)
275
            for index, value in enumerate(content):
276
277
                content[index] = convert_time_stamp_to_date(value)
            print(json.dumps(content, indent=4, sort_keys=True, separators=(',', ':')))
Deshui Yu's avatar
Deshui Yu committed
278
279
280
281
282
283
284
        else:
            print_error('List trial failed...')
    else:
        print_error('Restful server is not running...')

def trial_kill(args):
    '''List trial'''
285
    nni_config = Config(get_config_filename(args))
Deshui Yu's avatar
Deshui Yu committed
286
287
288
289
290
    rest_port = nni_config.get_config('restServerPort')
    rest_pid = nni_config.get_config('restServerPid')
    if not detect_process(rest_pid):
        print_error('Experiment is not running...')
        return
291
292
    running, _ = check_rest_server_quick(rest_port)
    if running:
SparkSnail's avatar
SparkSnail committed
293
        response = rest_delete(trial_job_id_url(rest_port, args.trial_id), REST_TIME_OUT)
294
        if response and check_response(response):
Deshui Yu's avatar
Deshui Yu committed
295
296
297
298
299
300
            print(response.text)
        else:
            print_error('Kill trial job failed...')
    else:
        print_error('Restful server is not running...')

301
302
303
304
305
306
307
308
309
310
311
def trial_codegen(args):
    '''Generate code for a specific trial'''
    print_warning('Currently, this command is only for nni nas programming interface.')
    exp_id = check_experiment_id(args)
    nni_config = Config(get_config_filename(args))
    if not nni_config.get_config('experimentConfig')['useAnnotation']:
        print_error('The experiment is not using annotation')
        exit(1)
    code_dir = nni_config.get_config('experimentConfig')['trial']['codeDir']
    expand_annotations(code_dir, './exp_%s_trial_%s_code'%(exp_id, args.trial_id), exp_id, args.trial_id)

Deshui Yu's avatar
Deshui Yu committed
312
313
def list_experiment(args):
    '''Get experiment information'''
314
    nni_config = Config(get_config_filename(args))
Deshui Yu's avatar
Deshui Yu committed
315
316
317
318
319
    rest_port = nni_config.get_config('restServerPort')
    rest_pid = nni_config.get_config('restServerPid')
    if not detect_process(rest_pid):
        print_error('Experiment is not running...')
        return
320
321
    running, _ = check_rest_server_quick(rest_port)
    if running:
322
        response = rest_get(experiment_url(rest_port), REST_TIME_OUT)
323
        if response and check_response(response):
324
325
            content = convert_time_stamp_to_date(json.loads(response.text))
            print(json.dumps(content, indent=4, sort_keys=True, separators=(',', ':')))
Deshui Yu's avatar
Deshui Yu committed
326
327
328
329
330
        else:
            print_error('List experiment failed...')
    else:
        print_error('Restful server is not running...')

331
332
def experiment_status(args):
    '''Show the status of experiment'''
333
    nni_config = Config(get_config_filename(args))
334
335
336
337
338
339
340
    rest_port = nni_config.get_config('restServerPort')
    result, response = check_rest_server_quick(rest_port)
    if not result:
        print_normal('Restful server is not running...')
    else:
        print(json.dumps(json.loads(response.text), indent=4, sort_keys=True, separators=(',', ':')))

Deshui Yu's avatar
Deshui Yu committed
341
342
def log_internal(args, filetype):
    '''internal function to call get_log_content'''
343
    file_name = get_config_filename(args)
Deshui Yu's avatar
Deshui Yu committed
344
    if filetype == 'stdout':
345
        file_full_path = os.path.join(NNICTL_HOME_DIR, file_name, 'stdout')
Deshui Yu's avatar
Deshui Yu committed
346
    else:
347
        file_full_path = os.path.join(NNICTL_HOME_DIR, file_name, 'stderr')
348
    print(check_output_command(file_full_path, head=args.head, tail=args.tail))
349

Deshui Yu's avatar
Deshui Yu committed
350
351
352
353
354
355
356
357
def log_stdout(args):
    '''get stdout log'''
    log_internal(args, 'stdout')

def log_stderr(args):
    '''get stderr log'''
    log_internal(args, 'stderr')

358
359
360
def log_trial(args):
    ''''get trial log path'''
    trial_id_path_dict = {}
SparkSnail's avatar
SparkSnail committed
361
    trial_id_list = []
362
    nni_config = Config(get_config_filename(args))
363
364
365
366
367
368
369
    rest_port = nni_config.get_config('restServerPort')
    rest_pid = nni_config.get_config('restServerPid')
    if not detect_process(rest_pid):
        print_error('Experiment is not running...')
        return
    running, response = check_rest_server_quick(rest_port)
    if running:
370
        response = rest_get(trial_jobs_url(rest_port), REST_TIME_OUT)
371
372
373
        if response and check_response(response):
            content = json.loads(response.text)
            for trial in content:
SparkSnail's avatar
SparkSnail committed
374
375
376
                trial_id_list.append(trial.get('id'))
                if trial.get('logPath'):
                    trial_id_path_dict[trial.get('id')] = trial['logPath']
377
378
    else:
        print_error('Restful server is not running...')
goooxu's avatar
goooxu committed
379
        exit(1)
SparkSnail's avatar
SparkSnail committed
380
381
382
383
384
385
    if args.trial_id:
        if args.trial_id not in trial_id_list:
            print_error('Trial id {0} not correct, please check your command!'.format(args.trial_id))
            exit(1)
        if trial_id_path_dict.get(args.trial_id):
            print_normal('id:' + args.trial_id + ' path:' + trial_id_path_dict[args.trial_id])
386
        else:
SparkSnail's avatar
SparkSnail committed
387
            print_error('Log path is not available yet, please wait...')
goooxu's avatar
goooxu committed
388
            exit(1)
389
    else:
SparkSnail's avatar
SparkSnail committed
390
        print_normal('All of trial log info:')
391
        for key in trial_id_path_dict:
SparkSnail's avatar
SparkSnail committed
392
393
394
            print_normal('id:' + key + ' path:' + trial_id_path_dict[key])
        if not trial_id_path_dict:
            print_normal('None')
395

Deshui Yu's avatar
Deshui Yu committed
396
397
def get_config(args):
    '''get config info'''
398
    nni_config = Config(get_config_filename(args))
Deshui Yu's avatar
Deshui Yu committed
399
    print(nni_config.get_all_config())
400
401
402

def webui_url(args):
    '''show the url of web ui'''
403
    nni_config = Config(get_config_filename(args))
404
405
    print_normal('{0} {1}'.format('Web UI url:', ' '.join(nni_config.get_config('webuiUrl'))))

SparkSnail's avatar
SparkSnail committed
406
407
408
409
410
def local_clean(directory):
    '''clean up local data'''
    print_normal('removing folder {0}'.format(directory))
    try:
        shutil.rmtree(directory)
chicm-ms's avatar
chicm-ms committed
411
    except FileNotFoundError:
SparkSnail's avatar
SparkSnail committed
412
        print_error('{0} does not exist.'.format(directory))
chicm-ms's avatar
chicm-ms committed
413

SparkSnail's avatar
SparkSnail committed
414
415
416
417
418
419
420
421
422
423
424
425
426
427
def remote_clean(machine_list, experiment_id=None):
    '''clean up remote data'''
    for machine in machine_list:
        passwd = machine.get('passwd')
        userName = machine.get('username')
        host = machine.get('ip')
        port = machine.get('port')
        if experiment_id:
            remote_dir = '/' + '/'.join(['tmp', 'nni', 'experiments', experiment_id])
        else:
            remote_dir = '/' + '/'.join(['tmp', 'nni', 'experiments'])
        sftp = create_ssh_sftp_client(host, port, userName, passwd)
        print_normal('removing folder {0}'.format(host + ':' + str(port) + remote_dir))
        remove_remote_directory(sftp, remote_dir)
chicm-ms's avatar
chicm-ms committed
428

SparkSnail's avatar
SparkSnail committed
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
def hdfs_clean(host, user_name, output_dir, experiment_id=None):
    '''clean up hdfs data'''
    hdfs_client = HdfsClient(hosts='{0}:80'.format(host), user_name=user_name, webhdfs_path='/webhdfs/api/v1', timeout=5)
    if experiment_id:
        full_path = '/' + '/'.join([user_name, 'nni', 'experiments', experiment_id])
    else:
        full_path = '/' + '/'.join([user_name, 'nni', 'experiments'])
    print_normal('removing folder {0} in hdfs'.format(full_path))
    hdfs_client.delete(full_path, recursive=True)
    if output_dir:
        pattern = re.compile('hdfs://(?P<host>([0-9]{1,3}.){3}[0-9]{1,3})(:[0-9]{2,5})?(?P<baseDir>/.*)?')
        match_result = pattern.match(output_dir)
        if match_result:
            output_host = match_result.group('host')
            output_dir = match_result.group('baseDir')
            #check if the host is valid
            if output_host != host:
                print_warning('The host in {0} is not consistent with {1}'.format(output_dir, host))
            else:
                if experiment_id:
                    output_dir = output_dir + '/' + experiment_id
                print_normal('removing folder {0} in hdfs'.format(output_dir))
                hdfs_client.delete(output_dir, recursive=True)

def experiment_clean(args):
    '''clean up the experiment data'''
    experiment_id_list = []
    experiment_config = Experiments()
    experiment_dict = experiment_config.get_all_experiments()
    if args.all:
        experiment_id_list = list(experiment_dict.keys())
    else:
        if args.id is None:
SparkSnail's avatar
SparkSnail committed
462
            print_error('please set experiment id.')
SparkSnail's avatar
SparkSnail committed
463
464
            exit(1)
        if args.id not in experiment_dict:
SparkSnail's avatar
SparkSnail committed
465
            print_error('Cannot find experiment {0}.'.format(args.id))
SparkSnail's avatar
SparkSnail committed
466
467
468
            exit(1)
        experiment_id_list.append(args.id)
    while True:
SparkSnail's avatar
SparkSnail committed
469
        print('INFO: This action will delete experiment {0}, and it\'s not recoverable.'.format(' '.join(experiment_id_list)))
SparkSnail's avatar
SparkSnail committed
470
471
472
473
        inputs = input('INFO: do you want to continue?[y/N]:')
        if not inputs.lower() or inputs.lower() in ['n', 'no']:
            exit(0)
        elif inputs.lower() not in ['y', 'n', 'yes', 'no']:
SparkSnail's avatar
SparkSnail committed
474
            print_warning('please input Y or N.')
SparkSnail's avatar
SparkSnail committed
475
476
477
478
479
480
481
482
483
484
        else:
            break
    for experiment_id in experiment_id_list:
        nni_config = Config(experiment_dict[experiment_id]['fileName'])
        platform = nni_config.get_config('experimentConfig').get('trainingServicePlatform')
        experiment_id = nni_config.get_config('experimentId')
        if platform == 'remote':
            machine_list = nni_config.get_config('experimentConfig').get('machineList')
            remote_clean(machine_list, experiment_id)
        elif platform == 'pai':
chicm-ms's avatar
chicm-ms committed
485
            host = nni_config.get_config('experimentConfig').get('paiConfig').get('host')
SparkSnail's avatar
SparkSnail committed
486
487
488
489
490
            user_name = nni_config.get_config('experimentConfig').get('paiConfig').get('userName')
            output_dir = nni_config.get_config('experimentConfig').get('trial').get('outputDir')
            hdfs_clean(host, user_name, output_dir, experiment_id)
        elif platform != 'local':
            #TODO: support all platforms
SparkSnail's avatar
SparkSnail committed
491
            print_warning('platform {0} clean up not supported yet.'.format(platform))
SparkSnail's avatar
SparkSnail committed
492
493
494
495
496
497
498
499
500
501
            exit(0)
        #clean local data
        home = str(Path.home())
        local_dir = nni_config.get_config('experimentConfig').get('logDir')
        if not local_dir:
            local_dir = os.path.join(home, 'nni', 'experiments', experiment_id)
        local_clean(local_dir)
        experiment_config = Experiments()
        print_normal('removing metadata of experiment {0}'.format(experiment_id))
        experiment_config.remove_experiment(experiment_id)
chicm-ms's avatar
chicm-ms committed
502
        print_normal('Done.')
SparkSnail's avatar
SparkSnail committed
503
504
505
506
507
508
509
510
511
512

def get_platform_dir(config_content):
    '''get the dir list to be deleted'''
    platform = config_content.get('trainingServicePlatform')
    dir_list = []
    if platform == 'remote':
        machine_list = config_content.get('machineList')
        for machine in machine_list:
            host = machine.get('ip')
            port = machine.get('port')
SparkSnail's avatar
SparkSnail committed
513
            dir_list.append(host + ':' + str(port) + '/tmp/nni')
SparkSnail's avatar
SparkSnail committed
514
    elif platform == 'pai':
chicm-ms's avatar
chicm-ms committed
515
        host = config_content.get('paiConfig').get('host')
SparkSnail's avatar
SparkSnail committed
516
517
        user_name = config_content.get('paiConfig').get('userName')
        output_dir = config_content.get('trial').get('outputDir')
SparkSnail's avatar
SparkSnail committed
518
        dir_list.append('server: {0}, path: {1}/nni'.format(host, user_name))
SparkSnail's avatar
SparkSnail committed
519
520
521
522
523
524
525
526
        if output_dir:
            dir_list.append(output_dir)
    return dir_list

def platform_clean(args):
    '''clean up the experiment data'''
    config_path = os.path.abspath(args.config)
    if not os.path.exists(config_path):
SparkSnail's avatar
SparkSnail committed
527
        print_error('Please set correct config path.')
SparkSnail's avatar
SparkSnail committed
528
529
530
        exit(1)
    config_content = get_yml_content(config_path)
    platform = config_content.get('trainingServicePlatform')
SparkSnail's avatar
SparkSnail committed
531
532
533
    if platform == 'local':
        print_normal('it doesn’t need to clean local platform.')
        exit(0)
SparkSnail's avatar
SparkSnail committed
534
    if platform not in ['remote', 'pai']:
SparkSnail's avatar
SparkSnail committed
535
        print_normal('platform {0} not supported.'.format(platform))
SparkSnail's avatar
SparkSnail committed
536
        exit(0)
Shinai Yang's avatar
Shinai Yang committed
537
    update_experiment()
SparkSnail's avatar
SparkSnail committed
538
539
    dir_list = get_platform_dir(config_content)
    if not dir_list:
SparkSnail's avatar
SparkSnail committed
540
        print_normal('No folder of NNI caches is found.')
SparkSnail's avatar
SparkSnail committed
541
542
        exit(1)
    while True:
chicm-ms's avatar
chicm-ms committed
543
544
545
546
        print_normal('This command will remove below folders of NNI caches. If other users are using experiments' \
                     ' on below hosts, it will be broken.')
        for value in dir_list:
            print('       ' + value)
SparkSnail's avatar
SparkSnail committed
547
548
549
550
        inputs = input('INFO: do you want to continue?[y/N]:')
        if not inputs.lower() or inputs.lower() in ['n', 'no']:
            exit(0)
        elif inputs.lower() not in ['y', 'n', 'yes', 'no']:
SparkSnail's avatar
SparkSnail committed
551
            print_warning('please input Y or N.')
SparkSnail's avatar
SparkSnail committed
552
553
554
555
        else:
            break
    if platform == 'remote':
        machine_list = config_content.get('machineList')
chicm-ms's avatar
chicm-ms committed
556
        remote_clean(machine_list, None)
SparkSnail's avatar
SparkSnail committed
557
    elif platform == 'pai':
chicm-ms's avatar
chicm-ms committed
558
        host = config_content.get('paiConfig').get('host')
SparkSnail's avatar
SparkSnail committed
559
560
561
        user_name = config_content.get('paiConfig').get('userName')
        output_dir = config_content.get('trial').get('outputDir')
        hdfs_clean(host, user_name, output_dir, None)
SparkSnail's avatar
SparkSnail committed
562
    print_normal('Done.')
SparkSnail's avatar
SparkSnail committed
563

564
565
def experiment_list(args):
    '''get the information of all experiments'''
Shinai Yang's avatar
Shinai Yang committed
566
    update_experiment()
567
568
569
    experiment_config = Experiments()
    experiment_dict = experiment_config.get_all_experiments()
    if not experiment_dict:
SparkSnail's avatar
SparkSnail committed
570
        print_normal('Cannot find experiments.')
571
572
        exit(1)
    experiment_id_list = []
SparkSnail's avatar
SparkSnail committed
573
    if args.all:
574
575
        for key in experiment_dict.keys():
            experiment_id_list.append(key)
576
577
    else:
        for key in experiment_dict.keys():
578
            if experiment_dict[key]['status'] != 'STOPPED':
579
580
                experiment_id_list.append(key)
        if not experiment_id_list:
581
            print_warning('There is no experiment running...\nYou can use \'nnictl experiment list --all\' to list all experiments.')
582
583
    experiment_information = ""
    for key in experiment_id_list:
584
585
586
587
588
589
590
        experiment_information += EXPERIMENT_DETAIL_FORMAT % (key,
                                                              experiment_dict[key].get('experimentName', 'N/A'),
                                                              experiment_dict[key]['status'],
                                                              experiment_dict[key]['port'],
                                                              experiment_dict[key].get('platform'),
                                                              experiment_dict[key]['startTime'],
                                                              experiment_dict[key]['endTime'])
591
    print(EXPERIMENT_INFORMATION_FORMAT % experiment_information)
SparkSnail's avatar
SparkSnail committed
592

SparkSnail's avatar
SparkSnail committed
593
594
595
596
def get_time_interval(time1, time2):
    '''get the interval of two times'''
    try:
        #convert time to timestamp
597
598
        time1 = time.mktime(time.strptime(time1, '%Y/%m/%d %H:%M:%S'))
        time2 = time.mktime(time.strptime(time2, '%Y/%m/%d %H:%M:%S'))
599
        seconds = (datetime.fromtimestamp(time2) - datetime.fromtimestamp(time1)).seconds
SparkSnail's avatar
SparkSnail committed
600
601
602
603
604
605
606
607
608
609
610
611
612
        #convert seconds to day:hour:minute:second
        days = seconds / 86400
        seconds %= 86400
        hours = seconds / 3600
        seconds %= 3600
        minutes = seconds / 60
        seconds %= 60
        return '%dd %dh %dm %ds' % (days, hours, minutes, seconds)
    except:
        return 'N/A'

def show_experiment_info():
    '''show experiment information in monitor'''
Shinai Yang's avatar
Shinai Yang committed
613
    update_experiment()
SparkSnail's avatar
SparkSnail committed
614
615
616
617
618
619
620
    experiment_config = Experiments()
    experiment_dict = experiment_config.get_all_experiments()
    if not experiment_dict:
        print('There is no experiment running...')
        exit(1)
    experiment_id_list = []
    for key in experiment_dict.keys():
621
        if experiment_dict[key]['status'] != 'STOPPED':
SparkSnail's avatar
SparkSnail committed
622
623
624
625
626
627
            experiment_id_list.append(key)
    if not experiment_id_list:
        print_warning('There is no experiment running...')
        return
    for key in experiment_id_list:
        print(EXPERIMENT_MONITOR_INFO % (key, experiment_dict[key]['status'], experiment_dict[key]['port'], \
chicm-ms's avatar
chicm-ms committed
628
629
             experiment_dict[key].get('platform'), experiment_dict[key]['startTime'], \
             get_time_interval(experiment_dict[key]['startTime'], experiment_dict[key]['endTime'])))
SparkSnail's avatar
SparkSnail committed
630
631
632
        print(TRIAL_MONITOR_HEAD)
        running, response = check_rest_server_quick(experiment_dict[key]['port'])
        if running:
633
            response = rest_get(trial_jobs_url(experiment_dict[key]['port']), REST_TIME_OUT)
SparkSnail's avatar
SparkSnail committed
634
635
            if response and check_response(response):
                content = json.loads(response.text)
636
                for index, value in enumerate(content):
SparkSnail's avatar
SparkSnail committed
637
                    content[index] = convert_time_stamp_to_date(value)
chicm-ms's avatar
chicm-ms committed
638
639
                    print(TRIAL_MONITOR_CONTENT % (content[index].get('id'), content[index].get('startTime'), \
                          content[index].get('endTime'), content[index].get('status')))
SparkSnail's avatar
SparkSnail committed
640
641
642
643
644
645
646
647
648
649
        print(TRIAL_MONITOR_TAIL)

def monitor_experiment(args):
    '''monitor the experiment'''
    if args.time <= 0:
        print_error('please input a positive integer as time interval, the unit is second.')
        exit(1)
    while True:
        try:
            os.system('clear')
650
            update_experiment()
SparkSnail's avatar
SparkSnail committed
651
652
653
654
655
656
657
            show_experiment_info()
            time.sleep(args.time)
        except KeyboardInterrupt:
            exit(0)
        except Exception as exception:
            print_error(exception)
            exit(1)
Yan Ni's avatar
Yan Ni committed
658
659

def export_trials_data(args):
660
661
    '''export experiment metadata to csv
    '''
Yan Ni's avatar
Yan Ni committed
662
663
664
665
666
667
668
669
    nni_config = Config(get_config_filename(args))
    rest_port = nni_config.get_config('restServerPort')
    rest_pid = nni_config.get_config('restServerPid')
    if not detect_process(rest_pid):
        print_error('Experiment is not running...')
        return
    running, response = check_rest_server_quick(rest_port)
    if running:
670
        response = rest_get(export_data_url(rest_port), 20)
Yan Ni's avatar
Yan Ni committed
671
        if response is not None and check_response(response):
672
            if args.type == 'json':
673
674
675
676
677
678
679
680
681
682
683
684
685
                with open(args.path, 'w') as file:
                    file.write(response.text)
            elif args.type == 'csv':
                content = json.loads(response.text)
                trial_records = []
                for record in content:
                    if not isinstance(record['value'], (float, int)):
                        formated_record = {**record['parameter'], **record['value'], **{'id': record['id']}}
                    else:
                        formated_record = {**record['parameter'], **{'reward': record['value'], 'id': record['id']}}
                    trial_records.append(formated_record)
                with open(args.path, 'w') as file:
                    writer = csv.DictWriter(file, set.union(*[set(r.keys()) for r in trial_records]))
686
                    writer.writeheader()
687
688
689
690
                    writer.writerows(trial_records)
            else:
                print_error('Unknown type: %s' % args.type)
                exit(1)
Yan Ni's avatar
Yan Ni committed
691
692
693
        else:
            print_error('Export failed...')
    else:
694
        print_error('Restful server is not Running')