-
Notifications
You must be signed in to change notification settings - Fork 71
Expand file tree
/
Copy pathindex.html
More file actions
474 lines (472 loc) · 26.4 KB
/
index.html
File metadata and controls
474 lines (472 loc) · 26.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
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
462
463
464
465
466
467
468
469
470
471
472
473
474
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>EvalAI</title>
<link rel="shortcut icon" type="image/png" href="./assets/favicon.png" />
<link href="./assets/bootstrap.min.css" rel="stylesheet">
<link href="./assets/evalai.css" rel="stylesheet">
<link rel="stylesheet" href="./assets/gh-fork-ribbon.min.css">
<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,500i" rel="stylesheet">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.1/css/all.css" integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous">
<link href="./assets/github-markdown.css" rel="stylesheet">
</head>
<body id="home" data-gr-c-s-loaded="true">
<i onclick="topFunction()" class="fas fa-arrow-up" id="up-arrow"></i>
<header>
<div class="logo">
<a href="/" style="float: left;"><img style="height: 40px;" src="https://evalai.cloudcv.org/dist/images/evalai-logo-single.png"></a>
<a href="/" class="header-evalai">EvalAI</a>
</div>
<!-- <a class="btn" href="">Docs</a> -->
<ul class="primary-nav">
<li><a class="github fw-300" href="https://evalai-forum.cloudcv.org/" target="_blank">Forum</a></li>
<li><a class="support fw-300" href="https://evalai.cloudcv.org/contact" target="_blank">Contact Us</a></li>
<li><a class="github fw-300" href="https://github.com/Cloud-CV/EvalAI-CLI" target="_blank">GitHub</a></li>
</ul>
</header>
<div class="jumbotron jumbotron-style">
<div class="container container-style">
<h1 id="title-style">Use EvalAI through command line</h1>
<p>Make submissions to a challenge with a single command</p>
<p>Check the real-time status of your submissions through your terminal</p>
<a id="main-button" class="btn btn-hero btn-style">See Examples</a>
<a href="https://github.com/Cloud-CV/EvalAI-CLI"><img class="a-style" src="./assets/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f7265645f6161303030302e706e67"
alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"></a>
</div>
</div>
<section class="install-wizard wrap section-style">
<div class="container">
<div class="row">
<div class="col-md-8">
<h3>What is EvalAI-CLI?</h3>
</div>
</div>
<article class="markdown-body">
<p>EvalAI-CLI is designed to extend the functionality of the EvalAI web application to your command
line to make the platform more accessible and terminal-friendly to its users.
</p>
</article>
</div>
</section>
<section class="install-wizard wrap">
<div class="container">
<div class="row">
<div class="col-md-5">
<h3>Get Started</h3>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4><b>Install EvalAI from <a href="https://pypi.org/project/evalai/" target="_blank">PyPI</a></b></h4>
<br>
</div>
</div>
<div class="command">
<div class="label">Run this command</div>
<div class="text">
<span id="installEvalAI">pip install evalai</span>
<a class="copy-btn" onclick="CopyToClipboard('installEvalAI')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4><b>Configure your Auth Token</b></h4>
<br>
</div>
</div>
<div class="command">
<div class="label">Run this command</div>
<div class="text">
<span id="setToken"> evalai set_token <auth_token> </span>
<a class="copy-btn" onclick="CopyToClipboard('setToken')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4><b>View your Auth Token</b></h4>
<br>
</div>
</div>
<div class="command">
<div class="label">Run this command</div>
<div class="text">
<span id="getToken">evalai get_token</span>
<a class="copy-btn" onclick="CopyToClipboard('getToken')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
</div>
</section>
<section class="projects-tutorials wrap section-style" id="class-padding">
<div class="container">
<div id="examples" class="row">
<div class="col-md-5">
<h3 id="example-style">Examples</h3>
</div>
</div>
<br id="challenge">
<h3 id="h3-style"><a href="#challenge" class="sub-heading">Challenge</a></h3>
<hr>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Display all challenges</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="viewAllChallenges">evalai challenges</span>
<a class="copy-btn" onclick="CopyToClipboard('viewAllChallenges')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Display all ongoing challenges</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="viewOngoingChallenges">evalai challenges ongoing</span>
<a class="copy-btn" onclick="CopyToClipboard('viewOngoingChallenges')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Display all upcoming challenges</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="upComingChallenge">evalai challenges future</span>
<a class="copy-btn" onclick="CopyToClipboard('upComingChallenge')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Display all past challenges</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="pastChallengeDisplay">evalai challenges past</span>
<a class="copy-btn" onclick="CopyToClipboard('pastChallengeDisplay')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Display details of a challenge with ID 1</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="viewChallengeDetailsWithID">evalai challenge 1</span>
<a class="copy-btn" onclick="CopyToClipboard('viewChallengeDetailsWithID')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Display all challenges that you've participated in</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="participatedChallenge">evalai challenges --participant</span>
<a class="copy-btn" onclick="CopyToClipboard('participatedChallenge')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Display all challenges that you've hosted</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="hostedChallenges">evalai challenges --host</span>
<a class="copy-btn" onclick="CopyToClipboard('hostedChallenges')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<br id="challenge-phase">
<h3 id="h3-style"><a href="#challenge-phase" class="sub-heading">Challenge Phase</a></h3>
<hr>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Display all challenge phases of the challenge with
Challenge ID
1</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="phasesDisplay">evalai challenge 1 phases</span>
<a class="copy-btn" onclick="CopyToClipboard('phasesDisplay')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Display the details of the phase with ID 4 of the challenge
with ID 1</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="viewPhaseDetails">evalai challenge 1 phase 4</span>
<a class="copy-btn" onclick="CopyToClipboard('viewPhaseDetails')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<br id="teams">
<h3 id="h3-style"><a href="#teams" class="sub-heading">Teams</a></h3>
<hr>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Participate in a challenge with ID 1 and team ID 2</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="participateInChallenge">evalai challenge 1 participate 2</span>
<a class="copy-btn" onclick="CopyToClipboard('participateInChallenge')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>View your participant teams</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="viewParticipantTeams">evalai teams --participant</span>
<a class="copy-btn" onclick="CopyToClipboard('viewParticipantTeams')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>View your host teams</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="viewHostTeams">evalai teams --host</span>
<a class="copy-btn" onclick="CopyToClipboard('viewHostTeams')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Create a participant team</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="createParticipantTeam">evalai teams create participant</span>
<a class="copy-btn" onclick="CopyToClipboard('createParticipantTeam')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Create a host team</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="createHostTeam">evalai teams create host</span>
<a class="copy-btn" onclick="CopyToClipboard('createHostTeam')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<br id="leaderboard">
<h3 id="h3-style"><a href="#leaderboard" class="sub-heading">Leaderboards and Submissions</a></h3>
<hr>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Make a submission to the Phase 4 of a challenge with ID 1</b></h4>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>If Challenge 1 is Docker based</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="makeDockerSubmission">evalai push <image:tag> -p 4 </span>
<a class="copy-btn" onclick="CopyToClipboard('makeDockerSubmission')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>If Challenge 1 is not Docker based</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="makeSubmission">evalai challenge 1 phase 4 submit --file submission.json</span>
<a class="copy-btn" onclick="CopyToClipboard('makeSubmission')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>View status of a submission with ID 78</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="viewSubmissionWithID">evalai submission 78</span>
<a class="copy-btn" onclick="CopyToClipboard('viewSubmissionWithID')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>View stderr file of a submission with ID 78</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this comand</div>
<div class="text codebg">
<span id="viewSubmissionStderrWithID">evalai submission 78 stderr</span>
<a class="copy-btn" onclick="CopyToClipboard('viewSubmissionStderrWithID')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Get all the phase splits of the challenge 1 with phase 4</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="viewPhaseSplits">evalai challenge 1 phase 4 splits</span>
<a class="copy-btn" onclick="CopyToClipboard('viewPhaseSplits')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>View the leaderboard of Challenge 1 with Challenge Phase
Split
4</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="viewLeaderboard">evalai challenge 1 leaderboard 4</span>
<a class="copy-btn" onclick="CopyToClipboard('viewLeaderboard')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>View all the submissions to Phase 4 of the challenge 1</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="viewPhaseSubmissions">evalai challenge 1 phase 4 submissions</span>
<a class="copy-btn" onclick="CopyToClipboard('viewPhaseSubmissions')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>View all the submissions to Phase 4 of the challenge 1
between
06/15/18 and 06/25/18</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="viewSubmissionBetweenDates">evalai challenge 1 phase 4 submissions -s 06/15/18 -e 06/25/18</span>
<a class="copy-btn" onclick="CopyToClipboard('viewSubmissionBetweenDates')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<br id="custom-backend">
<h3 id="h3-style"><a href="#custom-backend" class="sub-heading">Configure your custom backend</a></h3>
<hr>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>Configure the Host URL (OPTIONAL)</b></h4>
<p>Only run the following command if you want to use CLI with your forked version of EvalAI.</p>
</div>
</div>
<div class="command">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="configureHost">evalai host -sh https://evalapi.cloudcv.org</span>
<a class="copy-btn" onclick="CopyToClipboard('configureHost')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div>
<!-- <h3 id="h3-style"><a href="#statistics" class="sub-heading">Statistics</a></h3>
<hr>
<div class="row">
<div class="col-md-12" id="code-label">
<h4 class="code-container-style"><b>View stats of your hosted challenge with ID 12</b></h4>
</div>
</div>
<div class="command code-margin">
<div class="label">Run this command</div>
<div class="text codebg">
<span id="viewStats">evalai challenge 12 stats</span>
<a class="copy-btn" onclick="CopyToClipboard('viewStats')" data-toggle="tooltip" data-placement="top" title="copy to clipboard"><i class="fas fa-copy"></i>
</a>
</div>
</div> -->
</div>
</section>
<footer>
<div class="left">
<div class="logo">
<a id="footer-pos" href="https://evalai.cloudcv.org" target="_blank"><img id="img-pos" src="https://evalai.cloudcv.org/dist/images/evalai-logo-single.png"></a>
</div>
<p id="footer-margin">
Maintained by EvalAI Team
<br> ©<script>new Date().getFullYear()&&document.write(new Date().getFullYear());</script> EvalAI
</p>
</div>
</footer>
<script src="./assets/jquery.min.js"></script>
<script src="./assets/bootstrap.min.js"></script>
<script src="./assets/active.js"></script>
<script src="./assets/notify.min.js"></script>
</body>
</html>