jina hello-world
¶
Start the hello-world demo, a simple end2end image index and search demo without any extra dependencies.
usage: jina hello-world [-h] [--workdir] [--logserver] [--logserver-config]
[--download-proxy] [--shards] [--parallel]
[--uses-index] [--index-data-url] [--index-labels-url]
[--index-batch-size] [--uses-query] [--query-data-url]
[--query-labels-url] [--query-batch-size]
[--num-query] [--top-k]
General arguments¶
- --workdir
the workdir for hello-world demo, all data, indices, shards and outputs will be saved there
Default: “f8afe144-539b-11eb-8633-0022481fbd6d”
- --logserver
start a log server for the dashboard
Default: False
- --logserver-config
the yaml config of the log server
Default: “/home/runner/work/jina/jina/jina/resources/logserver.default.yml”
- --download-proxy
specify the proxy when downloading sample data
Scalability arguments¶
- --shards
number of shards when index and query
Default: 2
- --parallel
number of parallel when index and query
Default: 2
Index arguments¶
- --uses-index
the yaml path of the index flow
Default: “/home/runner/work/jina/jina/jina/resources/helloworld.flow.index.yml”
- --index-data-url
the url of index data (should be in idx3-ubyte.gz format)
Default: “http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-images-idx3-ubyte.gz”
- --index-labels-url
the url of index labels data (should be in idx3-ubyte.gz format)
Default: “http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-labels-idx1-ubyte.gz”
- --index-batch-size
the batch size in indexing
Default: 1024
Search arguments¶
- --uses-query
the yaml path of the query flow
Default: “/home/runner/work/jina/jina/jina/resources/helloworld.flow.query.yml”
- --query-data-url
the url of query data (should be in idx3-ubyte.gz format)
Default: “http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-images-idx3-ubyte.gz”
- --query-labels-url
the url of query labels data (should be in idx3-ubyte.gz format)
Default: “http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-labels-idx1-ubyte.gz”
- --query-batch-size
the batch size in searching
Default: 32
- --num-query
number of queries to visualize
Default: 128
- --top-k
top-k results to retrieve and visualize
Default: 50