restValidationSchemas.ts 9.11 KB
Newer Older
liuzhe-lz's avatar
liuzhe-lz committed
1
2
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
3
4
5
6
7
8
9
10

'use strict';

const joi = require('joi');

export namespace ValidationSchemas {
    export const SETCLUSTERMETADATA = {
        body: {
chicm-ms's avatar
chicm-ms committed
11
            machine_list: joi.array().items(joi.object({ // eslint-disable-line @typescript-eslint/camelcase
12
13
14
                username: joi.string().required(),
                ip: joi.string().ip().required(),
                port: joi.number().min(1).max(65535).required(),
SparkSnail's avatar
SparkSnail committed
15
                passwd: joi.string(),
16
                sshKeyPath: joi.string(),
17
                passphrase: joi.string(),
18
19
20
                gpuIndices: joi.string(),
                maxTrialNumPerGpu: joi.number(),
                useActiveGpu: joi.boolean()
21
            })),
chicm-ms's avatar
chicm-ms committed
22
            local_config: joi.object({ // eslint-disable-line @typescript-eslint/camelcase
23
24
25
                gpuIndices: joi.string(),
                maxTrialNumPerGpu: joi.number(),
                useActiveGpu: joi.boolean()
26
            }),
chicm-ms's avatar
chicm-ms committed
27
            trial_config: joi.object({ // eslint-disable-line @typescript-eslint/camelcase
28
                image: joi.string().min(1),
29
                codeDir: joi.string().min(1).required(),
30
31
32
33
                dataDir: joi.string(),
                outputDir: joi.string(),
                cpuNum: joi.number().min(1),
                memoryMB: joi.number().min(100),
34
35
                gpuNum: joi.number().min(0),
                command: joi.string().min(1),
36
                virtualCluster: joi.string(),
37
                shmMB: joi.number(),
38
                authFile: joi.string(),
39
                nasMode: joi.string().valid('classic_mode', 'enas_mode', 'oneshot_mode', 'darts_mode'),
40
41
42
43
44
                portList: joi.array().items(joi.object({
                    label: joi.string().required(),
                    beginAt: joi.number().required(),
                    portNumber: joi.number().required(),
                })),
45
46
47
                worker: joi.object({
                    replicas: joi.number().min(1).required(),
                    image: joi.string().min(1),
48
                    privateRegistryAuthPath: joi.string().min(1),
49
50
51
52
53
54
55
56
57
                    outputDir: joi.string(),
                    cpuNum: joi.number().min(1),
                    memoryMB: joi.number().min(100),
                    gpuNum: joi.number().min(0).required(),
                    command: joi.string().min(1).required()
                }),
                ps: joi.object({
                        replicas: joi.number().min(1).required(),
                        image: joi.string().min(1),
58
                        privateRegistryAuthPath: joi.string().min(1),
59
60
61
62
63
                        outputDir: joi.string(),
                        cpuNum: joi.number().min(1),
                        memoryMB: joi.number().min(100),
                        gpuNum: joi.number().min(0).required(),
                        command: joi.string().min(1).required()
64
65
66
67
                }),
                master: joi.object({
                    replicas: joi.number().min(1).required(),
                    image: joi.string().min(1),
68
                    privateRegistryAuthPath: joi.string().min(1),
69
70
71
72
73
                    outputDir: joi.string(),
                    cpuNum: joi.number().min(1),
                    memoryMB: joi.number().min(100),
                    gpuNum: joi.number().min(0).required(),
                    command: joi.string().min(1).required()
74
75
76
77
78
                }),
                taskRoles: joi.array({
                    name: joi.string().min(1),
                    taskNum: joi.number().min(1).required(),
                    image: joi.string().min(1),
79
                    privateRegistryAuthPath: joi.string().min(1),
80
81
82
                    outputDir: joi.string(),
                    cpuNum: joi.number().min(1),
                    memoryMB: joi.number().min(100),
83
                    shmMB: joi.number(),
84
85
86
87
88
89
                    gpuNum: joi.number().min(0).required(),
                    command: joi.string().min(1).required(),
                    frameworkAttemptCompletionPolicy: joi.object({
                        minFailedTaskCount: joi.number(),
                        minSucceededTaskCount: joi.number()
                    })
90
                })
91
            }),
chicm-ms's avatar
chicm-ms committed
92
            pai_config: joi.object({ // eslint-disable-line @typescript-eslint/camelcase
93
                userName: joi.string().min(1).required(),
94
95
                passWord: joi.string().min(1),
                token: joi.string().min(1),
96
                host: joi.string().min(1).required()
97
            }),
chicm-ms's avatar
chicm-ms committed
98
            kubeflow_config: joi.object({ // eslint-disable-line @typescript-eslint/camelcase
99
                operator: joi.string().min(1).required(),
100
                storage: joi.string().min(1),
101
                apiVersion: joi.string().min(1),
102
103
104
                nfs: joi.object({
                    server: joi.string().min(1).required(),
                    path: joi.string().min(1).required()
SparkSnail's avatar
SparkSnail committed
105
106
107
108
109
110
111
                }),
                keyVault: joi.object({
                    vaultName: joi.string().regex(/^([0-9]|[a-z]|[A-Z]|-){1,127}$/),
                    name: joi.string().regex(/^([0-9]|[a-z]|[A-Z]|-){1,127}$/)
                }),
                azureStorage: joi.object({
                    accountName: joi.string().regex(/^([0-9]|[a-z]|[A-Z]|-){3,31}$/),
112
                    azureShare: joi.string().regex(/^([0-9]|[a-z]|[A-Z]|-){3,63}$/)
113
114
                }),
                uploadRetryCount: joi.number().min(1)
115
            }),
chicm-ms's avatar
chicm-ms committed
116
            frameworkcontroller_config: joi.object({ // eslint-disable-line @typescript-eslint/camelcase
117
                storage: joi.string().min(1),
118
                serviceAccountName: joi.string().min(1),
119
120
121
122
123
124
125
126
127
128
                nfs: joi.object({
                    server: joi.string().min(1).required(),
                    path: joi.string().min(1).required()
                }),
                keyVault: joi.object({
                    vaultName: joi.string().regex(/^([0-9]|[a-z]|[A-Z]|-){1,127}$/),
                    name: joi.string().regex(/^([0-9]|[a-z]|[A-Z]|-){1,127}$/)
                }),
                azureStorage: joi.object({
                    accountName: joi.string().regex(/^([0-9]|[a-z]|[A-Z]|-){3,31}$/),
SparkSnail's avatar
SparkSnail committed
129
                    azureShare: joi.string().regex(/^([0-9]|[a-z]|[A-Z]|-){3,63}$/)
130
131
                }),
                uploadRetryCount: joi.number().min(1)
132
            }),
chicm-ms's avatar
chicm-ms committed
133
            nni_manager_ip: joi.object({ // eslint-disable-line @typescript-eslint/camelcase
134
                nniManagerIp: joi.string().min(1)
135
136
137
138
139
140
            })
        }
    };
    export const STARTEXPERIMENT = {
        body: {
            experimentName: joi.string().required(),
141
            description: joi.string(),
142
143
144
            authorName: joi.string(),
            maxTrialNum: joi.number().min(0).required(),
            trialConcurrency: joi.number().min(0).required(),
145
            trainingServicePlatform: joi.string(),
146
147
            searchSpace: joi.string().required(),
            maxExecDuration: joi.number().min(0).required(),
chicm-ms's avatar
chicm-ms committed
148
            multiPhase: joi.boolean(),
chicm-ms's avatar
chicm-ms committed
149
            multiThread: joi.boolean(),
150
            versionCheck: joi.boolean(),
SparkSnail's avatar
SparkSnail committed
151
            logCollection: joi.string(),
QuanluZhang's avatar
QuanluZhang committed
152
            advisor: joi.object({
Shufan Huang's avatar
Shufan Huang committed
153
                builtinAdvisorName: joi.string().valid('Hyperband', 'BOHB'),
QuanluZhang's avatar
QuanluZhang committed
154
155
156
                codeDir: joi.string(),
                classFileName: joi.string(),
                className: joi.string(),
chicm-ms's avatar
chicm-ms committed
157
                classArgs: joi.any(),
158
159
                checkpointDir: joi.string().allow(''),
                gpuIndices: joi.string()
QuanluZhang's avatar
QuanluZhang committed
160
            }),
161
            tuner: joi.object({
162
                builtinTunerName: joi.string().valid('TPE', 'Random', 'Anneal', 'Evolution', 'SMAC', 'BatchTuner', 'GridSearch', 'NetworkMorphism', 'MetisTuner', 'GPTuner', 'PPOTuner'),
163
164
165
166
                codeDir: joi.string(),
                classFileName: joi.string(),
                className: joi.string(),
                classArgs: joi.any(),
167
                checkpointDir: joi.string().allow(''),
168
169
                includeIntermediateResults: joi.boolean(),
                gpuIndices: joi.string()
QuanluZhang's avatar
QuanluZhang committed
170
            }),
171
            assessor: joi.object({
172
                builtinAssessorName: joi.string().valid('Medianstop', 'Curvefitting'),
173
174
175
176
                codeDir: joi.string(),
                classFileName: joi.string(),
                className: joi.string(),
                classArgs: joi.any(),
chicm-ms's avatar
chicm-ms committed
177
                checkpointDir: joi.string().allow('')
178
179
180
181
182
183
184
185
186
            }),
            clusterMetaData: joi.array().items(joi.object({
                key: joi.string(),
                value: joi.any()
            }))
        }
    };
    export const UPDATEEXPERIMENT = {
        query: {
chicm-ms's avatar
chicm-ms committed
187
            /* eslint-disable-next-line @typescript-eslint/camelcase */
QuanluZhang's avatar
QuanluZhang committed
188
            update_type: joi.string().required().valid('TRIAL_CONCURRENCY', 'MAX_EXEC_DURATION', 'SEARCH_SPACE', 'MAX_TRIAL_NUM')
189
190
191
192
        },
        body: {
            id: joi.string().required(),
            revision: joi.number().min(0).required(),
chicm-ms's avatar
chicm-ms committed
193
            params: joi.object(STARTEXPERIMENT.body),
194
195
            execDuration: joi.number().required(),
            startTime: joi.number(),
chicm-ms's avatar
chicm-ms committed
196
197
            endTime: joi.number(),
            logDir: joi.string(),
198
            nextSequenceId: joi.number()
199
200
201
        }
    };
}