constants.py 5.36 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
# 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 os
22
from colorama import Fore
Deshui Yu's avatar
Deshui Yu committed
23

chicm-ms's avatar
chicm-ms committed
24
NNICTL_HOME_DIR = os.path.join(os.path.expanduser('~'), '.local', 'nnictl')
Deshui Yu's avatar
Deshui Yu committed
25

26
ERROR_INFO = 'ERROR: %s'
Deshui Yu's avatar
Deshui Yu committed
27

28
NORMAL_INFO = 'INFO: %s'
Deshui Yu's avatar
Deshui Yu committed
29

30
WARNING_INFO = 'WARNING: %s'
Deshui Yu's avatar
Deshui Yu committed
31

32
DEFAULT_REST_PORT = 8080
goooxu's avatar
goooxu committed
33

34
35
REST_TIME_OUT = 20

36
EXPERIMENT_SUCCESS_INFO = Fore.GREEN + 'Successfully started experiment!\n' + Fore.RESET + \
Shinai Yang's avatar
Shinai Yang committed
37
                          '------------------------------------------------------------------------------------\n' \
38
                          'The experiment id is %s\n'\
39
                          'The Web UI urls are: %s\n' \
Shinai Yang's avatar
Shinai Yang committed
40
                          '------------------------------------------------------------------------------------\n\n' \
41
                          'You can use these commands to get more information about the experiment\n' \
Shinai Yang's avatar
Shinai Yang committed
42
                          '------------------------------------------------------------------------------------\n' \
Deshui Yu's avatar
Deshui Yu committed
43
                          '         commands                       description\n' \
44
                          '1. nnictl experiment show        show the information of experiments\n' \
Deshui Yu's avatar
Deshui Yu committed
45
                          '2. nnictl trial ls               list all of trial jobs\n' \
SparkSnail's avatar
SparkSnail committed
46
47
48
49
50
51
                          '3. nnictl top                    monitor the status of running experiments\n' \
                          '4. nnictl log stderr             show stderr log content\n' \
                          '5. nnictl log stdout             show stdout log content\n' \
                          '6. nnictl stop                   stop an experiment\n' \
                          '7. nnictl trial kill             kill a trial job by id\n' \
                          '8. nnictl --help                 get help information about nnictl\n' \
Shinai Yang's avatar
Shinai Yang committed
52
53
54
                          '------------------------------------------------------------------------------------\n' \
                          'Command reference document https://nni.readthedocs.io/en/latest/Tutorial/Nnictl.html\n' \
                          '------------------------------------------------------------------------------------\n'
QuanluZhang's avatar
QuanluZhang committed
55

56
57
58
59
60
LOG_HEADER = '-----------------------------------------------------------------------\n' \
             '                Experiment start time %s\n' \
             '-----------------------------------------------------------------------\n'

EXPERIMENT_START_FAILED_INFO = 'There is an experiment running in the port %d, please stop it first or set another port!\n' \
chicm-ms's avatar
chicm-ms committed
61
62
                               'You could use \'nnictl stop --port [PORT]\' command to stop an experiment!\nOr you could ' \
                               'use \'nnictl create --config [CONFIG_PATH] --port [PORT]\' to set port!\n'
63

SparkSnail's avatar
SparkSnail committed
64
EXPERIMENT_INFORMATION_FORMAT = '----------------------------------------------------------------------------------------\n' \
65
66
                     '                Experiment information\n' \
                     '%s\n' \
SparkSnail's avatar
SparkSnail committed
67
                     '----------------------------------------------------------------------------------------\n'
68

69
EXPERIMENT_DETAIL_FORMAT = 'Id: %s    Name: %s    Status: %s    Port: %s    Platform: %s    StartTime: %s    EndTime: %s\n'
SparkSnail's avatar
SparkSnail committed
70
71
72
73
74
75
76
77
78
79
80

EXPERIMENT_MONITOR_INFO = 'Id: %s    Status: %s    Port: %s    Platform: %s    \n' \
                          'StartTime: %s    Duration: %s'

TRIAL_MONITOR_HEAD = '-------------------------------------------------------------------------------------\n' + \
                    '%-15s %-25s %-25s %-15s \n' % ('trialId', 'startTime', 'endTime', 'status') + \
                     '-------------------------------------------------------------------------------------'

TRIAL_MONITOR_CONTENT = '%-15s %-25s %-25s %-15s'

TRIAL_MONITOR_TAIL = '-------------------------------------------------------------------------------------\n\n\n'
81

QuanluZhang's avatar
QuanluZhang committed
82
PACKAGE_REQUIREMENTS = {
Shufan Huang's avatar
Shufan Huang committed
83
    'SMAC': 'smac_tuner',
84
85
    'BOHB': 'bohb_advisor',
    'PPOTuner': 'ppo_tuner'
QuanluZhang's avatar
QuanluZhang committed
86
}
87

88
89
90
91
92
TUNERS_SUPPORTING_IMPORT_DATA = {
    'TPE',
    'Anneal',
    'GridSearch',
    'MetisTuner',
QuanluZhang's avatar
QuanluZhang committed
93
94
95
    'BOHB',
    'SMAC',
    'BatchTuner'
96
97
98
99
100
101
102
}

TUNERS_NO_NEED_TO_IMPORT_DATA = {
    'Random',
    'Hyperband'
}

103
COLOR_RED_FORMAT = Fore.RED + '%s'
104

105
COLOR_GREEN_FORMAT = Fore.GREEN + '%s'
106

107
COLOR_YELLOW_FORMAT = Fore.YELLOW + '%s'
108
109
110
111
112
113

SCHEMA_TYPE_ERROR = '%s should be %s type!'

SCHEMA_RANGE_ERROR = '%s should be in range of %s!'

SCHEMA_PATH_ERROR = '%s path not exist!'