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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
|
%global _empty_manifest_terminate_build 0
Name: python-numerai-cli
Version: 0.3.5
Release: 1
Summary: A library for deploying Numer.ai Prediction Nodes.
License: MIT
URL: https://github.com/numerai/numerai-cli
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/26/4f/d60724a4d7e2858941fea3b203e3dd80703a4a48f4aa39cc9c9aeb9f2886/numerai-cli-0.3.5.tar.gz
BuildArch: noarch
Requires: python3-click
Requires: python3-boto3
Requires: python3-numerapi
Requires: python3-colorama
Requires: python3-requests
%description
# numerai-cli
[](https://circleci.com/gh/numerai/numerai-cli)
[](https://pypi.org/project/numerai-cli/)
Welcome to the Numerai CLI for the [Numerai Tournament](https://docs.numer.ai/tournament/learn).
This CLI runs on your local computer to configure a Numerai Prediction Node in the cloud.
This solution is architected to cost less than $5/mo on average, but actual costs may vary.
It has been tested and found working on MacOS/OSX, Windows 8/10, and Ubuntu 18/20,
but should theoretically work anywhere that Docker and Python 3 are available.
If you have any problems, questions, comments, concerns, or general feedback, please refer to the
[Troubleshooting and Feedback](#troubleshooting-and-feedback) before posting anywhere.
## Contents
- [Getting Started](#getting-started)
- [Node Configuration Tutorial](#node-configuration)
- [List of Commands](#list-of-commands)
- [Troubleshooting and Feedback](#troubleshooting-and-feedback)
- [Upgrading to 0.3.0](#upgrading-to-030)
- [Uninstall](#uninstall)
## Getting Started
1. Sign up a Numerai Account, get your Numerai API Keys, and your first Model:
1. Sign up at https://numer.ai/signup and log in to your new account
2. Go to https://numer.ai/account > "Your API keys" section > click "Add"
3. Name your key and check all boxes under "Scope this key will have"
4. Enter your password and click "Confirm"
5. Copy your secret public key and secret key somewhere safe
2. Pick a Cloud Provider and follow the setup directions (Currently we only support AWS):
- [Amazon Web Services Setup Instructions](https://github.com/numerai/numerai-cli/wiki/Amazon-Web-Services)
3. Install Docker and Python for your Operating System (if you encounter errors or your
OS is not supported, please [read the troubleshooting wiki](
https://github.com/numerai/numerai-cli/wiki/Troubleshooting) to install Python and Docker):
- Mac Terminal (cmd + space, type `terminal`, select `terminal.app`):
```
curl https://raw.githubusercontent.com/numerai/numerai-cli/master/scripts/setup-mac.sh | bash
```
- Ubuntu 18/20 Terminal (ctrl + alt + t):
```
sudo apt update && sudo apt install -y libcurl4 curl && sudo curl https://raw.githubusercontent.com/numerai/numerai-cli/master/scripts/setup-ubu.sh | sudo bash
```
- Windows 10 Command Prompt (windows key, type `cmd`, select Command Prompt):
```
powershell -command "$Script = Invoke-WebRequest 'https://raw.githubusercontent.com/numerai/numerai-cli/master/scripts/setup-win10.ps1'; $ScriptBlock = [ScriptBlock]::Create($Script.Content); Invoke-Command -ScriptBlock $ScriptBlock"
```
4. After the setup script confirms Python and Docker, install `numerai-cli` via:
```
pip3 install --upgrade numerai-cli --user
```
NOTES:
- This command will also work to update to new versions of the package in the future.
- If you are using python venv then drop the --user option.
If you don't know what that is, disregard this note.
## Node Configuration Tutorial
If you know you have all the prerequisites and have your AWS and Numerai API Keys at hand,
you can run these commands on your local computer to get an example node running in minutes:
```
numerai setup
numerai node config --example tournament-python3
numerai node deploy
numerai node test
```
If you want to use larger instances to generate your predictions first run `numerai list-constants`
to list the vCPU/mem presets available, then you can configure a node to use one of the presets via:
```
numerai node config -s mem-lg
```
Your compute node is now setup and ready to run!
**VERY IMPORTANT**
These commands have stored configuration files in `$USER_HOME/.numerai/`.
If you lose this directory without destroying your nodes,
you will have to manually (and painfully) delete every cloud resource by hand,
so make sure you backup these files regularly!
DO NOT USE THESE COMMANDS FROM A TEMPORARY INSTANCE!!!!
The example node will train and predict in the cloud, but this is inefficient.
It's usually best to train your model locally (ensuring that the trained model is
stored in the same folder as your code) and then deploy the trained model.
When you make changes to your code or re-train your model, simply deploy and test your node again:
```
numerai node deploy
numerai node test
```
The `nodes.json` file also includes the url for your Node Trigger.
This trigger is registered with whichever model you specified during configuration.
Each trigger will be called Saturday morning right after a new round opens,
and if the related job fails it will be triggered again around 24 hours later.
You can opt into compute for daily tournaments via the website (go to numer.ai/models,
click the 3 dots next to your model, click "compute", and click the switch to opt in).
NOTES:
- The default example does _not_ make stake changes; you will still have to do that manually.
Please refer to the [numerapi docs](https://numerapi.readthedocs.io/en/latest/api/numerapi.html#module-numerapi.numerapi)
for the methods you must call to do this.
- You can view resources and logs in the AWS Console (region us-east-1) for your
[ECS Cluster](https://console.aws.amazon.com/ecs/home?region=us-east-1#/clusters/numerai-submission-ecs-cluster/tasks)
and [other resources](https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logsV2:log-groups)
NEXT: [read the Prediction Nodes wiki](https://github.com/numerai/numerai-cli/wiki/Prediction-Nodes)
to learn about Numerai Examples and how to customize Prediction Nodes.
## List of Commands
Use the `--help` option on any command or sub-command to get a full description of it:
```
numerai
numerai --help
numerai [command] --help
numerai [command] [sub-command] --help
```
Each command or sub-command takes its own options, for example if you want to copy the
numerai signals example and configure a node for a signals model with large memory
requirements you'd use something like this (replacing [MODEL NAME] with the relevant
signals model name):
```
numerai node -m [MODEL NAME] -s config -s mem-lg -e signals-python3
```
Here, the `node` command takes a model name with `-m` and a flag `-s` to detect if it's
a signals model or numerai model. The `config` sub-command also takes a `-s` option to
specify the size of the node to configure.
## Troubleshooting and Feedback
Before messaging the Rocketchat channel or creating a Github issue,
please read through the following (especially the "Troubleshooting" section in the wiki):
- [Github Wiki](https://github.com/numerai/numerai-cli/wiki)
- [Github Issues](https://github.com/numerai/numerai-cli/issues)
If you still cannot find a solution or answer, please join us on the
[RocketChat #support Channel](https://rocketchat.numer.ai/channel/support)
and include the following information with your issue/message:
- The commands you ran that caused the error (even previous commands)
- Version information from running:
- `pip3 show numerai-cli`
- `python -V`
- `docker -v`
- System Information from running
- Mac: `system_profiler SPSoftwareDataType && system_profiler SPHardwareDataType`
- Linux: `lsb_release -a && uname -a`
- Windows: `powershell -command "Get-ComputerInfo"`
If you do not include this information, we cannot help you.
## Upgrading and Updating
Upgrading numerai-cli will always require you to update the package itself using pip:
```
pip install --upgrade numerai-cli --user
```
#### 0.1/0.2 -> 0.3.0
CLI 0.3.0 uses a new configuration format that is incompatible with versions 0.1 and 0.2,
but a command to migrate you configuration is provided for you. Run this in the directory
you ran `numerai setup` from the previous version:
```
numerai upgrade
```
#### Beyond
Some updates will make changes to configuration files used by Numerai CLI. These will
require you to re-run some commands to upgrade your nodes to the newest versions:
- `numerai setup` will copy over changes to files in the `$HOME/.numerai` directory
- `numerai node config` will apply those changes to a node
## Uninstall
```
numerai uninstall
```
## Contributions
- Thanks to [uuazed](https://github.com/uuazed) for their work on [numerapi](https://github.com/uuazed/numerapi)
- Thanks to [hellno](https://github.com/hellno) for starting the Signals [ticker map](https://github.com/hellno/numerai-signals-tickermap)
- Thanks to tit_BTCQASH ([numerai profile](https://numer.ai/tit_btcqash) and [twitter profile](https://twitter.com/tit_BTCQASH)) for debugging the environment setup process on Windows 8
%package -n python3-numerai-cli
Summary: A library for deploying Numer.ai Prediction Nodes.
Provides: python-numerai-cli
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-numerai-cli
# numerai-cli
[](https://circleci.com/gh/numerai/numerai-cli)
[](https://pypi.org/project/numerai-cli/)
Welcome to the Numerai CLI for the [Numerai Tournament](https://docs.numer.ai/tournament/learn).
This CLI runs on your local computer to configure a Numerai Prediction Node in the cloud.
This solution is architected to cost less than $5/mo on average, but actual costs may vary.
It has been tested and found working on MacOS/OSX, Windows 8/10, and Ubuntu 18/20,
but should theoretically work anywhere that Docker and Python 3 are available.
If you have any problems, questions, comments, concerns, or general feedback, please refer to the
[Troubleshooting and Feedback](#troubleshooting-and-feedback) before posting anywhere.
## Contents
- [Getting Started](#getting-started)
- [Node Configuration Tutorial](#node-configuration)
- [List of Commands](#list-of-commands)
- [Troubleshooting and Feedback](#troubleshooting-and-feedback)
- [Upgrading to 0.3.0](#upgrading-to-030)
- [Uninstall](#uninstall)
## Getting Started
1. Sign up a Numerai Account, get your Numerai API Keys, and your first Model:
1. Sign up at https://numer.ai/signup and log in to your new account
2. Go to https://numer.ai/account > "Your API keys" section > click "Add"
3. Name your key and check all boxes under "Scope this key will have"
4. Enter your password and click "Confirm"
5. Copy your secret public key and secret key somewhere safe
2. Pick a Cloud Provider and follow the setup directions (Currently we only support AWS):
- [Amazon Web Services Setup Instructions](https://github.com/numerai/numerai-cli/wiki/Amazon-Web-Services)
3. Install Docker and Python for your Operating System (if you encounter errors or your
OS is not supported, please [read the troubleshooting wiki](
https://github.com/numerai/numerai-cli/wiki/Troubleshooting) to install Python and Docker):
- Mac Terminal (cmd + space, type `terminal`, select `terminal.app`):
```
curl https://raw.githubusercontent.com/numerai/numerai-cli/master/scripts/setup-mac.sh | bash
```
- Ubuntu 18/20 Terminal (ctrl + alt + t):
```
sudo apt update && sudo apt install -y libcurl4 curl && sudo curl https://raw.githubusercontent.com/numerai/numerai-cli/master/scripts/setup-ubu.sh | sudo bash
```
- Windows 10 Command Prompt (windows key, type `cmd`, select Command Prompt):
```
powershell -command "$Script = Invoke-WebRequest 'https://raw.githubusercontent.com/numerai/numerai-cli/master/scripts/setup-win10.ps1'; $ScriptBlock = [ScriptBlock]::Create($Script.Content); Invoke-Command -ScriptBlock $ScriptBlock"
```
4. After the setup script confirms Python and Docker, install `numerai-cli` via:
```
pip3 install --upgrade numerai-cli --user
```
NOTES:
- This command will also work to update to new versions of the package in the future.
- If you are using python venv then drop the --user option.
If you don't know what that is, disregard this note.
## Node Configuration Tutorial
If you know you have all the prerequisites and have your AWS and Numerai API Keys at hand,
you can run these commands on your local computer to get an example node running in minutes:
```
numerai setup
numerai node config --example tournament-python3
numerai node deploy
numerai node test
```
If you want to use larger instances to generate your predictions first run `numerai list-constants`
to list the vCPU/mem presets available, then you can configure a node to use one of the presets via:
```
numerai node config -s mem-lg
```
Your compute node is now setup and ready to run!
**VERY IMPORTANT**
These commands have stored configuration files in `$USER_HOME/.numerai/`.
If you lose this directory without destroying your nodes,
you will have to manually (and painfully) delete every cloud resource by hand,
so make sure you backup these files regularly!
DO NOT USE THESE COMMANDS FROM A TEMPORARY INSTANCE!!!!
The example node will train and predict in the cloud, but this is inefficient.
It's usually best to train your model locally (ensuring that the trained model is
stored in the same folder as your code) and then deploy the trained model.
When you make changes to your code or re-train your model, simply deploy and test your node again:
```
numerai node deploy
numerai node test
```
The `nodes.json` file also includes the url for your Node Trigger.
This trigger is registered with whichever model you specified during configuration.
Each trigger will be called Saturday morning right after a new round opens,
and if the related job fails it will be triggered again around 24 hours later.
You can opt into compute for daily tournaments via the website (go to numer.ai/models,
click the 3 dots next to your model, click "compute", and click the switch to opt in).
NOTES:
- The default example does _not_ make stake changes; you will still have to do that manually.
Please refer to the [numerapi docs](https://numerapi.readthedocs.io/en/latest/api/numerapi.html#module-numerapi.numerapi)
for the methods you must call to do this.
- You can view resources and logs in the AWS Console (region us-east-1) for your
[ECS Cluster](https://console.aws.amazon.com/ecs/home?region=us-east-1#/clusters/numerai-submission-ecs-cluster/tasks)
and [other resources](https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logsV2:log-groups)
NEXT: [read the Prediction Nodes wiki](https://github.com/numerai/numerai-cli/wiki/Prediction-Nodes)
to learn about Numerai Examples and how to customize Prediction Nodes.
## List of Commands
Use the `--help` option on any command or sub-command to get a full description of it:
```
numerai
numerai --help
numerai [command] --help
numerai [command] [sub-command] --help
```
Each command or sub-command takes its own options, for example if you want to copy the
numerai signals example and configure a node for a signals model with large memory
requirements you'd use something like this (replacing [MODEL NAME] with the relevant
signals model name):
```
numerai node -m [MODEL NAME] -s config -s mem-lg -e signals-python3
```
Here, the `node` command takes a model name with `-m` and a flag `-s` to detect if it's
a signals model or numerai model. The `config` sub-command also takes a `-s` option to
specify the size of the node to configure.
## Troubleshooting and Feedback
Before messaging the Rocketchat channel or creating a Github issue,
please read through the following (especially the "Troubleshooting" section in the wiki):
- [Github Wiki](https://github.com/numerai/numerai-cli/wiki)
- [Github Issues](https://github.com/numerai/numerai-cli/issues)
If you still cannot find a solution or answer, please join us on the
[RocketChat #support Channel](https://rocketchat.numer.ai/channel/support)
and include the following information with your issue/message:
- The commands you ran that caused the error (even previous commands)
- Version information from running:
- `pip3 show numerai-cli`
- `python -V`
- `docker -v`
- System Information from running
- Mac: `system_profiler SPSoftwareDataType && system_profiler SPHardwareDataType`
- Linux: `lsb_release -a && uname -a`
- Windows: `powershell -command "Get-ComputerInfo"`
If you do not include this information, we cannot help you.
## Upgrading and Updating
Upgrading numerai-cli will always require you to update the package itself using pip:
```
pip install --upgrade numerai-cli --user
```
#### 0.1/0.2 -> 0.3.0
CLI 0.3.0 uses a new configuration format that is incompatible with versions 0.1 and 0.2,
but a command to migrate you configuration is provided for you. Run this in the directory
you ran `numerai setup` from the previous version:
```
numerai upgrade
```
#### Beyond
Some updates will make changes to configuration files used by Numerai CLI. These will
require you to re-run some commands to upgrade your nodes to the newest versions:
- `numerai setup` will copy over changes to files in the `$HOME/.numerai` directory
- `numerai node config` will apply those changes to a node
## Uninstall
```
numerai uninstall
```
## Contributions
- Thanks to [uuazed](https://github.com/uuazed) for their work on [numerapi](https://github.com/uuazed/numerapi)
- Thanks to [hellno](https://github.com/hellno) for starting the Signals [ticker map](https://github.com/hellno/numerai-signals-tickermap)
- Thanks to tit_BTCQASH ([numerai profile](https://numer.ai/tit_btcqash) and [twitter profile](https://twitter.com/tit_BTCQASH)) for debugging the environment setup process on Windows 8
%package help
Summary: Development documents and examples for numerai-cli
Provides: python3-numerai-cli-doc
%description help
# numerai-cli
[](https://circleci.com/gh/numerai/numerai-cli)
[](https://pypi.org/project/numerai-cli/)
Welcome to the Numerai CLI for the [Numerai Tournament](https://docs.numer.ai/tournament/learn).
This CLI runs on your local computer to configure a Numerai Prediction Node in the cloud.
This solution is architected to cost less than $5/mo on average, but actual costs may vary.
It has been tested and found working on MacOS/OSX, Windows 8/10, and Ubuntu 18/20,
but should theoretically work anywhere that Docker and Python 3 are available.
If you have any problems, questions, comments, concerns, or general feedback, please refer to the
[Troubleshooting and Feedback](#troubleshooting-and-feedback) before posting anywhere.
## Contents
- [Getting Started](#getting-started)
- [Node Configuration Tutorial](#node-configuration)
- [List of Commands](#list-of-commands)
- [Troubleshooting and Feedback](#troubleshooting-and-feedback)
- [Upgrading to 0.3.0](#upgrading-to-030)
- [Uninstall](#uninstall)
## Getting Started
1. Sign up a Numerai Account, get your Numerai API Keys, and your first Model:
1. Sign up at https://numer.ai/signup and log in to your new account
2. Go to https://numer.ai/account > "Your API keys" section > click "Add"
3. Name your key and check all boxes under "Scope this key will have"
4. Enter your password and click "Confirm"
5. Copy your secret public key and secret key somewhere safe
2. Pick a Cloud Provider and follow the setup directions (Currently we only support AWS):
- [Amazon Web Services Setup Instructions](https://github.com/numerai/numerai-cli/wiki/Amazon-Web-Services)
3. Install Docker and Python for your Operating System (if you encounter errors or your
OS is not supported, please [read the troubleshooting wiki](
https://github.com/numerai/numerai-cli/wiki/Troubleshooting) to install Python and Docker):
- Mac Terminal (cmd + space, type `terminal`, select `terminal.app`):
```
curl https://raw.githubusercontent.com/numerai/numerai-cli/master/scripts/setup-mac.sh | bash
```
- Ubuntu 18/20 Terminal (ctrl + alt + t):
```
sudo apt update && sudo apt install -y libcurl4 curl && sudo curl https://raw.githubusercontent.com/numerai/numerai-cli/master/scripts/setup-ubu.sh | sudo bash
```
- Windows 10 Command Prompt (windows key, type `cmd`, select Command Prompt):
```
powershell -command "$Script = Invoke-WebRequest 'https://raw.githubusercontent.com/numerai/numerai-cli/master/scripts/setup-win10.ps1'; $ScriptBlock = [ScriptBlock]::Create($Script.Content); Invoke-Command -ScriptBlock $ScriptBlock"
```
4. After the setup script confirms Python and Docker, install `numerai-cli` via:
```
pip3 install --upgrade numerai-cli --user
```
NOTES:
- This command will also work to update to new versions of the package in the future.
- If you are using python venv then drop the --user option.
If you don't know what that is, disregard this note.
## Node Configuration Tutorial
If you know you have all the prerequisites and have your AWS and Numerai API Keys at hand,
you can run these commands on your local computer to get an example node running in minutes:
```
numerai setup
numerai node config --example tournament-python3
numerai node deploy
numerai node test
```
If you want to use larger instances to generate your predictions first run `numerai list-constants`
to list the vCPU/mem presets available, then you can configure a node to use one of the presets via:
```
numerai node config -s mem-lg
```
Your compute node is now setup and ready to run!
**VERY IMPORTANT**
These commands have stored configuration files in `$USER_HOME/.numerai/`.
If you lose this directory without destroying your nodes,
you will have to manually (and painfully) delete every cloud resource by hand,
so make sure you backup these files regularly!
DO NOT USE THESE COMMANDS FROM A TEMPORARY INSTANCE!!!!
The example node will train and predict in the cloud, but this is inefficient.
It's usually best to train your model locally (ensuring that the trained model is
stored in the same folder as your code) and then deploy the trained model.
When you make changes to your code or re-train your model, simply deploy and test your node again:
```
numerai node deploy
numerai node test
```
The `nodes.json` file also includes the url for your Node Trigger.
This trigger is registered with whichever model you specified during configuration.
Each trigger will be called Saturday morning right after a new round opens,
and if the related job fails it will be triggered again around 24 hours later.
You can opt into compute for daily tournaments via the website (go to numer.ai/models,
click the 3 dots next to your model, click "compute", and click the switch to opt in).
NOTES:
- The default example does _not_ make stake changes; you will still have to do that manually.
Please refer to the [numerapi docs](https://numerapi.readthedocs.io/en/latest/api/numerapi.html#module-numerapi.numerapi)
for the methods you must call to do this.
- You can view resources and logs in the AWS Console (region us-east-1) for your
[ECS Cluster](https://console.aws.amazon.com/ecs/home?region=us-east-1#/clusters/numerai-submission-ecs-cluster/tasks)
and [other resources](https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logsV2:log-groups)
NEXT: [read the Prediction Nodes wiki](https://github.com/numerai/numerai-cli/wiki/Prediction-Nodes)
to learn about Numerai Examples and how to customize Prediction Nodes.
## List of Commands
Use the `--help` option on any command or sub-command to get a full description of it:
```
numerai
numerai --help
numerai [command] --help
numerai [command] [sub-command] --help
```
Each command or sub-command takes its own options, for example if you want to copy the
numerai signals example and configure a node for a signals model with large memory
requirements you'd use something like this (replacing [MODEL NAME] with the relevant
signals model name):
```
numerai node -m [MODEL NAME] -s config -s mem-lg -e signals-python3
```
Here, the `node` command takes a model name with `-m` and a flag `-s` to detect if it's
a signals model or numerai model. The `config` sub-command also takes a `-s` option to
specify the size of the node to configure.
## Troubleshooting and Feedback
Before messaging the Rocketchat channel or creating a Github issue,
please read through the following (especially the "Troubleshooting" section in the wiki):
- [Github Wiki](https://github.com/numerai/numerai-cli/wiki)
- [Github Issues](https://github.com/numerai/numerai-cli/issues)
If you still cannot find a solution or answer, please join us on the
[RocketChat #support Channel](https://rocketchat.numer.ai/channel/support)
and include the following information with your issue/message:
- The commands you ran that caused the error (even previous commands)
- Version information from running:
- `pip3 show numerai-cli`
- `python -V`
- `docker -v`
- System Information from running
- Mac: `system_profiler SPSoftwareDataType && system_profiler SPHardwareDataType`
- Linux: `lsb_release -a && uname -a`
- Windows: `powershell -command "Get-ComputerInfo"`
If you do not include this information, we cannot help you.
## Upgrading and Updating
Upgrading numerai-cli will always require you to update the package itself using pip:
```
pip install --upgrade numerai-cli --user
```
#### 0.1/0.2 -> 0.3.0
CLI 0.3.0 uses a new configuration format that is incompatible with versions 0.1 and 0.2,
but a command to migrate you configuration is provided for you. Run this in the directory
you ran `numerai setup` from the previous version:
```
numerai upgrade
```
#### Beyond
Some updates will make changes to configuration files used by Numerai CLI. These will
require you to re-run some commands to upgrade your nodes to the newest versions:
- `numerai setup` will copy over changes to files in the `$HOME/.numerai` directory
- `numerai node config` will apply those changes to a node
## Uninstall
```
numerai uninstall
```
## Contributions
- Thanks to [uuazed](https://github.com/uuazed) for their work on [numerapi](https://github.com/uuazed/numerapi)
- Thanks to [hellno](https://github.com/hellno) for starting the Signals [ticker map](https://github.com/hellno/numerai-signals-tickermap)
- Thanks to tit_BTCQASH ([numerai profile](https://numer.ai/tit_btcqash) and [twitter profile](https://twitter.com/tit_BTCQASH)) for debugging the environment setup process on Windows 8
%prep
%autosetup -n numerai-cli-0.3.5
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-numerai-cli -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 0.3.5-1
- Package Spec generated
|