restValidationSchemas.ts 9.84 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
                username: joi.string().required(),
13
                ip: joi.string().hostname().required(),
14
                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
40
                nniManagerNFSMountPath: joi.string().min(1),
                containerNFSMountPath: joi.string().min(1),
SparkSnail's avatar
SparkSnail committed
41
                paiConfigPath: joi.string(),
42
                paiStorageConfigName: joi.string().min(1),
43
                nasMode: joi.string().valid('classic_mode', 'enas_mode', 'oneshot_mode', 'darts_mode'),
44
45
46
47
48
                portList: joi.array().items(joi.object({
                    label: joi.string().required(),
                    beginAt: joi.number().required(),
                    portNumber: joi.number().required(),
                })),
49
50
51
                worker: joi.object({
                    replicas: joi.number().min(1).required(),
                    image: joi.string().min(1),
52
                    privateRegistryAuthPath: joi.string().min(1),
53
54
55
56
57
58
59
60
61
                    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),
62
                        privateRegistryAuthPath: joi.string().min(1),
63
64
65
66
67
                        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()
68
69
70
71
                }),
                master: joi.object({
                    replicas: joi.number().min(1).required(),
                    image: joi.string().min(1),
72
                    privateRegistryAuthPath: joi.string().min(1),
73
74
75
76
77
                    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()
78
79
80
81
82
                }),
                taskRoles: joi.array({
                    name: joi.string().min(1),
                    taskNum: joi.number().min(1).required(),
                    image: joi.string().min(1),
83
                    privateRegistryAuthPath: joi.string().min(1),
84
85
86
                    outputDir: joi.string(),
                    cpuNum: joi.number().min(1),
                    memoryMB: joi.number().min(100),
87
                    shmMB: joi.number(),
88
89
90
91
92
93
                    gpuNum: joi.number().min(0).required(),
                    command: joi.string().min(1).required(),
                    frameworkAttemptCompletionPolicy: joi.object({
                        minFailedTaskCount: joi.number(),
                        minSucceededTaskCount: joi.number()
                    })
94
                })
95
            }),
96
            pai_yarn_config: joi.object({ // eslint-disable-line @typescript-eslint/camelcase
97
                userName: joi.string().min(1).required(),
98
99
                passWord: joi.string().min(1),
                token: joi.string().min(1),
100
                host: joi.string().min(1).required()
101
            }),
102
103
104
105
106
            pai_config: joi.object({ // eslint-disable-line @typescript-eslint/camelcase
                userName: joi.string().min(1).required(),
                passWord: joi.string().min(1),
                token: joi.string().min(1),
                host: joi.string().min(1).required(),
107
                reuse: joi.boolean(),
108
            }),
chicm-ms's avatar
chicm-ms committed
109
            kubeflow_config: joi.object({ // eslint-disable-line @typescript-eslint/camelcase
110
                operator: joi.string().min(1).required(),
111
                storage: joi.string().min(1),
112
                apiVersion: joi.string().min(1),
113
114
115
                nfs: joi.object({
                    server: joi.string().min(1).required(),
                    path: joi.string().min(1).required()
SparkSnail's avatar
SparkSnail committed
116
117
118
119
120
121
122
                }),
                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}$/),
123
                    azureShare: joi.string().regex(/^([0-9]|[a-z]|[A-Z]|-){3,63}$/)
124
125
                }),
                uploadRetryCount: joi.number().min(1)
126
            }),
chicm-ms's avatar
chicm-ms committed
127
            frameworkcontroller_config: joi.object({ // eslint-disable-line @typescript-eslint/camelcase
128
                storage: joi.string().min(1),
129
                serviceAccountName: joi.string().min(1),
130
131
132
133
134
135
136
137
138
139
                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
140
                    azureShare: joi.string().regex(/^([0-9]|[a-z]|[A-Z]|-){3,63}$/)
141
142
                }),
                uploadRetryCount: joi.number().min(1)
143
            }),
George Cheng's avatar
George Cheng committed
144
145
146
147
148
149
150
151
152
            dlts_config: joi.object({ // eslint-disable-line @typescript-eslint/camelcase
                dashboard: joi.string().min(1),
              
                cluster: joi.string().min(1),
                team: joi.string().min(1),
              
                email: joi.string().min(1),
                password: joi.string().min(1)
            }),
chicm-ms's avatar
chicm-ms committed
153
            nni_manager_ip: joi.object({ // eslint-disable-line @typescript-eslint/camelcase
154
                nniManagerIp: joi.string().min(1)
155
156
157
158
159
160
            })
        }
    };
    export const STARTEXPERIMENT = {
        body: {
            experimentName: joi.string().required(),
161
            description: joi.string(),
162
163
164
            authorName: joi.string(),
            maxTrialNum: joi.number().min(0).required(),
            trialConcurrency: joi.number().min(0).required(),
165
            trainingServicePlatform: joi.string(),
166
167
            searchSpace: joi.string().required(),
            maxExecDuration: joi.number().min(0).required(),
chicm-ms's avatar
chicm-ms committed
168
            multiPhase: joi.boolean(),
chicm-ms's avatar
chicm-ms committed
169
            multiThread: joi.boolean(),
170
            versionCheck: joi.boolean(),
SparkSnail's avatar
SparkSnail committed
171
            logCollection: joi.string(),
QuanluZhang's avatar
QuanluZhang committed
172
            advisor: joi.object({
chicm-ms's avatar
chicm-ms committed
173
                builtinAdvisorName: joi.string(),
QuanluZhang's avatar
QuanluZhang committed
174
175
176
                codeDir: joi.string(),
                classFileName: joi.string(),
                className: joi.string(),
chicm-ms's avatar
chicm-ms committed
177
                classArgs: joi.any(),
178
179
                checkpointDir: joi.string().allow(''),
                gpuIndices: joi.string()
QuanluZhang's avatar
QuanluZhang committed
180
            }),
181
            tuner: joi.object({
chicm-ms's avatar
chicm-ms committed
182
                builtinTunerName: joi.string(),
183
184
185
186
                codeDir: joi.string(),
                classFileName: joi.string(),
                className: joi.string(),
                classArgs: joi.any(),
187
                checkpointDir: joi.string().allow(''),
188
189
                includeIntermediateResults: joi.boolean(),
                gpuIndices: joi.string()
QuanluZhang's avatar
QuanluZhang committed
190
            }),
191
            assessor: joi.object({
chicm-ms's avatar
chicm-ms committed
192
                builtinAssessorName: joi.string(),
193
194
195
196
                codeDir: joi.string(),
                classFileName: joi.string(),
                className: joi.string(),
                classArgs: joi.any(),
chicm-ms's avatar
chicm-ms committed
197
                checkpointDir: joi.string().allow('')
198
199
200
201
202
203
204
205
206
            }),
            clusterMetaData: joi.array().items(joi.object({
                key: joi.string(),
                value: joi.any()
            }))
        }
    };
    export const UPDATEEXPERIMENT = {
        query: {
chicm-ms's avatar
chicm-ms committed
207
            /* eslint-disable-next-line @typescript-eslint/camelcase */
QuanluZhang's avatar
QuanluZhang committed
208
            update_type: joi.string().required().valid('TRIAL_CONCURRENCY', 'MAX_EXEC_DURATION', 'SEARCH_SPACE', 'MAX_TRIAL_NUM')
209
210
211
212
        },
        body: {
            id: joi.string().required(),
            revision: joi.number().min(0).required(),
chicm-ms's avatar
chicm-ms committed
213
            params: joi.object(STARTEXPERIMENT.body),
214
215
            execDuration: joi.number().required(),
            startTime: joi.number(),
chicm-ms's avatar
chicm-ms committed
216
217
            endTime: joi.number(),
            logDir: joi.string(),
218
            nextSequenceId: joi.number()
219
220
221
        }
    };
}