-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy path0.7.8.yml
1867 lines (1867 loc) · 46.1 KB
/
0.7.8.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
authors: [email protected]
description: Jina is the cloud-native neural search solution powered by state-of-the-art
AI and deep learning technology
docs: https://docs.jina.ai
license: Apache 2.0
methods:
- name: hello-world
options:
- choices: null
default: 95435f4024db11ebb786000d3a1c5bc5
default_random: true
help: the workdir for hello-world demo, all data, indices, shards and outputs
will be saved there
name: workdir
option_strings:
- --workdir
required: false
type: str
- choices: null
default: false
default_random: false
help: start a log server for the dashboard
name: logserver
option_strings:
- --logserver
required: false
type: bool
- choices: null
default: /opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/logserver.default.yml
default_random: false
help: the yaml config of the log server
name: logserver_config
option_strings:
- --logserver-config
required: false
type: str
- choices: null
default: null
default_random: false
help: specify the proxy when downloading sample data
name: download_proxy
option_strings:
- --download-proxy
required: false
type: str
- choices: null
default: 2
default_random: false
help: number of shards when index and query
name: shards
option_strings:
- --shards
required: false
type: int
- choices: null
default: 2
default_random: false
help: number of parallel when index and query
name: parallel
option_strings:
- --parallel
required: false
type: int
- choices: null
default: /opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/helloworld.flow.index.yml
default_random: false
help: the yaml path of the index flow
name: uses_index
option_strings:
- --uses-index
required: false
type: str
- choices: null
default: http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-images-idx3-ubyte.gz
default_random: false
help: the url of index data (should be in idx3-ubyte.gz format)
name: index_data_url
option_strings:
- --index-data-url
required: false
type: str
- choices: null
default: 1024
default_random: false
help: the batch size in indexing
name: index_batch_size
option_strings:
- --index-batch-size
required: false
type: int
- choices: null
default: /opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/helloworld.flow.query.yml
default_random: false
help: the yaml path of the query flow
name: uses_query
option_strings:
- --uses-query
required: false
type: str
- choices: null
default: http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-images-idx3-ubyte.gz
default_random: false
help: the url of query data (should be in idx3-ubyte.gz format)
name: query_data_url
option_strings:
- --query-data-url
required: false
type: str
- choices: null
default: 32
default_random: false
help: the batch size in searching
name: query_batch_size
option_strings:
- --query-batch-size
required: false
type: int
- choices: null
default: 128
default_random: false
help: number of queries to visualize
name: num_query
option_strings:
- --num-query
required: false
type: int
- choices: null
default: 50
default_random: false
help: top-k results to retrieve and visualize
name: top_k
option_strings:
- --top-k
required: false
type: int
- name: pod
options:
- choices: null
default: null
default_random: false
help: the name of this pea, used to identify the pod and its logs.
name: name
option_strings:
- --name
required: false
type: str
- choices: null
default: 95435f5124db11ebb786000d3a1c5bc5
default_random: true
help: the identity of the sockets, default a random string (Important for load
balancing messages
name: identity
option_strings:
- --identity
required: false
type: str
- choices: null
default: 95435f5224db11ebb786000d3a1c5bc5
default_random: true
help: ==SUPPRESS==
name: log_id
option_strings:
- --log-id
required: false
type: str
- choices: null
default: _pass
default_random: false
help: the config of the executor, it could be > a YAML file path, > a supported
executor's class name, > one of "_clear", "_pass", "_logforward" > the content
of YAML config (must starts with "!")> a docker image
name: uses
option_strings:
- --uses
required: false
type: str
- choices: null
default: null
default_random: false
help: the customized python modules need to be imported before loading the executor
name: py_modules
option_strings:
- --py-modules
required: false
type: str
- choices: null
default: BaseExecutor
default_random: false
help: 'The executor config that is passed to the docker image if a docker image
is used in uses. It cannot be another docker image '
name: uses_internal
option_strings:
- --uses-internal
required: false
type: str
- choices: null
default: null
default_random: false
help: the entrypoint command overrides the ENTRYPOINT in docker image. when not
set then the docker image ENTRYPOINT takes effective.
name: entrypoint
option_strings:
- --entrypoint
required: false
type: str
- choices: null
default: false
default_random: false
help: pull the latest image before running
name: pull_latest
option_strings:
- --pull-latest
required: false
type: bool
- choices: null
default: null
default_random: false
help: the path on the host to be mounted inside the container. they will be mounted
to the root path, i.e. /user/test/my-workspace will be mounted to /my-workspace
inside the container. all volumes are mounted with read-write mode.
name: volumes
option_strings:
- --volumes
required: false
type: str
- choices: null
default: 35221
default_random: true
help: port for input data, default a random port between [49152, 65535]
name: port_in
option_strings:
- --port-in
required: false
type: int
- choices: null
default: 43475
default_random: true
help: port for output data, default a random port between [49152, 65535]
name: port_out
option_strings:
- --port-out
required: false
type: int
- choices: null
default: 0.0.0.0
default_random: false
help: host address for input, by default it is 0.0.0.0
name: host_in
option_strings:
- --host-in
required: false
type: str
- choices: null
default: 0.0.0.0
default_random: false
help: host address for output, by default it is 0.0.0.0
name: host_out
option_strings:
- --host-out
required: false
type: str
- 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
default_random: false
help: socket type for input port
name: socket_in
option_strings:
- --socket-in
required: false
type: method
- 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
default_random: false
help: socket type for output port
name: socket_out
option_strings:
- --socket-out
required: false
type: method
- choices: null
default: 44131
default_random: true
help: port for controlling the pod, default a random port between [49152, 65535]
name: port_ctrl
option_strings:
- --port-ctrl
required: false
type: int
- choices: null
default: false
default_random: false
help: use ipc protocol for control socket
name: ctrl_with_ipc
option_strings:
- --ctrl-with-ipc
required: false
type: bool
- choices: null
default: -1
default_random: false
help: timeout (ms) of all requests, -1 for waiting forever
name: timeout
option_strings:
- --timeout
required: false
type: int
- choices: null
default: 5000
default_random: false
help: timeout (ms) of the control request, -1 for waiting forever
name: timeout_ctrl
option_strings:
- --timeout-ctrl
required: false
type: int
- choices: null
default: 10000
default_random: false
help: timeout (ms) of a pea is ready for request, -1 for waiting forever
name: timeout_ready
option_strings:
- --timeout-ready
required: false
type: int
- choices: null
default: 240
default_random: false
help: 'serialize the model in the pod every n seconds if model changes. -1 means
--read-only. '
name: dump_interval
option_strings:
- --dump-interval
required: false
type: int
- choices: null
default: false
default_random: false
help: do not serialize the model when the pod exits
name: exit_no_dump
option_strings:
- --exit-no-dump
required: false
type: bool
- choices: null
default: false
default_random: false
help: do not allow the pod to modify the model, dump_interval will be ignored
name: read_only
option_strings:
- --read-only
required: false
type: bool
- choices: null
default: false
default_random: false
help: the data and config files are separated for each pea in this pod, only effective
when BasePod's `parallel` > 1
name: separated_workspace
option_strings:
- --separated-workspace
required: false
type: bool
- choices: null
default: -1
default_random: false
help: ==SUPPRESS==
name: pea_id
option_strings:
- --pea-id
required: false
type: int
- choices: null
default: 0
default_random: false
help: ==SUPPRESS==
name: num_part
option_strings:
- --num-part
required: false
type: int
- choices:
- SINGLETON
- HEAD
- TAIL
- PARALLEL
default: null
default_random: false
help: ==SUPPRESS==
name: role
option_strings:
- --role
required: false
type: method
- choices:
- NONE
- EXECUTOR
- HANDLE
default: NONE
default_random: false
help: skip strategy on error message.
name: skip_on_error
option_strings:
- --skip-on-error
required: false
type: method
- choices: null
default: -1
default_random: false
help: memory high watermark of this pod in Gigabytes, pod will restart when this
is reached. -1 means no restriction
name: memory_hwm
option_strings:
- --memory-hwm
required: false
type: int
- choices:
- thread
- process
default: process
default_random: false
help: the parallel runtime of the pod
name: runtime
option_strings:
- --runtime
required: false
type: str
- choices: null
default: 60
default_random: false
help: label this pea as inactive when it does not process any request after certain
time (in second)
name: max_idle_time
option_strings:
- --max-idle-time
required: false
type: int
- choices: null
default: false
default_random: false
help: when a process exits, it attempts to terminate all of its daemonic child
processes. setting it to true basically tell the context manager do not wait
on this Pea
name: daemon
option_strings:
- --daemon
required: false
type: bool
- choices: null
default: /opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml
default_random: false
help: the yaml config of the logger. note the executor inside will inherit this
log config
name: log_config
option_strings:
- --log-config
required: false
type: str
- choices: null
default: false
default_random: false
help: ==SUPPRESS==
name: log_remote
option_strings:
- --log-remote
required: false
type: bool
- choices: null
default: null
default_random: false
help: the SSH server through which the tunnel will be created, can actually be
a fully specified "user@server:port" ssh url.
name: ssh_server
option_strings:
- --ssh-server
required: false
type: str
- choices: null
default: null
default_random: false
help: this specifies a key to be used in ssh login, default None. regular default
ssh keys will be used without specifying this argument.
name: ssh_keyfile
option_strings:
- --ssh-keyfile
required: false
type: str
- choices: null
default: null
default_random: false
help: ssh password to the ssh server.
name: ssh_password
option_strings:
- --ssh-password
required: false
type: str
- choices: null
default: 0.0.0.0
default_random: false
help: host address of the pea/gateway, by default it is 0.0.0.0.
name: host
option_strings:
- --host
required: false
type: str
- choices: null
default: 47891
default_random: true
help: host port of the gateway, "port-grpc" alias will be removed in future versions
name: port_expose
option_strings:
- --port-expose
- --port-grpc
required: false
type: int
- choices: null
default: -1
default_random: false
help: maximum send and receive size for grpc server in bytes, -1 means unlimited
name: max_message_size
option_strings:
- --max-message-size
required: false
type: int
- choices: null
default: false
default_random: false
help: respect the http_proxy and https_proxy environment variables. otherwise,
it will unset these proxy variables before start. gRPC seems to prefer no proxy
name: proxy
option_strings:
- --proxy
required: false
type: bool
- choices: null
default: 1
default_random: false
help: 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
name: parallel
option_strings:
- --parallel
- --shards
required: false
type: int
- choices:
- ANY
- ALL
- ALL_ASYNC
default: ANY
default_random: false
help: 'ANY: only one (whoever is idle) replica polls the message; ALL: all workers
poll the message (like a broadcast)'
name: polling
option_strings:
- --polling
required: false
type: method
- choices:
- LOAD_BALANCE
- ROUND_ROBIN
default: LOAD_BALANCE
default_random: false
help: the strategy of scheduling workload among peas
name: scheduling
option_strings:
- --scheduling
required: false
type: method
- choices: null
default: null
default_random: false
help: the executor used before sending to all parallels, accepted type follows
"--uses"
name: uses_before
option_strings:
- --uses-before
required: false
type: str
- choices: null
default: null
default_random: false
help: the executor used after receiving from all parallels, accepted type follows
"--uses"
name: uses_after
option_strings:
- --uses-after
required: false
type: str
- choices: null
default: false
default_random: false
help: shutdown this pod when all peas are idle
name: shutdown_idle
option_strings:
- --shutdown-idle
required: false
type: bool
- name: flow
options:
- choices: null
default: null
default_random: false
help: a yaml file represents a flow
name: uses
option_strings:
- --uses
required: false
type: str
- choices: null
default: false
default_random: false
help: start a log server for the dashboard
name: logserver
option_strings:
- --logserver
required: false
type: bool
- choices: null
default: /opt/hostedtoolcache/Python/3.7.9/x64/lib/python3.7/site-packages/jina/resources/logserver.default.yml
default_random: false
help: the yaml config of the log server
name: logserver_config
option_strings:
- --logserver-config
required: false
type: str
- choices: null
default: 95435f6324db11ebb786000d3a1c5bc5
default_random: true
help: ==SUPPRESS==
name: log_id
option_strings:
- --log-id
required: false
type: str
- choices: null
default: NONE
default_random: false
help: ==SUPPRESS==
name: optimize_level
option_strings:
- --optimize-level
required: false
type: method
- choices:
- SHELL_PROC
- SHELL_DOCKER
- DOCKER_SWARM
- K8S
default: SHELL_PROC
default_random: false
help: type of the output
name: output_type
option_strings:
- --output-type
required: false
type: method
- choices: null
default: null
default_random: false
help: output path of the flow
name: output_path
option_strings:
- --output-path
required: false
type: FileType
- choices:
- HANG
- REMOVE
- COLLECT
default: COLLECT
default_random: false
help: strategy on those inspect pods in the flow. if REMOVE is given then all
inspect pods are removed when building the flow
name: inspect
option_strings:
- --inspect
required: false
type: method
- name: gateway
options:
- choices: null
default: gateway
default_random: false
help: the name of this pea, used to identify the pod and its logs.
name: name
option_strings:
- --name
required: false
type: str
- choices: null
default: 95435f7424db11ebb786000d3a1c5bc5
default_random: true
help: the identity of the sockets, default a random string (Important for load
balancing messages
name: identity
option_strings:
- --identity
required: false
type: str
- choices: null
default: 95435f7524db11ebb786000d3a1c5bc5
default_random: true
help: ==SUPPRESS==
name: log_id
option_strings:
- --log-id
required: false
type: str
- choices: null
default: _pass
default_random: false
help: the config of the executor, it could be > a YAML file path, > a supported
executor's class name, > one of "_clear", "_pass", "_logforward" > the content
of YAML config (must starts with "!")> a docker image
name: uses
option_strings:
- --uses
required: false
type: str
- choices: null
default: null
default_random: false
help: the customized python modules need to be imported before loading the executor
name: py_modules
option_strings:
- --py-modules
required: false
type: str
- choices: null
default: BaseExecutor
default_random: false
help: 'The executor config that is passed to the docker image if a docker image
is used in uses. It cannot be another docker image '
name: uses_internal
option_strings:
- --uses-internal
required: false
type: str
- choices: null
default: null
default_random: false
help: the entrypoint command overrides the ENTRYPOINT in docker image. when not
set then the docker image ENTRYPOINT takes effective.
name: entrypoint
option_strings:
- --entrypoint
required: false
type: str
- choices: null
default: false
default_random: false
help: pull the latest image before running
name: pull_latest
option_strings:
- --pull-latest
required: false
type: bool
- choices: null
default: null
default_random: false
help: the path on the host to be mounted inside the container. they will be mounted
to the root path, i.e. /user/test/my-workspace will be mounted to /my-workspace
inside the container. all volumes are mounted with read-write mode.
name: volumes
option_strings:
- --volumes
required: false
type: str
- choices: null
default: 39423
default_random: true
help: port for input data, default a random port between [49152, 65535]
name: port_in
option_strings:
- --port-in
required: false
type: int
- choices: null
default: 51595
default_random: true
help: port for output data, default a random port between [49152, 65535]
name: port_out
option_strings:
- --port-out
required: false
type: int
- choices: null
default: 0.0.0.0
default_random: false
help: host address for input, by default it is 0.0.0.0
name: host_in
option_strings:
- --host-in
required: false
type: str
- choices: null
default: 0.0.0.0
default_random: false
help: host address for output, by default it is 0.0.0.0
name: host_out
option_strings:
- --host-out
required: false
type: str
- 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
default_random: false
help: socket type for input port
name: socket_in
option_strings:
- --socket-in
required: false
type: method
- 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
default_random: false
help: socket type for output port
name: socket_out
option_strings:
- --socket-out
required: false
type: method
- choices: null
default: 34361
default_random: true
help: port for controlling the pod, default a random port between [49152, 65535]
name: port_ctrl
option_strings:
- --port-ctrl
required: false
type: int
- choices: null
default: true
default_random: false
help: use ipc protocol for control socket
name: ctrl_with_ipc
option_strings:
- --ctrl-with-ipc
required: false
type: bool
- choices: null
default: -1
default_random: false
help: timeout (ms) of all requests, -1 for waiting forever
name: timeout
option_strings:
- --timeout
required: false
type: int
- choices: null
default: 5000
default_random: false
help: timeout (ms) of the control request, -1 for waiting forever
name: timeout_ctrl
option_strings:
- --timeout-ctrl
required: false
type: int
- choices: null
default: 10000
default_random: false
help: timeout (ms) of a pea is ready for request, -1 for waiting forever
name: timeout_ready
option_strings:
- --timeout-ready
required: false
type: int
- choices: null
default: 240
default_random: false
help: 'serialize the model in the pod every n seconds if model changes. -1 means
--read-only. '
name: dump_interval
option_strings:
- --dump-interval
required: false
type: int
- choices: null
default: false
default_random: false
help: do not serialize the model when the pod exits
name: exit_no_dump
option_strings:
- --exit-no-dump
required: false
type: bool
- choices: null
default: true
default_random: false
help: do not allow the pod to modify the model, dump_interval will be ignored
name: read_only
option_strings:
- --read-only
required: false
type: bool
- choices: null
default: false
default_random: false
help: the data and config files are separated for each pea in this pod, only effective
when BasePod's `parallel` > 1
name: separated_workspace
option_strings:
- --separated-workspace
required: false
type: bool
- choices: null
default: -1
default_random: false
help: ==SUPPRESS==
name: pea_id
option_strings:
- --pea-id
required: false
type: int
- choices: null
default: 0
default_random: false
help: ==SUPPRESS==
name: num_part
option_strings:
- --num-part
required: false
type: int
- choices:
- SINGLETON
- HEAD
- TAIL
- PARALLEL
default: null
default_random: false
help: ==SUPPRESS==
name: role
option_strings:
- --role
required: false
type: method
- choices:
- NONE
- EXECUTOR
- HANDLE
default: NONE
default_random: false
help: skip strategy on error message.
name: skip_on_error
option_strings:
- --skip-on-error
required: false
type: method
- choices: null
default: -1