-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy path2.0.17.yml
2874 lines (2762 loc) · 79 KB
/
2.0.17.yml
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
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
name: Jina
description: Cloud-native neural search framework for any kind of data
license: Apache 2.0
vendor: Jina AI Limited
source: https://github.com/jina-ai/jina/tree/master
url: https://jina.ai
docs: https://docs.jina.ai
authors: [email protected]
version: 2.0.17
methods:
- name: hello
options: []
help: Start hello world demos.
methods:
- name: fashion
options:
- help: The workdir for hello-world demoall data, indices, shards and outputs
will be saved there
choices: null
default: cc23e894-0a37-4dae-9aed-cb2ebfda5e80
required: false
option_strings:
- --workdir
type: str
default_random: false
name: workdir
- help: The proxy when downloading sample data
choices: null
default: null
required: false
option_strings:
- --download-proxy
type: str
default_random: false
name: download_proxy
- help: The url of index data (should be in idx3-ubyte.gz format)
choices: null
default: http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-images-idx3-ubyte.gz
required: false
option_strings:
- --index-data-url
type: str
default_random: false
name: index_data_url
- help: The url of index labels data (should be in idx3-ubyte.gz format)
choices: null
default: http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-labels-idx1-ubyte.gz
required: false
option_strings:
- --index-labels-url
type: str
default_random: false
name: index_labels_url
- help: The url of query data (should be in idx3-ubyte.gz format)
choices: null
default: http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-images-idx3-ubyte.gz
required: false
option_strings:
- --query-data-url
type: str
default_random: false
name: query_data_url
- help: The url of query labels data (should be in idx3-ubyte.gz format)
choices: null
default: http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-labels-idx1-ubyte.gz
required: false
option_strings:
- --query-labels-url
type: str
default_random: false
name: query_labels_url
- help: The request size in indexing (the maximum number of documents that will
be included in a Request before sending it)
choices: null
default: 1024
required: false
option_strings:
- --request-size
type: int
default_random: false
name: request_size
- help: The number of queries to visualize
choices: null
default: 128
required: false
option_strings:
- --num-query
type: int
default_random: false
name: num_query
- help: Top-k results to retrieve and visualize
choices: null
default: 50
required: false
option_strings:
- --top-k
type: int
default_random: false
name: top_k
help: Run a fashion search demo
- name: chatbot
options:
- help: The workdir for hello-world demoall data, indices, shards and outputs
will be saved there
choices: null
default: 305562b4-3d12-4db6-b78e-a4a80c46b5c3
required: false
option_strings:
- --workdir
type: str
default_random: false
name: workdir
- help: The proxy when downloading sample data
choices: null
default: null
required: false
option_strings:
- --download-proxy
type: str
default_random: false
name: download_proxy
- help: The url of index csv data
choices: null
default: https://static.jina.ai/chatbot/dataset.csv
required: false
option_strings:
- --index-data-url
type: str
default_random: false
name: index_data_url
- help: The port of the host exposed to the public
choices: null
default: 8080
required: false
option_strings:
- --port-expose
type: int
default_random: false
name: port_expose
- help: The number of parallel when index and query
choices: null
default: 2
required: false
option_strings:
- --parallel
type: int
default_random: false
name: parallel
help: Run a chatbot QA demo
- name: multimodal
options:
- help: The workdir for hello-world demoall data, indices, shards and outputs
will be saved there
choices: null
default: e3c484c8-22b5-48a3-8888-f69c0c610db3
required: false
option_strings:
- --workdir
type: str
default_random: false
name: workdir
- help: The proxy when downloading sample data
choices: null
default: null
required: false
option_strings:
- --download-proxy
type: str
default_random: false
name: download_proxy
- help: The url of index csv data
choices: null
default: https://static.jina.ai/multimodal/people-img.zip
required: false
option_strings:
- --index-data-url
type: str
default_random: false
name: index_data_url
- help: The port of the host exposed to the public
choices: null
default: 8080
required: false
option_strings:
- --port-expose
type: int
default_random: false
name: port_expose
help: Run a multimodal search demo
- name: fork
options:
- help: The hello world project to fork
choices:
- fashion
- chatbot
- multimodal
default: null
required: true
option_strings: []
type: str
default_random: false
name: project
- help: The dest directory of the forked project. Note, it can not be an existing
path.
choices: null
default: null
required: true
option_strings: []
type: str
default_random: false
name: destination
help: Fork a hello world project to a local directory.
- name: executor
options:
- help: "\nThe name of this object.\n\nThis will be used in the following places:\n\
- how you refer to this object in Python/YAML/CLI\n- visualization\n- log message\
\ header\n- ...\n\nWhen not given, then the default naming strategy will apply.\n\
\ "
choices: null
default: null
required: false
option_strings:
- --name
type: str
default_random: false
name: name
- help: The working directory for any IO operations in this object. If not set,
then derive from its parent `workspace`.
choices: null
default: null
required: false
option_strings:
- --workspace
type: str
default_random: false
name: workspace
- help: The YAML config of the logger used in this object.
choices: null
default: /opt/hostedtoolcache/Python/3.7.11/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml
required: false
option_strings:
- --log-config
type: str
default_random: false
name: log_config
- help: If set, then no log will be emitted from this object.
choices: null
default: false
required: false
option_strings:
- --quiet
type: bool
default_random: false
name: quiet
- help: If set, then exception stack information will not be added to the log
choices: null
default: false
required: false
option_strings:
- --quiet-error
type: bool
default_random: false
name: quiet_error
- help: The identity of a ZMQRuntime. It is used for unique socket identification
towards other ZMQRuntimes.
choices: null
default: null
required: false
option_strings:
- --zmq-identity
type: str
default_random: false
name: zmq_identity
- help: The port for controlling the runtime, default a random port between [49152,
65535]
choices: null
default: 58599
required: false
option_strings:
- --port-ctrl
type: int
default_random: true
default_factory: random_port
name: port_ctrl
- help: If set, use ipc protocol for control socket
choices: null
default: false
required: false
option_strings:
- --ctrl-with-ipc
type: bool
default_random: false
name: ctrl_with_ipc
- help: The timeout in milliseconds of the control request, -1 for waiting forever
choices: null
default: 5000
required: false
option_strings:
- --timeout-ctrl
type: int
default_random: false
name: timeout_ctrl
- help: The SSH server through which the tunnel will be created, can actually be
a fully specified `user@server:port` ssh url.
choices: null
default: null
required: false
option_strings:
- --ssh-server
type: str
default_random: false
name: ssh_server
- help: This specifies a key to be used in ssh login, default None. regular default
ssh keys will be used without specifying this argument.
choices: null
default: null
required: false
option_strings:
- --ssh-keyfile
type: str
default_random: false
name: ssh_keyfile
- help: The ssh password to the ssh server.
choices: null
default: null
required: false
option_strings:
- --ssh-password
type: str
default_random: false
name: ssh_password
- help: "\n The config of the executor, it could be one of the followings:\n\
\ * an Executor YAML file (.yml, .yaml, .jaml)\n * a Jina Hub\
\ Executor (must start with `jinahub://` or `jinahub+docker://`)\n *\
\ a docker image (must start with `docker://`)\n * the string literal\
\ of a YAML config (must start with `!` or `jtype: `)\n * the string\
\ literal of a JSON config\n\n When use it under Python, one can use\
\ the following values additionally:\n - a Python dict that represents\
\ the config\n - a text file stream has `.read()` interface\n "
choices: null
default: BaseExecutor
required: false
option_strings:
- --uses
type: str
default_random: false
name: uses
- help: "\n Dictionary of keyword arguments that will override the `with` configuration\
\ in `uses`\n "
choices: null
default: null
required: false
option_strings:
- --uses-with
type: dict
default_random: false
name: uses_with
- help: "\n Dictionary of keyword arguments that will override the `metas` configuration\
\ in `uses`\n "
choices: null
default: null
required: false
option_strings:
- --uses-metas
type: dict
default_random: false
name: uses_metas
- help: "\n Dictionary of keyword arguments that will override the `requests`\
\ configuration in `uses`\n "
choices: null
default: null
required: false
option_strings:
- --uses-requests
type: dict
default_random: false
name: uses_requests
- help: '
The customized python modules need to be imported before loading the executor
Note, when importing multiple files and there is a dependency between them,
then one has to write the dependencies in
reverse order. That is, if `__init__.py` depends on `A.py`, which again depends
on `B.py`, then you need to write:
--py-modules __init__.py --py-modules B.py --py-modules A.py
'
choices: null
default: null
required: false
option_strings:
- --py-modules
type: typing.List[str]
default_random: false
name: py_modules
- help: The port for input data, default a random port between [49152, 65535]
choices: null
default: 51139
required: false
option_strings:
- --port-in
type: int
default_random: true
default_factory: random_port
name: port_in
- help: The port for output data, default a random port between [49152, 65535]
choices: null
default: 51119
required: false
option_strings:
- --port-out
type: int
default_random: true
default_factory: random_port
name: port_out
- help: The host address for input, by default it is 0.0.0.0
choices: null
default: null
required: false
option_strings:
- --hosts-in-connect
type: typing.List[str]
default_random: false
name: hosts_in_connect
- help: The host address for input, by default it is 0.0.0.0
choices: null
default: 0.0.0.0
required: false
option_strings:
- --host-in
type: str
default_random: false
name: host_in
- help: The host address for output, by default it is 0.0.0.0
choices: null
default: 0.0.0.0
required: false
option_strings:
- --host-out
type: str
default_random: false
name: host_out
- help: The socket type for input port
choices:
- PULL_BIND
- PULL_CONNECT
- PUSH_BIND
- PUSH_CONNECT
- SUB_BIND
- SUB_CONNECT
- PUB_BIND
- PUB_CONNECT
- PAIR_BIND
- PAIR_CONNECT
- ROUTER_BIND
- DEALER_CONNECT
- ROUTER_CONNECT
default: PULL_BIND
required: false
option_strings:
- --socket-in
type: str
default_random: false
name: socket_in
- help: The socket type for output port
choices:
- PULL_BIND
- PULL_CONNECT
- PUSH_BIND
- PUSH_CONNECT
- SUB_BIND
- SUB_CONNECT
- PUB_BIND
- PUB_CONNECT
- PAIR_BIND
- PAIR_CONNECT
- ROUTER_BIND
- DEALER_CONNECT
- ROUTER_CONNECT
default: PUSH_BIND
required: false
option_strings:
- --socket-out
type: str
default_random: false
name: socket_out
- help: The memory high watermark of this pod in Gigabytes, pod will restart when
this is reached. -1 means no restriction
choices: null
default: -1
required: false
option_strings:
- --memory-hwm
type: int
default_random: false
name: memory_hwm
- help: '
The skip strategy on exceptions.
- IGNORE: Ignore it, keep running all Executors in the sequel flow
- SKIP_HANDLE: Skip all Executors in the sequel, only `pre_hook` and `post_hook`
are called
- THROW_EARLY: Immediately throw the exception, the sequel flow will not be
running at all
Note, `IGNORE`, `SKIP_EXECUTOR` and `SKIP_HANDLE` do not guarantee the success
execution in the sequel flow. If something
is wrong in the upstream, it is hard to carry this exception and moving forward
without any side-effect.
'
choices:
- IGNORE
- SKIP_HANDLE
- THROW_EARLY
default: IGNORE
required: false
option_strings:
- --on-error-strategy
type: str
default_random: false
name: on_error_strategy
- help: The entrypoint command overrides the ENTRYPOINT in Docker image. when not
set then the Docker image ENTRYPOINT takes effective.
choices: null
default: null
required: false
option_strings:
- --entrypoint
type: str
default_random: false
name: entrypoint
- help: "\nDictionary of kwargs arguments that will be passed to Docker SDK when\
\ starting the docker '\ncontainer. \n\nMore details can be found in the Docker\
\ SDK docs: https://docker-py.readthedocs.io/en/stable/\n\n"
choices: null
default: null
required: false
option_strings:
- --docker-kwargs
type: dict
default_random: false
name: docker_kwargs
- help: Pull the latest image before running
choices: null
default: false
required: false
option_strings:
- --pull-latest
type: bool
default_random: false
name: pull_latest
- help: "\nThe path on the host to be mounted inside the container. \n\nNote, \n\
- If separated by `:`, then the first part will be considered as the local host\
\ path and the second part is the path in the container system. \n- If no split\
\ provided, then the basename of that directory will be mounted into container's\
\ root path, e.g. `--volumes=\"/user/test/my-workspace\"` will be mounted into\
\ `/my-workspace` inside the container. \n- All volumes are mounted with read-write\
\ mode.\n"
choices: null
default: null
required: false
option_strings:
- --volumes
type: typing.List[str]
default_random: false
name: volumes
- help: "\n This argument allows dockerized Jina executor discover local gpu\
\ devices.\n\n Note, \n - To access all gpus, use `--gpus all`.\n -\
\ To access multiple gpus, e.g. make use of 2 gpus, use `--gpus 2`.\n - To\
\ access specified gpus based on device id, use `--gpus device=[YOUR-GPU-DEVICE-ID]`\n\
\ - To access specified gpus based on multiple device id, use `--gpus device=[YOUR-GPU-DEVICE-ID1],device=[YOUR-GPU-DEVICE-ID2]`\n\
\ - To specify more parameters, use `--gpus device=[YOUR-GPU-DEVICE-ID],runtime=nvidia,capabilities=display\n\
\ "
choices: null
default: null
required: false
option_strings:
- --gpus
type: str
default_random: false
name: gpus
- help: The host address of the runtime, by default it is 0.0.0.0.
choices: null
default: 0.0.0.0
required: false
option_strings:
- --host
type: str
default_random: false
name: host
- help: The port of the host exposed to the public
choices: null
default: 34579
required: false
option_strings:
- --port-expose
type: int
default_random: true
default_factory: random_port
name: port_expose
- help: If set, respect the http_proxy and https_proxy environment variables. otherwise,
it will unset these proxy variables before start. gRPC seems to prefer no proxy
choices: null
default: false
required: false
option_strings:
- --proxy
type: bool
default_random: false
name: proxy
- help: Do not display the streaming of remote logs on local console
choices: null
default: false
required: false
option_strings:
- --quiet-remote-logs
type: bool
default_random: false
name: quiet_remote_logs
- help: '
The files on the host to be uploaded to the remote
workspace. This can be useful when your Pod has more
file dependencies beyond a single YAML file, e.g.
Python files, data files.
Note,
- currently only flatten structure is supported, which means if you upload `[./foo/a.py,
./foo/b.pp, ./bar/c.yml]`, then they will be put under the _same_ workspace
on the remote, losing all hierarchies.
- by default, `--uses` YAML file is always uploaded.
- uploaded files are by default isolated across the runs. To ensure files are
submitted to the same workspace across different runs, use `--workspace-id`
to specify the workspace.
'
choices: null
default: null
required: false
option_strings:
- --upload-files
type: typing.List[str]
default_random: false
name: upload_files
- help: The Pea attempts to terminate all of its Runtime child processes/threads
on existing. setting it to true basically tell the Pea do not wait on the Runtime
when closing
choices: null
default: false
required: false
option_strings:
- --daemon
type: bool
default_random: false
name: daemon
- help: The parallel backend of the runtime inside the Pea
choices:
- THREAD
- PROCESS
default: PROCESS
required: false
option_strings:
- --runtime-backend
- --runtime
type: str
default_random: false
name: runtime_backend
- help: The runtime class to run inside the Pea
choices: null
default: ZEDRuntime
required: false
option_strings:
- --runtime-cls
type: str
default_random: false
name: runtime_cls
- help: The timeout in milliseconds of a Pea waits for the runtime to be ready,
-1 for waiting forever
choices: null
default: 600000
required: false
option_strings:
- --timeout-ready
type: int
default_random: false
name: timeout_ready
- help: The map of environment variables that are available inside runtime
choices: null
default: null
required: false
option_strings:
- --env
type: dict
default_random: false
name: env
- help: If set, expose the public IP address to remote when necessary, by default
it exposesprivate IP address, which only allows accessing under the same network/subnet.
Important to set this to true when the Pea will receive input connections from
remote Peas
choices: null
default: false
required: false
option_strings:
- --expose-public
type: bool
default_random: false
name: expose_public
- help: The executor attached after the Peas described by --uses, typically before
sending to all parallels, accepted type follows `--uses`
choices: null
default: null
required: false
option_strings:
- --uses-before
type: str
default_random: false
name: uses_before
- help: The executor attached after the Peas described by --uses, typically used
for receiving from all parallels, accepted type follows `--uses`
choices: null
default: null
required: false
option_strings:
- --uses-after
type: str
default_random: false
name: uses_after
- help: The number of parallel peas in the pod running at the same time, `port_in`
and `port_out` will be set to random, and routers will be added automatically
when necessary
choices: null
default: 1
required: false
option_strings:
- --parallel
- --shards
type: int
default_random: false
name: parallel
- help: The number of replicas in the pod, `port_in` and `port_out` will be set
to random, and routers will be added automatically when necessary
choices: null
default: 1
required: false
option_strings:
- --replicas
type: int
default_random: false
name: replicas
- help: '
The polling strategy of the Pod (when `parallel>1`)
- ANY: only one (whoever is idle) Pea polls the message
- ALL: all Peas poll the message (like a broadcast)
'
choices:
- ANY
- ALL
- ALL_ASYNC
default: ANY
required: false
option_strings:
- --polling
type: str
default_random: false
name: polling
- help: The strategy of scheduling workload among Peas
choices:
- LOAD_BALANCE
- ROUND_ROBIN
default: LOAD_BALANCE
required: false
option_strings:
- --scheduling
type: str
default_random: false
name: scheduling
- help: The Pod will be considered an external Pod that has been started independently
from the Flow.This Pod will not be context managed by the Flow.
choices: null
default: false
required: false
option_strings:
- --external
type: bool
default_random: false
name: external
- help: "The hosts of the peas when parallel greater than 1.\n Peas will\
\ be evenly distributed among the hosts. By default,\n peas are running\
\ on host provided by the argument ``host``"
choices: null
default: null
required: false
option_strings:
- --peas-hosts
type: typing.List[str]
default_random: false
name: peas_hosts
- help: The head Pea of this Pod will connect to the TailPea of the predecessor
Pod.
choices: null
default: false
required: false
option_strings:
- --connect-to-predecessor
type: bool
default_random: false
name: connect_to_predecessor
help: Start an Executor. Executor is how Jina processes Document.
- name: pod
options:
- help: "\nThe name of this object.\n\nThis will be used in the following places:\n\
- how you refer to this object in Python/YAML/CLI\n- visualization\n- log message\
\ header\n- ...\n\nWhen not given, then the default naming strategy will apply.\n\
\ "
choices: null
default: null
required: false
option_strings:
- --name
type: str
default_random: false
name: name
- help: The working directory for any IO operations in this object. If not set,
then derive from its parent `workspace`.
choices: null
default: null
required: false
option_strings:
- --workspace
type: str
default_random: false
name: workspace
- help: The YAML config of the logger used in this object.
choices: null
default: /opt/hostedtoolcache/Python/3.7.11/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml
required: false
option_strings:
- --log-config
type: str
default_random: false
name: log_config
- help: If set, then no log will be emitted from this object.
choices: null
default: false
required: false
option_strings:
- --quiet
type: bool
default_random: false
name: quiet
- help: If set, then exception stack information will not be added to the log
choices: null
default: false
required: false
option_strings:
- --quiet-error
type: bool
default_random: false
name: quiet_error
- help: The identity of a ZMQRuntime. It is used for unique socket identification
towards other ZMQRuntimes.
choices: null
default: null
required: false
option_strings:
- --zmq-identity
type: str
default_random: false
name: zmq_identity
- help: The port for controlling the runtime, default a random port between [49152,
65535]
choices: null
default: 60419
required: false
option_strings:
- --port-ctrl
type: int
default_random: true
default_factory: random_port
name: port_ctrl
- help: If set, use ipc protocol for control socket
choices: null
default: false
required: false
option_strings:
- --ctrl-with-ipc
type: bool
default_random: false
name: ctrl_with_ipc
- help: The timeout in milliseconds of the control request, -1 for waiting forever
choices: null
default: 5000
required: false
option_strings:
- --timeout-ctrl
type: int
default_random: false
name: timeout_ctrl
- help: The SSH server through which the tunnel will be created, can actually be
a fully specified `user@server:port` ssh url.
choices: null
default: null
required: false
option_strings:
- --ssh-server
type: str
default_random: false
name: ssh_server
- help: This specifies a key to be used in ssh login, default None. regular default
ssh keys will be used without specifying this argument.
choices: null
default: null
required: false
option_strings:
- --ssh-keyfile
type: str
default_random: false
name: ssh_keyfile
- help: The ssh password to the ssh server.
choices: null
default: null
required: false
option_strings:
- --ssh-password
type: str
default_random: false
name: ssh_password
- help: "\n The config of the executor, it could be one of the followings:\n\
\ * an Executor YAML file (.yml, .yaml, .jaml)\n * a Jina Hub\
\ Executor (must start with `jinahub://` or `jinahub+docker://`)\n *\
\ a docker image (must start with `docker://`)\n * the string literal\
\ of a YAML config (must start with `!` or `jtype: `)\n * the string\
\ literal of a JSON config\n\n When use it under Python, one can use\
\ the following values additionally:\n - a Python dict that represents\
\ the config\n - a text file stream has `.read()` interface\n "
choices: null
default: BaseExecutor
required: false
option_strings:
- --uses
type: str
default_random: false
name: uses
- help: "\n Dictionary of keyword arguments that will override the `with` configuration\
\ in `uses`\n "
choices: null
default: null
required: false
option_strings:
- --uses-with
type: dict
default_random: false
name: uses_with
- help: "\n Dictionary of keyword arguments that will override the `metas` configuration\
\ in `uses`\n "
choices: null
default: null
required: false
option_strings:
- --uses-metas
type: dict
default_random: false
name: uses_metas
- help: "\n Dictionary of keyword arguments that will override the `requests`\
\ configuration in `uses`\n "
choices: null
default: null
required: false
option_strings:
- --uses-requests
type: dict
default_random: false
name: uses_requests
- help: '
The customized python modules need to be imported before loading the executor