-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy path1.0.7.yml
1997 lines (1970 loc) · 56.1 KB
/
1.0.7.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: Jina is the cloud-native neural search solution powered by state-of-the-art
AI and deep learning technology
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: 1.0.7
methods:
- name: hello
options: []
- 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- automatics docs UI\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 description of this object. It will be used in automatics docs UI.
choices: null
default: null
required: false
option_strings:
- --description
type: str
default_random: false
name: description
- help: The YAML config of the logger used in this object.
choices: null
default: /opt/hostedtoolcache/Python/3.7.10/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 port for controlling the runtime, default a random port between [49152,
65535]
choices: null
default: 42505
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: "\nThe config of the executor, it could be one of the followings: \n- an\
\ Executor-level YAML file path (.yml, .yaml, .jaml) \n- a name of a class inherited\
\ from `jina.Executor`\n- a docker image (must start with `docker://`)\n- builtin\
\ executors, e.g. `_pass`, `_logforward`, `_merge` \n- the string literal of\
\ a YAML config (must start with `!`)\n- the string literal of a JSON config\n\
- the string literal of a YAML driver config (must start with `- !!`)\n\nWhen\
\ 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: _pass
required: false
option_strings:
- --uses
type: str
default_random: false
name: uses
- help: "\nThe customized python modules need to be imported before loading the\
\ executor\n\nNote, when importing multiple files and there is a dependency\
\ between them, then one has to write the dependencies in \nreverse order. That\
\ is, if `__init__.py` depends on `A.py`, which again depends on `B.py`, then\
\ you need to write: \n\n--py-modules __init__.py --py-modules B.py --py-modules\
\ A.py\n\n"
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: 52921
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: 55223
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: 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
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
default: PUSH_BIND
required: false
option_strings:
- --socket-out
type: str
default_random: false
name: socket_out
- help: 'Serialize the model in the pod every n seconds if model changes. -1 means
--read-only. '
choices: null
default: 240
required: false
option_strings:
- --dump-interval
type: int
default_random: false
name: dump_interval
- help: If set, do not allow the pod to modify the model, dump_interval will be
ignored
choices: null
default: false
required: false
option_strings:
- --read-only
type: bool
default_random: false
name: read_only
- 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: "\nThe skip strategy on exceptions.\n\n- IGNORE: Ignore it, keep running\
\ all Drivers & Executors logics in the sequel flow\n- SKIP_EXECUTOR: Skip all\
\ Executors in the sequel, but drivers are still called\n- SKIP_HANDLE: Skip\
\ all Drivers & Executors in the sequel, only `pre_hook` and `post_hook` are\
\ called\n- THROW_EARLY: Immediately throw the exception, the sequel flow will\
\ not be running at all \n \nNote, `IGNORE`, `SKIP_EXECUTOR`\
\ and `SKIP_HANDLE` do not guarantee the success execution in the sequel flow.\
\ If something \nis wrong in the upstream, it is hard to carry this exception\
\ and moving forward without any side-effect.\n"
choices:
- IGNORE
- SKIP_EXECUTOR
- SKIP_HANDLE
- THROW_EARLY
default: IGNORE
required: false
option_strings:
- --on-error-strategy
type: str
default_random: false
name: on_error_strategy
- help: "\nThe config runs inside the Docker container. \n\nSyntax and function\
\ are the same as `--uses`. This is designed when `--uses=\"docker://...\"`\
\ this config is passed to \nthe Docker container.\n"
choices: null
default: BaseExecutor
required: false
option_strings:
- --uses-internal
type: str
default_random: false
name: uses_internal
- 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: 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: 60831
required: false
option_strings:
- --port-expose
type: int
default_random: true
default_factory: random_port
name: port_expose
- help: Do not display the streaming of remote logs on local console
choices: null
default: false
required: false
option_strings:
- --silent-remote-logs
type: bool
default_random: false
name: silent_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 UUID for identifying the workspace. When not given a random id will
be assigned.Multiple Pea/Pod/Flow will work under the same workspace if they
share the same `workspace-id`.
choices: null
default: fabd2a28-5fc0-4fe4-9ee3-162b324748f1
required: false
option_strings:
- --workspace-id
type: str
default_random: true
default_factory: random_identity
name: workspace_id
- 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:
- GRPCRuntime
- RESTRuntime
- ContainerRuntime
- JinadRuntime
- SSHRuntime
- ZEDRuntime
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: 60000
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: "\nThe polling strategy of the Pod (when `parallel>1`) \n- ANY: only one\
\ (whoever is idle) Pea polls the message\n- ALL: all Peas poll the message\
\ (like a broadcast)\n"
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
- name: flow
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- automatics docs UI\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 description of this object. It will be used in automatics docs UI.
choices: null
default: null
required: false
option_strings:
- --description
type: str
default_random: false
name: description
- help: The YAML config of the logger used in this object.
choices: null
default: /opt/hostedtoolcache/Python/3.7.10/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 YAML file represents a flow
choices: null
default: null
required: false
option_strings:
- --uses
type: str
default_random: false
name: uses
- help: '
The strategy on those inspect pods in the flow.
If `REMOVE` is given then all inspect pods are removed when building the flow.
'
choices:
- HANG
- REMOVE
- COLLECT
default: COLLECT
required: false
option_strings:
- --inspect
type: str
default_random: false
name: inspect
- name: optimizer
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- automatics docs UI\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 description of this object. It will be used in automatics docs UI.
choices: null
default: null
required: false
option_strings:
- --description
type: str
default_random: false
name: description
- help: The YAML config of the logger used in this object.
choices: null
default: /opt/hostedtoolcache/Python/3.7.10/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 path to a YAML file which defines a FlowOptimizer.
choices: null
default: null
required: false
option_strings:
- --uses
type: str
default_random: false
name: uses
- help: The path to a YAML file to store the output.
choices: null
default: null
required: false
option_strings:
- --output-dir
type: str
default_random: false
name: output_dir
- name: gateway
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- automatics docs UI\n- ...\n\nWhen not given, then the default naming\
\ strategy will apply. \n "
choices: null
default: gateway
required: false
option_strings:
- --name
type: str
default_random: false
name: name
- help: The description of this object. It will be used in automatics docs UI.
choices: null
default: null
required: false
option_strings:
- --description
type: str
default_random: false
name: description
- help: The YAML config of the logger used in this object.
choices: null
default: /opt/hostedtoolcache/Python/3.7.10/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 port for controlling the runtime, default a random port between [49152,
65535]
choices: null
default: 34197
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: true
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: "\nThe config of the executor, it could be one of the followings: \n- an\
\ Executor-level YAML file path (.yml, .yaml, .jaml) \n- a name of a class inherited\
\ from `jina.Executor`\n- a docker image (must start with `docker://`)\n- builtin\
\ executors, e.g. `_pass`, `_logforward`, `_merge` \n- the string literal of\
\ a YAML config (must start with `!`)\n- the string literal of a JSON config\n\
- the string literal of a YAML driver config (must start with `- !!`)\n\nWhen\
\ 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: _pass
required: false
option_strings:
- --uses
type: str
default_random: false
name: uses
- help: "\nThe customized python modules need to be imported before loading the\
\ executor\n\nNote, when importing multiple files and there is a dependency\
\ between them, then one has to write the dependencies in \nreverse order. That\
\ is, if `__init__.py` depends on `A.py`, which again depends on `B.py`, then\
\ you need to write: \n\n--py-modules __init__.py --py-modules B.py --py-modules\
\ A.py\n\n"
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: 46697
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: 45089
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: 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
default: PULL_CONNECT
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
default: PUSH_CONNECT
required: false
option_strings:
- --socket-out
type: str
default_random: false
name: socket_out
- help: 'Serialize the model in the pod every n seconds if model changes. -1 means
--read-only. '
choices: null
default: 240
required: false
option_strings:
- --dump-interval
type: int
default_random: false
name: dump_interval
- help: If set, do not allow the pod to modify the model, dump_interval will be
ignored
choices: null
default: true
required: false
option_strings:
- --read-only
type: bool
default_random: false
name: read_only
- 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: "\nThe skip strategy on exceptions.\n\n- IGNORE: Ignore it, keep running\
\ all Drivers & Executors logics in the sequel flow\n- SKIP_EXECUTOR: Skip all\
\ Executors in the sequel, but drivers are still called\n- SKIP_HANDLE: Skip\
\ all Drivers & Executors in the sequel, only `pre_hook` and `post_hook` are\
\ called\n- THROW_EARLY: Immediately throw the exception, the sequel flow will\
\ not be running at all \n \nNote, `IGNORE`, `SKIP_EXECUTOR`\
\ and `SKIP_HANDLE` do not guarantee the success execution in the sequel flow.\
\ If something \nis wrong in the upstream, it is hard to carry this exception\
\ and moving forward without any side-effect.\n"
choices:
- IGNORE
- SKIP_EXECUTOR
- SKIP_HANDLE
- THROW_EARLY
default: IGNORE
required: false
option_strings:
- --on-error-strategy
type: str
default_random: false
name: on_error_strategy
- help: The maximum send and receive size for gRPC server in bytes, -1 means unlimited
choices: null
default: -1
required: false
option_strings:
- --max-message-size
type: int
default_random: false
name: max_message_size
- 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: The number of pre-fetched requests from the client
choices: null
default: 50
required: false
option_strings:
- --prefetch
type: int
default_random: false
name: prefetch
- help: The number of additional requests to fetch on every receive
choices: null
default: 1
required: false
option_strings:
- --prefetch-on-recv
type: int
default_random: false
name: prefetch_on_recv
- help: If set, use RESTful interface instead of gRPC as the main interface
choices: null
default: false
required: false
option_strings:
- --restful
- --rest-api
type: bool
default_random: false
name: restful
- help: "\nThe compress algorithm used over the entire Flow. \n\nNote that this\
\ is not necessarily effective, it depends on the settings of `--compress-lwm`\