3.1.1.json

{"authors": "dev-team@jina.ai", "description": "Cloud-native neural search framework for any kind of data", "docs": "https://docs.jina.ai", "license": "Apache 2.0", "methods": [{"help": "Start hello world demos.", "methods": [{"help": "Run a fashion search demo", "name": "fashion", "options": [{"choices": null, "default": "0e3df9055b604783b169503772ee9c4c", "default_random": false, "help": "The workdir for hello-world demoall data, indices, shards and outputs will be saved there", "name": "workdir", "option_strings": ["--workdir"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The proxy when downloading sample data", "name": "download_proxy", "option_strings": ["--download-proxy"], "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": "http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/train-labels-idx1-ubyte.gz", "default_random": false, "help": "The url of index labels data (should be in idx3-ubyte.gz format)", "name": "index_labels_url", "option_strings": ["--index-labels-url"], "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": "http://fashion-mnist.s3-website.eu-central-1.amazonaws.com/t10k-labels-idx1-ubyte.gz", "default_random": false, "help": "The url of query labels data (should be in idx3-ubyte.gz format)", "name": "query_labels_url", "option_strings": ["--query-labels-url"], "required": false, "type": "str"}, {"choices": null, "default": 128, "default_random": false, "help": "The 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"}]}, {"help": "Run a chatbot QA demo", "name": "chatbot", "options": [{"choices": null, "default": "88993b6c70824083a0fde00088ef70d6", "default_random": false, "help": "The workdir for hello-world demoall data, indices, shards and outputs will be saved there", "name": "workdir", "option_strings": ["--workdir"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The proxy when downloading sample data", "name": "download_proxy", "option_strings": ["--download-proxy"], "required": false, "type": "str"}, {"choices": null, "default": "https://static.jina.ai/chatbot/dataset.csv", "default_random": false, "help": "The url of index csv data", "name": "index_data_url", "option_strings": ["--index-data-url"], "required": false, "type": "str"}, {"choices": null, "default": 8080, "default_random": false, "help": "The port of the host exposed to the public", "name": "port", "option_strings": ["--port"], "required": false, "type": "int"}, {"choices": null, "default": 2, "default_random": false, "help": "The number of replicas when index and query", "name": "replicas", "option_strings": ["--replicas"], "required": false, "type": "int"}]}, {"help": "Run a multimodal search demo", "name": "multimodal", "options": [{"choices": null, "default": "178251a73385426cad5ee0448572ccb6", "default_random": false, "help": "The workdir for hello-world demoall data, indices, shards and outputs will be saved there", "name": "workdir", "option_strings": ["--workdir"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The proxy when downloading sample data", "name": "download_proxy", "option_strings": ["--download-proxy"], "required": false, "type": "str"}, {"choices": null, "default": "https://static.jina.ai/multimodal/people-img.zip", "default_random": false, "help": "The url of index csv data", "name": "index_data_url", "option_strings": ["--index-data-url"], "required": false, "type": "str"}, {"choices": null, "default": 8080, "default_random": false, "help": "The port of the host exposed to the public", "name": "port", "option_strings": ["--port"], "required": false, "type": "int"}]}, {"help": "Fork a hello world project to a local directory.", "name": "fork", "options": [{"choices": ["fashion", "chatbot", "multimodal"], "default": null, "default_random": false, "help": "The hello world project to fork", "name": "project", "option_strings": [], "required": true, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The dest directory of the forked project. Note, it can not be an existing path.", "name": "destination", "option_strings": [], "required": true, "type": "str"}]}], "name": "hello", "options": []}, {"help": "Start an Executor. Executor is how Jina processes Document.", "name": "executor", "options": [{"choices": null, "default": null, "default_random": false, "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                    ", "name": "name", "option_strings": ["--name"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The working directory for any IO operations in this object. If not set, then derive from its parent `workspace`.", "name": "workspace", "option_strings": ["--workspace"], "required": false, "type": "str"}, {"choices": null, "default": "/opt/hostedtoolcache/Python/3.7.12/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml", "default_random": false, "help": "The YAML config of the logger used in this object.", "name": "log_config", "option_strings": ["--log-config"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "If set, then no log will be emitted from this object.", "name": "quiet", "option_strings": ["--quiet"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, then exception stack information will not be added to the log", "name": "quiet_error", "option_strings": ["--quiet-error"], "required": false, "type": "bool"}, {"choices": null, "default": 60, "default_random": false, "help": "The timeout in milliseconds of the control request, -1 for waiting forever", "name": "timeout_ctrl", "option_strings": ["--timeout-ctrl"], "required": false, "type": "int"}, {"choices": null, "default": "ANY", "default_random": false, "help": "\n    The polling strategy of the Deployment and its endpoints (when `shards>1`).\n    Can be defined for all endpoints of a Deployment or by endpoint.\n    Define per Deployment:\n    - ANY: only one (whoever is idle) Pod polls the message\n    - ALL: all Pods poll the message (like a broadcast)\n    Define per Endpoint:\n    JSON dict, {endpoint: PollingType}\n    {'/custom': 'ALL', '/search': 'ANY', '*': 'ANY'}\n    \n    ", "name": "polling", "option_strings": ["--polling"], "required": false, "type": "str"}, {"choices": null, "default": "BaseExecutor", "default_random": false, "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        ", "name": "uses", "option_strings": ["--uses"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "\n    Dictionary of keyword arguments that will override the `with` configuration in `uses`\n    ", "name": "uses_with", "option_strings": ["--uses-with"], "required": false, "type": "dict"}, {"choices": null, "default": null, "default_random": false, "help": "\n    Dictionary of keyword arguments that will override the `metas` configuration in `uses`\n    ", "name": "uses_metas", "option_strings": ["--uses-metas"], "required": false, "type": "dict"}, {"choices": null, "default": null, "default_random": false, "help": "\n        Dictionary of keyword arguments that will override the `requests` configuration in `uses`\n        ", "name": "uses_requests", "option_strings": ["--uses-requests"], "required": false, "type": "dict"}, {"choices": null, "default": null, "default_random": false, "help": "\nThe customized python modules need to be imported before loading the executor\n\nNote that the recommended way is to only import a single module - a simple python file, if your\nexecutor can be defined in a single file, or an ``__init__.py`` file if you have multiple files,\nwhich should be structured as a python package. For more details, please see the\n`Executor cookbook <https://docs.jina.ai/fundamentals/executor/repository-structure/>`__\n", "name": "py_modules", "option_strings": ["--py-modules"], "required": false, "type": "typing.List[str]"}, {"choices": null, "default": 50859, "default_factory": "random_port", "default_random": true, "help": "The port for input data to bind to, default a random port between [49152, 65535]", "name": "port", "option_strings": ["--port-in"], "required": false, "type": "int"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "The host address for binding to, by default it is 0.0.0.0", "name": "host_in", "option_strings": ["--host-in"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "If set, only native Executors is allowed, and the Executor is always run inside WorkerRuntime.", "name": "native", "option_strings": ["--native"], "required": false, "type": "bool"}, {"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": null, "default_random": false, "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", "name": "docker_kwargs", "option_strings": ["--docker-kwargs"], "required": false, "type": "dict"}, {"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": "\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", "name": "volumes", "option_strings": ["--volumes"], "required": false, "type": "typing.List[str]"}, {"choices": null, "default": null, "default_random": false, "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    ", "name": "gpus", "option_strings": ["--gpus"], "required": false, "type": "str"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "The host address of the runtime, by default it is 0.0.0.0.", "name": "host", "option_strings": ["--host"], "required": false, "type": "str"}, {"choices": null, "default": 8000, "default_random": false, "help": "The port of the remote machine for usage with JinaD.", "name": "port_jinad", "option_strings": ["--port-jinad"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "Do not display the streaming of remote logs on local console", "name": "quiet_remote_logs", "option_strings": ["--quiet-remote-logs"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "\nThe files on the host to be uploaded to the remote\nworkspace. This can be useful when your Deployment has more\nfile dependencies beyond a single YAML file, e.g.\nPython files, data files.\n\nNote,\n- 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.\n- by default, `--uses` YAML file is always uploaded.\n- 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.\n", "name": "upload_files", "option_strings": ["--upload-files"], "required": false, "type": "typing.List[str]"}, {"choices": null, "default": false, "default_random": false, "help": "The Pod attempts to terminate all of its Runtime child processes/threads on existing. setting it to true basically tell the Pod do not wait on the Runtime when closing", "name": "daemon", "option_strings": ["--daemon"], "required": false, "type": "bool"}, {"choices": ["THREAD", "PROCESS"], "default": "PROCESS", "default_random": false, "help": "The parallel backend of the runtime inside the Pod", "name": "runtime_backend", "option_strings": ["--runtime-backend", "--runtime"], "required": false, "type": "str"}, {"choices": null, "default": "WorkerRuntime", "default_random": false, "help": "The runtime class to run inside the Pod", "name": "runtime_cls", "option_strings": ["--runtime-cls"], "required": false, "type": "str"}, {"choices": null, "default": 600000, "default_random": false, "help": "The timeout in milliseconds of a Pod waits for the runtime to be ready, -1 for waiting forever", "name": "timeout_ready", "option_strings": ["--timeout-ready"], "required": false, "type": "int"}, {"choices": null, "default": null, "default_random": false, "help": "The map of environment variables that are available inside runtime", "name": "env", "option_strings": ["--env"], "required": false, "type": "dict"}, {"choices": null, "default": false, "default_random": false, "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 Pod will receive input connections from remote Pods", "name": "expose_public", "option_strings": ["--expose-public"], "required": false, "type": "bool"}, {"choices": null, "default": 1, "default_random": false, "help": "The number of shards in the deployment running at the same time. For more details check https://docs.jina.ai/fundamentals/flow/create-flow/#complex-flow-topologies", "name": "shards", "option_strings": ["--shards"], "required": false, "type": "int"}, {"choices": null, "default": 1, "default_random": false, "help": "The number of replicas in the deployment", "name": "replicas", "option_strings": ["--replicas"], "required": false, "type": "int"}, {"choices": null, "default": 54021, "default_factory": "random_port", "default_random": true, "help": "The port for input data to bind to, default is a random port between [49152, 65535]", "name": "port", "option_strings": ["--port"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "If set, install `requirements.txt` in the Hub Executor bundle to local", "name": "install_requirements", "option_strings": ["--install-requirements"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, always pull the latest Hub Executor bundle even it exists on local", "name": "force_update", "option_strings": ["--force-update", "--force"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "The address of the uses-before runtime", "name": "uses_before_address", "option_strings": ["--uses-before-address"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The address of the uses-before runtime", "name": "uses_after_address", "option_strings": ["--uses-after-address"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "dictionary JSON with a list of connections to configure", "name": "connection_list", "option_strings": ["--connection-list"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "Disable the built-in reduce mechanism, set this if the reduction is to be handled by the Executor connected to this Head", "name": "disable_reduce", "option_strings": ["--disable-reduce"], "required": false, "type": "bool"}]}, {"help": "Start a Flow. Flow is how Jina streamlines and distributes Executors.", "name": "flow", "options": [{"choices": null, "default": null, "default_random": false, "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                    ", "name": "name", "option_strings": ["--name"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The working directory for any IO operations in this object. If not set, then derive from its parent `workspace`.", "name": "workspace", "option_strings": ["--workspace"], "required": false, "type": "str"}, {"choices": null, "default": "/opt/hostedtoolcache/Python/3.7.12/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml", "default_random": false, "help": "The YAML config of the logger used in this object.", "name": "log_config", "option_strings": ["--log-config"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "If set, then no log will be emitted from this object.", "name": "quiet", "option_strings": ["--quiet"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, then exception stack information will not be added to the log", "name": "quiet_error", "option_strings": ["--quiet-error"], "required": false, "type": "bool"}, {"choices": null, "default": 60, "default_random": false, "help": "The timeout in milliseconds of the control request, -1 for waiting forever", "name": "timeout_ctrl", "option_strings": ["--timeout-ctrl"], "required": false, "type": "int"}, {"choices": null, "default": "ANY", "default_random": false, "help": "\n    The polling strategy of the Deployment and its endpoints (when `shards>1`).\n    Can be defined for all endpoints of a Deployment or by endpoint.\n    Define per Deployment:\n    - ANY: only one (whoever is idle) Pod polls the message\n    - ALL: all Pods poll the message (like a broadcast)\n    Define per Endpoint:\n    JSON dict, {endpoint: PollingType}\n    {'/custom': 'ALL', '/search': 'ANY', '*': 'ANY'}\n    \n    ", "name": "polling", "option_strings": ["--polling"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "If set, /graphql endpoint is removed from HTTP interface. ", "name": "no_graphql_endpoint", "option_strings": ["--no-graphql-endpoint"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "The YAML file represents a flow", "name": "uses", "option_strings": ["--uses"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The map of environment variables that are available inside runtime", "name": "env", "option_strings": ["--env"], "required": false, "type": "dict"}, {"choices": ["HANG", "REMOVE", "COLLECT"], "default": "COLLECT", "default_random": false, "help": "\n    The strategy on those inspect deployments in the flow.\n\n    If `REMOVE` is given then all inspect deployments are removed when building the flow.\n    ", "name": "inspect", "option_strings": ["--inspect"], "required": false, "type": "str"}]}, {"help": "Ping a Deployment and check its network connectivity.", "name": "ping", "options": [{"choices": null, "default": null, "default_random": false, "help": "The host address of the target Pod, e.g. 0.0.0.0", "name": "host", "option_strings": [], "required": true, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The control port of the target deployment/pod", "name": "port", "option_strings": [], "required": true, "type": "int"}, {"choices": null, "default": 3000, "default_random": false, "help": "\nTimeout in millisecond of one check\n-1 for waiting forever\n", "name": "timeout", "option_strings": ["--timeout"], "required": false, "type": "int"}, {"choices": null, "default": 3, "default_random": false, "help": "The max number of tried health checks before exit with exit code 1", "name": "retries", "option_strings": ["--retries"], "required": false, "type": "int"}]}, {"help": "Create a new Jina toy project with the predefined template.", "name": "new", "options": [{"choices": null, "default": "hello-jina", "default_random": false, "help": "The name of the project", "name": "name", "option_strings": [], "required": true, "type": "str"}]}, {"help": "Start a Gateway that receives client Requests via gRPC/REST interface", "name": "gateway", "options": [{"choices": null, "default": "gateway", "default_random": false, "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                    ", "name": "name", "option_strings": ["--name"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The working directory for any IO operations in this object. If not set, then derive from its parent `workspace`.", "name": "workspace", "option_strings": ["--workspace"], "required": false, "type": "str"}, {"choices": null, "default": "/opt/hostedtoolcache/Python/3.7.12/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml", "default_random": false, "help": "The YAML config of the logger used in this object.", "name": "log_config", "option_strings": ["--log-config"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "If set, then no log will be emitted from this object.", "name": "quiet", "option_strings": ["--quiet"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, then exception stack information will not be added to the log", "name": "quiet_error", "option_strings": ["--quiet-error"], "required": false, "type": "bool"}, {"choices": null, "default": 60, "default_random": false, "help": "The timeout in milliseconds of the control request, -1 for waiting forever", "name": "timeout_ctrl", "option_strings": ["--timeout-ctrl"], "required": false, "type": "int"}, {"choices": null, "default": "ANY", "default_random": false, "help": "\n    The polling strategy of the Deployment and its endpoints (when `shards>1`).\n    Can be defined for all endpoints of a Deployment or by endpoint.\n    Define per Deployment:\n    - ANY: only one (whoever is idle) Pod polls the message\n    - ALL: all Pods poll the message (like a broadcast)\n    Define per Endpoint:\n    JSON dict, {endpoint: PollingType}\n    {'/custom': 'ALL', '/search': 'ANY', '*': 'ANY'}\n    \n    ", "name": "polling", "option_strings": ["--polling"], "required": false, "type": "str"}, {"choices": null, "default": "BaseExecutor", "default_random": false, "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        ", "name": "uses", "option_strings": ["--uses"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "\n    Dictionary of keyword arguments that will override the `with` configuration in `uses`\n    ", "name": "uses_with", "option_strings": ["--uses-with"], "required": false, "type": "dict"}, {"choices": null, "default": null, "default_random": false, "help": "\n    Dictionary of keyword arguments that will override the `metas` configuration in `uses`\n    ", "name": "uses_metas", "option_strings": ["--uses-metas"], "required": false, "type": "dict"}, {"choices": null, "default": null, "default_random": false, "help": "\n        Dictionary of keyword arguments that will override the `requests` configuration in `uses`\n        ", "name": "uses_requests", "option_strings": ["--uses-requests"], "required": false, "type": "dict"}, {"choices": null, "default": null, "default_random": false, "help": "\nThe customized python modules need to be imported before loading the executor\n\nNote that the recommended way is to only import a single module - a simple python file, if your\nexecutor can be defined in a single file, or an ``__init__.py`` file if you have multiple files,\nwhich should be structured as a python package. For more details, please see the\n`Executor cookbook <https://docs.jina.ai/fundamentals/executor/repository-structure/>`__\n", "name": "py_modules", "option_strings": ["--py-modules"], "required": false, "type": "typing.List[str]"}, {"choices": null, "default": 56947, "default_factory": "random_port", "default_random": true, "help": "The port for input data to bind to, default a random port between [49152, 65535]", "name": "port", "option_strings": ["--port-in"], "required": false, "type": "int"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "The host address for binding to, by default it is 0.0.0.0", "name": "host_in", "option_strings": ["--host-in"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "If set, only native Executors is allowed, and the Executor is always run inside WorkerRuntime.", "name": "native", "option_strings": ["--native"], "required": false, "type": "bool"}, {"choices": null, "default": 0, "default_random": false, "help": "\n    Number of requests fetched from the client before feeding into the first Executor. \n    \n    Used to control the speed of data input into a Flow. 0 disables prefetch (disabled by default)", "name": "prefetch", "option_strings": ["--prefetch"], "required": false, "type": "int"}, {"choices": null, "default": null, "default_random": false, "help": "The title of this HTTP server. It will be used in automatics docs such as Swagger UI.", "name": "title", "option_strings": ["--title"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The description of this HTTP server. It will be used in automatics docs such as Swagger UI.", "name": "description", "option_strings": ["--description"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "\n        If set, a CORS middleware is added to FastAPI frontend to allow cross-origin access.\n        ", "name": "cors", "option_strings": ["--cors"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, the default swagger ui is used for `/docs` endpoint. ", "name": "default_swagger_ui", "option_strings": ["--default-swagger-ui"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, /status /post endpoints are removed from HTTP interface. ", "name": "no_debug_endpoints", "option_strings": ["--no-debug-endpoints"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "\n        If set, /index, /search, /update, /delete endpoints are removed from HTTP interface.\n\n        Any executor that has `@requests(on=...)` bind with those values will receive data requests.\n        ", "name": "no_crud_endpoints", "option_strings": ["--no-crud-endpoints"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "\n        A JSON string that represents a map from executor endpoints (`@requests(on=...)`) to HTTP endpoints.\n        ", "name": "expose_endpoints", "option_strings": ["--expose-endpoints"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "\nDictionary of kwargs arguments that will be passed to Uvicorn server when starting the server\n\nMore details can be found in Uvicorn docs: https://www.uvicorn.org/settings/\n\n", "name": "uvicorn_kwargs", "option_strings": ["--uvicorn-kwargs"], "required": false, "type": "dict"}, {"choices": null, "default": false, "default_random": false, "help": "If set, /graphql endpoint is removed from HTTP interface. ", "name": "no_graphql_endpoint", "option_strings": ["--no-graphql-endpoint"], "required": false, "type": "bool"}, {"choices": ["NONE", "LZ4", "ZLIB", "GZIP", "BZ2", "LZMA"], "default": "NONE", "default_random": false, "help": "\n    The compress algorithm used over the entire Flow.\n\n    Note that this is not necessarily effective,\n    it depends on the settings of `--compress-min-bytes` and `compress-min-ratio`", "name": "compress", "option_strings": ["--compress"], "required": false, "type": "str"}, {"choices": null, "default": 1024, "default_random": false, "help": "The original message size must be larger than this number to trigger the compress algorithm, -1 means disable compression.", "name": "compress_min_bytes", "option_strings": ["--compress-min-bytes"], "required": false, "type": "int"}, {"choices": null, "default": 1.1, "default_random": false, "help": "The compression ratio (uncompressed_size/compressed_size) must be higher than this number to trigger the compress algorithm.", "name": "compress_min_ratio", "option_strings": ["--compress-min-ratio"], "required": false, "type": "float"}, {"choices": ["GRPC", "HTTP", "WEBSOCKET"], "default": "GRPC", "default_random": false, "help": "Communication protocol between server and client.", "name": "protocol", "option_strings": ["--protocol"], "required": false, "type": "str"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "The host address of the runtime, by default it is 0.0.0.0.", "name": "host", "option_strings": ["--host"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "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", "name": "proxy", "option_strings": ["--proxy"], "required": false, "type": "bool"}, {"choices": null, "default": 59448, "default_factory": "random_port", "default_random": true, "help": "The port that the gateway exposes for clients for GRPC connections.", "name": "port", "option_strings": ["--port-expose"], "required": false, "type": "int"}, {"choices": null, "default": "{}", "default_random": false, "help": "Routing graph for the gateway", "name": "graph_description", "option_strings": ["--graph-description"], "required": false, "type": "str"}, {"choices": null, "default": "{}", "default_random": false, "help": "dictionary JSON with the input addresses of each Deployment", "name": "deployments_addresses", "option_strings": ["--deployments-addresses"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "The Pod attempts to terminate all of its Runtime child processes/threads on existing. setting it to true basically tell the Pod do not wait on the Runtime when closing", "name": "daemon", "option_strings": ["--daemon"], "required": false, "type": "bool"}, {"choices": ["THREAD", "PROCESS"], "default": "PROCESS", "default_random": false, "help": "The parallel backend of the runtime inside the Pod", "name": "runtime_backend", "option_strings": ["--runtime-backend", "--runtime"], "required": false, "type": "str"}, {"choices": null, "default": "GRPCGatewayRuntime", "default_random": false, "help": "The runtime class to run inside the Pod", "name": "runtime_cls", "option_strings": ["--runtime-cls"], "required": false, "type": "str"}, {"choices": null, "default": 600000, "default_random": false, "help": "The timeout in milliseconds of a Pod waits for the runtime to be ready, -1 for waiting forever", "name": "timeout_ready", "option_strings": ["--timeout-ready"], "required": false, "type": "int"}, {"choices": null, "default": null, "default_random": false, "help": "The map of environment variables that are available inside runtime", "name": "env", "option_strings": ["--env"], "required": false, "type": "dict"}, {"choices": null, "default": false, "default_random": false, "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 Pod will receive input connections from remote Pods", "name": "expose_public", "option_strings": ["--expose-public"], "required": false, "type": "bool"}, {"choices": null, "default": 1, "default_random": false, "help": "The number of shards in the deployment running at the same time. For more details check https://docs.jina.ai/fundamentals/flow/create-flow/#complex-flow-topologies", "name": "shards", "option_strings": ["--shards"], "required": false, "type": "int"}, {"choices": null, "default": 1, "default_random": false, "help": "The number of replicas in the deployment", "name": "replicas", "option_strings": ["--replicas"], "required": false, "type": "int"}, {"choices": null, "default": 64148, "default_factory": "random_port", "default_random": true, "help": "The port for input data to bind to, default is a random port between [49152, 65535]", "name": "port", "option_strings": ["--port"], "required": false, "type": "int"}, {"choices": null, "default": null, "default_random": false, "help": "The address of the uses-before runtime", "name": "uses_before_address", "option_strings": ["--uses-before-address"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The address of the uses-before runtime", "name": "uses_after_address", "option_strings": ["--uses-after-address"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "dictionary JSON with a list of connections to configure", "name": "connection_list", "option_strings": ["--connection-list"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "Disable the built-in reduce mechanism, set this if the reduction is to be handled by the Executor connected to this Head", "name": "disable_reduce", "option_strings": ["--disable-reduce"], "required": false, "type": "bool"}]}, {"help": "Push/Pull an Executor to/from Jina Hub", "methods": [{"help": "Create a new executor using the template", "name": "new", "options": [{"choices": null, "default": null, "default_random": false, "help": "the name of the Executor", "name": "name", "option_strings": ["--name"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the path to store the Executor", "name": "path", "option_strings": ["--path"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "If set, always set up advance configuration like description, keywords and url", "name": "advance_configuration", "option_strings": ["--advance-configuration"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "the short description of the Executor", "name": "description", "option_strings": ["--description"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "some keywords to help people search your Executor (separated by comma)", "name": "keywords", "option_strings": ["--keywords"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "the URL of your GitHub repo", "name": "url", "option_strings": ["--url"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "If set, add a Dockerfile to the created Executor bundle", "name": "add_dockerfile", "option_strings": ["--add-dockerfile"], "required": false, "type": "bool"}]}, {"help": "Push an executor package to Jina hub", "name": "push", "options": [{"choices": null, "default": false, "default_random": false, "help": "If set, Hub executor usage will not be printed.", "name": "no_usage", "option_strings": ["--no-usage"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, more information will be printed.", "name": "verbose", "option_strings": ["--verbose"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "The Executor folder to be pushed to Jina Hub", "name": "path", "option_strings": [], "required": true, "type": "dir_path"}, {"choices": null, "default": null, "default_random": false, "help": "The file path to the Dockerfile (default is `${cwd}/Dockerfile`)", "name": "dockerfile", "option_strings": ["-f", "--dockerfile"], "required": false, "type": "None"}, {"choices": null, "default": null, "default_random": false, "help": "If set, push will overwrite the Executor on the Hub that shares the same NAME or UUID8 identifier", "name": "force_update", "option_strings": ["--force-update", "--force"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The secret for overwrite a Hub executor", "name": "secret", "option_strings": ["--secret"], "required": false, "type": "str"}, {"choices": null, "default": "==SUPPRESS==", "default_random": false, "help": "If set, the pushed executor is visible to public", "name": "public", "option_strings": ["--public"], "required": false, "type": "bool"}, {"choices": null, "default": "==SUPPRESS==", "default_random": false, "help": "If set, the pushed executor is invisible to public", "name": "private", "option_strings": ["--private"], "required": false, "type": "bool"}]}, {"help": "Download an executor image/package from Jina hub", "name": "pull", "options": [{"choices": null, "default": false, "default_random": false, "help": "If set, Hub executor usage will not be printed.", "name": "no_usage", "option_strings": ["--no-usage"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "The URI of the executor to pull (e.g., jinahub[+docker]://NAME)", "name": "uri", "option_strings": [], "required": true, "type": "hub_uri"}, {"choices": null, "default": false, "default_random": false, "help": "If set, install `requirements.txt` in the Hub Executor bundle to local", "name": "install_requirements", "option_strings": ["--install-requirements"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, always pull the latest Hub Executor bundle even it exists on local", "name": "force_update", "option_strings": ["--force-update", "--force"], "required": false, "type": "bool"}]}], "name": "hub", "options": []}, {"help": "Show help text of a CLI argument", "name": "help", "options": [{"choices": null, "default": null, "default_random": false, "help": "Lookup the usage & mention of the argument name in Jina API. The name can be fuzzy", "name": "query", "option_strings": [], "required": true, "type": "str"}]}, {"help": "Start a Pod. You should rarely use this directly unless you are doing low-level orchestration", "name": "pod", "options": [{"choices": null, "default": null, "default_random": false, "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                    ", "name": "name", "option_strings": ["--name"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The working directory for any IO operations in this object. If not set, then derive from its parent `workspace`.", "name": "workspace", "option_strings": ["--workspace"], "required": false, "type": "str"}, {"choices": null, "default": "/opt/hostedtoolcache/Python/3.7.12/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml", "default_random": false, "help": "The YAML config of the logger used in this object.", "name": "log_config", "option_strings": ["--log-config"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "If set, then no log will be emitted from this object.", "name": "quiet", "option_strings": ["--quiet"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, then exception stack information will not be added to the log", "name": "quiet_error", "option_strings": ["--quiet-error"], "required": false, "type": "bool"}, {"choices": null, "default": 60, "default_random": false, "help": "The timeout in milliseconds of the control request, -1 for waiting forever", "name": "timeout_ctrl", "option_strings": ["--timeout-ctrl"], "required": false, "type": "int"}, {"choices": null, "default": "ANY", "default_random": false, "help": "\n    The polling strategy of the Deployment and its endpoints (when `shards>1`).\n    Can be defined for all endpoints of a Deployment or by endpoint.\n    Define per Deployment:\n    - ANY: only one (whoever is idle) Pod polls the message\n    - ALL: all Pods poll the message (like a broadcast)\n    Define per Endpoint:\n    JSON dict, {endpoint: PollingType}\n    {'/custom': 'ALL', '/search': 'ANY', '*': 'ANY'}\n    \n    ", "name": "polling", "option_strings": ["--polling"], "required": false, "type": "str"}, {"choices": null, "default": "BaseExecutor", "default_random": false, "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        ", "name": "uses", "option_strings": ["--uses"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "\n    Dictionary of keyword arguments that will override the `with` configuration in `uses`\n    ", "name": "uses_with", "option_strings": ["--uses-with"], "required": false, "type": "dict"}, {"choices": null, "default": null, "default_random": false, "help": "\n    Dictionary of keyword arguments that will override the `metas` configuration in `uses`\n    ", "name": "uses_metas", "option_strings": ["--uses-metas"], "required": false, "type": "dict"}, {"choices": null, "default": null, "default_random": false, "help": "\n        Dictionary of keyword arguments that will override the `requests` configuration in `uses`\n        ", "name": "uses_requests", "option_strings": ["--uses-requests"], "required": false, "type": "dict"}, {"choices": null, "default": null, "default_random": false, "help": "\nThe customized python modules need to be imported before loading the executor\n\nNote that the recommended way is to only import a single module - a simple python file, if your\nexecutor can be defined in a single file, or an ``__init__.py`` file if you have multiple files,\nwhich should be structured as a python package. For more details, please see the\n`Executor cookbook <https://docs.jina.ai/fundamentals/executor/repository-structure/>`__\n", "name": "py_modules", "option_strings": ["--py-modules"], "required": false, "type": "typing.List[str]"}, {"choices": null, "default": 58838, "default_factory": "random_port", "default_random": true, "help": "The port for input data to bind to, default a random port between [49152, 65535]", "name": "port", "option_strings": ["--port-in"], "required": false, "type": "int"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "The host address for binding to, by default it is 0.0.0.0", "name": "host_in", "option_strings": ["--host-in"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "If set, only native Executors is allowed, and the Executor is always run inside WorkerRuntime.", "name": "native", "option_strings": ["--native"], "required": false, "type": "bool"}, {"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": null, "default_random": false, "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", "name": "docker_kwargs", "option_strings": ["--docker-kwargs"], "required": false, "type": "dict"}, {"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": "\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", "name": "volumes", "option_strings": ["--volumes"], "required": false, "type": "typing.List[str]"}, {"choices": null, "default": null, "default_random": false, "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    ", "name": "gpus", "option_strings": ["--gpus"], "required": false, "type": "str"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "The host address of the runtime, by default it is 0.0.0.0.", "name": "host", "option_strings": ["--host"], "required": false, "type": "str"}, {"choices": null, "default": 8000, "default_random": false, "help": "The port of the remote machine for usage with JinaD.", "name": "port_jinad", "option_strings": ["--port-jinad"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "Do not display the streaming of remote logs on local console", "name": "quiet_remote_logs", "option_strings": ["--quiet-remote-logs"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "\nThe files on the host to be uploaded to the remote\nworkspace. This can be useful when your Deployment has more\nfile dependencies beyond a single YAML file, e.g.\nPython files, data files.\n\nNote,\n- 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.\n- by default, `--uses` YAML file is always uploaded.\n- 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.\n", "name": "upload_files", "option_strings": ["--upload-files"], "required": false, "type": "typing.List[str]"}, {"choices": null, "default": false, "default_random": false, "help": "The Pod attempts to terminate all of its Runtime child processes/threads on existing. setting it to true basically tell the Pod do not wait on the Runtime when closing", "name": "daemon", "option_strings": ["--daemon"], "required": false, "type": "bool"}, {"choices": ["THREAD", "PROCESS"], "default": "PROCESS", "default_random": false, "help": "The parallel backend of the runtime inside the Pod", "name": "runtime_backend", "option_strings": ["--runtime-backend", "--runtime"], "required": false, "type": "str"}, {"choices": null, "default": "WorkerRuntime", "default_random": false, "help": "The runtime class to run inside the Pod", "name": "runtime_cls", "option_strings": ["--runtime-cls"], "required": false, "type": "str"}, {"choices": null, "default": 600000, "default_random": false, "help": "The timeout in milliseconds of a Pod waits for the runtime to be ready, -1 for waiting forever", "name": "timeout_ready", "option_strings": ["--timeout-ready"], "required": false, "type": "int"}, {"choices": null, "default": null, "default_random": false, "help": "The map of environment variables that are available inside runtime", "name": "env", "option_strings": ["--env"], "required": false, "type": "dict"}, {"choices": null, "default": false, "default_random": false, "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 Pod will receive input connections from remote Pods", "name": "expose_public", "option_strings": ["--expose-public"], "required": false, "type": "bool"}, {"choices": null, "default": 1, "default_random": false, "help": "The number of shards in the deployment running at the same time. For more details check https://docs.jina.ai/fundamentals/flow/create-flow/#complex-flow-topologies", "name": "shards", "option_strings": ["--shards"], "required": false, "type": "int"}, {"choices": null, "default": 1, "default_random": false, "help": "The number of replicas in the deployment", "name": "replicas", "option_strings": ["--replicas"], "required": false, "type": "int"}, {"choices": null, "default": 55025, "default_factory": "random_port", "default_random": true, "help": "The port for input data to bind to, default is a random port between [49152, 65535]", "name": "port", "option_strings": ["--port"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "If set, install `requirements.txt` in the Hub Executor bundle to local", "name": "install_requirements", "option_strings": ["--install-requirements"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, always pull the latest Hub Executor bundle even it exists on local", "name": "force_update", "option_strings": ["--force-update", "--force"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "The address of the uses-before runtime", "name": "uses_before_address", "option_strings": ["--uses-before-address"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The address of the uses-before runtime", "name": "uses_after_address", "option_strings": ["--uses-after-address"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "dictionary JSON with a list of connections to configure", "name": "connection_list", "option_strings": ["--connection-list"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "Disable the built-in reduce mechanism, set this if the reduction is to be handled by the Executor connected to this Head", "name": "disable_reduce", "option_strings": ["--disable-reduce"], "required": false, "type": "bool"}]}, {"help": "Start a Deployment. You should rarely use this directly unless you are doing low-level orchestration", "name": "deployment", "options": [{"choices": null, "default": null, "default_random": false, "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                    ", "name": "name", "option_strings": ["--name"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The working directory for any IO operations in this object. If not set, then derive from its parent `workspace`.", "name": "workspace", "option_strings": ["--workspace"], "required": false, "type": "str"}, {"choices": null, "default": "/opt/hostedtoolcache/Python/3.7.12/x64/lib/python3.7/site-packages/jina/resources/logging.default.yml", "default_random": false, "help": "The YAML config of the logger used in this object.", "name": "log_config", "option_strings": ["--log-config"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "If set, then no log will be emitted from this object.", "name": "quiet", "option_strings": ["--quiet"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, then exception stack information will not be added to the log", "name": "quiet_error", "option_strings": ["--quiet-error"], "required": false, "type": "bool"}, {"choices": null, "default": 60, "default_random": false, "help": "The timeout in milliseconds of the control request, -1 for waiting forever", "name": "timeout_ctrl", "option_strings": ["--timeout-ctrl"], "required": false, "type": "int"}, {"choices": null, "default": "ANY", "default_random": false, "help": "\n    The polling strategy of the Deployment and its endpoints (when `shards>1`).\n    Can be defined for all endpoints of a Deployment or by endpoint.\n    Define per Deployment:\n    - ANY: only one (whoever is idle) Pod polls the message\n    - ALL: all Pods poll the message (like a broadcast)\n    Define per Endpoint:\n    JSON dict, {endpoint: PollingType}\n    {'/custom': 'ALL', '/search': 'ANY', '*': 'ANY'}\n    \n    ", "name": "polling", "option_strings": ["--polling"], "required": false, "type": "str"}, {"choices": null, "default": "BaseExecutor", "default_random": false, "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        ", "name": "uses", "option_strings": ["--uses"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "\n    Dictionary of keyword arguments that will override the `with` configuration in `uses`\n    ", "name": "uses_with", "option_strings": ["--uses-with"], "required": false, "type": "dict"}, {"choices": null, "default": null, "default_random": false, "help": "\n    Dictionary of keyword arguments that will override the `metas` configuration in `uses`\n    ", "name": "uses_metas", "option_strings": ["--uses-metas"], "required": false, "type": "dict"}, {"choices": null, "default": null, "default_random": false, "help": "\n        Dictionary of keyword arguments that will override the `requests` configuration in `uses`\n        ", "name": "uses_requests", "option_strings": ["--uses-requests"], "required": false, "type": "dict"}, {"choices": null, "default": null, "default_random": false, "help": "\nThe customized python modules need to be imported before loading the executor\n\nNote that the recommended way is to only import a single module - a simple python file, if your\nexecutor can be defined in a single file, or an ``__init__.py`` file if you have multiple files,\nwhich should be structured as a python package. For more details, please see the\n`Executor cookbook <https://docs.jina.ai/fundamentals/executor/repository-structure/>`__\n", "name": "py_modules", "option_strings": ["--py-modules"], "required": false, "type": "typing.List[str]"}, {"choices": null, "default": 61464, "default_factory": "random_port", "default_random": true, "help": "The port for input data to bind to, default a random port between [49152, 65535]", "name": "port", "option_strings": ["--port-in"], "required": false, "type": "int"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "The host address for binding to, by default it is 0.0.0.0", "name": "host_in", "option_strings": ["--host-in"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "If set, only native Executors is allowed, and the Executor is always run inside WorkerRuntime.", "name": "native", "option_strings": ["--native"], "required": false, "type": "bool"}, {"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": null, "default_random": false, "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", "name": "docker_kwargs", "option_strings": ["--docker-kwargs"], "required": false, "type": "dict"}, {"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": "\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", "name": "volumes", "option_strings": ["--volumes"], "required": false, "type": "typing.List[str]"}, {"choices": null, "default": null, "default_random": false, "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    ", "name": "gpus", "option_strings": ["--gpus"], "required": false, "type": "str"}, {"choices": null, "default": "0.0.0.0", "default_random": false, "help": "The host address of the runtime, by default it is 0.0.0.0.", "name": "host", "option_strings": ["--host"], "required": false, "type": "str"}, {"choices": null, "default": 8000, "default_random": false, "help": "The port of the remote machine for usage with JinaD.", "name": "port_jinad", "option_strings": ["--port-jinad"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "Do not display the streaming of remote logs on local console", "name": "quiet_remote_logs", "option_strings": ["--quiet-remote-logs"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "\nThe files on the host to be uploaded to the remote\nworkspace. This can be useful when your Deployment has more\nfile dependencies beyond a single YAML file, e.g.\nPython files, data files.\n\nNote,\n- 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.\n- by default, `--uses` YAML file is always uploaded.\n- 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.\n", "name": "upload_files", "option_strings": ["--upload-files"], "required": false, "type": "typing.List[str]"}, {"choices": null, "default": false, "default_random": false, "help": "The Pod attempts to terminate all of its Runtime child processes/threads on existing. setting it to true basically tell the Pod do not wait on the Runtime when closing", "name": "daemon", "option_strings": ["--daemon"], "required": false, "type": "bool"}, {"choices": ["THREAD", "PROCESS"], "default": "PROCESS", "default_random": false, "help": "The parallel backend of the runtime inside the Pod", "name": "runtime_backend", "option_strings": ["--runtime-backend", "--runtime"], "required": false, "type": "str"}, {"choices": null, "default": "WorkerRuntime", "default_random": false, "help": "The runtime class to run inside the Pod", "name": "runtime_cls", "option_strings": ["--runtime-cls"], "required": false, "type": "str"}, {"choices": null, "default": 600000, "default_random": false, "help": "The timeout in milliseconds of a Pod waits for the runtime to be ready, -1 for waiting forever", "name": "timeout_ready", "option_strings": ["--timeout-ready"], "required": false, "type": "int"}, {"choices": null, "default": null, "default_random": false, "help": "The map of environment variables that are available inside runtime", "name": "env", "option_strings": ["--env"], "required": false, "type": "dict"}, {"choices": null, "default": false, "default_random": false, "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 Pod will receive input connections from remote Pods", "name": "expose_public", "option_strings": ["--expose-public"], "required": false, "type": "bool"}, {"choices": null, "default": 1, "default_random": false, "help": "The number of shards in the deployment running at the same time. For more details check https://docs.jina.ai/fundamentals/flow/create-flow/#complex-flow-topologies", "name": "shards", "option_strings": ["--shards"], "required": false, "type": "int"}, {"choices": null, "default": 1, "default_random": false, "help": "The number of replicas in the deployment", "name": "replicas", "option_strings": ["--replicas"], "required": false, "type": "int"}, {"choices": null, "default": 54033, "default_factory": "random_port", "default_random": true, "help": "The port for input data to bind to, default is a random port between [49152, 65535]", "name": "port", "option_strings": ["--port"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "If set, install `requirements.txt` in the Hub Executor bundle to local", "name": "install_requirements", "option_strings": ["--install-requirements"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, always pull the latest Hub Executor bundle even it exists on local", "name": "force_update", "option_strings": ["--force-update", "--force"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "The address of the uses-before runtime", "name": "uses_before_address", "option_strings": ["--uses-before-address"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "The address of the uses-before runtime", "name": "uses_after_address", "option_strings": ["--uses-after-address"], "required": false, "type": "str"}, {"choices": null, "default": null, "default_random": false, "help": "dictionary JSON with a list of connections to configure", "name": "connection_list", "option_strings": ["--connection-list"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "Disable the built-in reduce mechanism, set this if the reduction is to be handled by the Executor connected to this Head", "name": "disable_reduce", "option_strings": ["--disable-reduce"], "required": false, "type": "bool"}, {"choices": null, "default": null, "default_random": false, "help": "The executor attached after the Pods described by --uses, typically before sending to all shards, 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 attached after the Pods described by --uses, typically used for receiving from all shards, accepted type follows `--uses`", "name": "uses_after", "option_strings": ["--uses-after"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "help": "The Deployment will be considered an external Deployment that has been started independently from the Flow.This Deployment will not be context managed by the Flow.", "name": "external", "option_strings": ["--external"], "required": false, "type": "bool"}]}, {"help": "Start a Python client that connects to a remote Jina gateway", "name": "client", "options": [{"choices": null, "default": "0.0.0.0", "default_random": false, "help": "The host address of the runtime, by default it is 0.0.0.0.", "name": "host", "option_strings": ["--host"], "required": false, "type": "str"}, {"choices": null, "default": false, "default_random": false, "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", "name": "proxy", "option_strings": ["--proxy"], "required": false, "type": "bool"}, {"choices": null, "default": 59528, "default_factory": "random_port", "default_random": true, "help": "The port of the Gateway, which the client should connect to.", "name": "port", "option_strings": ["--port"], "required": false, "type": "int"}, {"choices": null, "default": false, "default_random": false, "help": "If set, connect to gateway using https", "name": "https", "option_strings": ["--https"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, then the input and output of this Client work in an asynchronous manner. ", "name": "asyncio", "option_strings": ["--asyncio"], "required": false, "type": "bool"}, {"choices": null, "default": false, "default_random": false, "help": "If set, return results as List of Requests instead of a reduced DocArray.", "name": "return_responses", "option_strings": ["--return-responses"], "required": false, "type": "bool"}, {"choices": ["GRPC", "HTTP", "WEBSOCKET"], "default": "GRPC", "default_random": false, "help": "Communication protocol between server and client.", "name": "protocol", "option_strings": ["--protocol"], "required": false, "type": "str"}]}, {"help": "Export Jina API to JSON/YAML file for 3rd party applications", "name": "export-api", "options": [{"choices": null, "default": null, "default_random": false, "help": "The YAML file path for storing the exported API", "name": "yaml_path", "option_strings": ["--yaml-path"], "required": false, "type": "typing.List[str]"}, {"choices": null, "default": null, "default_random": false, "help": "The JSON file path for storing the exported API", "name": "json_path", "option_strings": ["--json-path"], "required": false, "type": "typing.List[str]"}, {"choices": null, "default": null, "default_random": false, "help": "The JSONSchema file path for storing the exported API", "name": "schema_path", "option_strings": ["--schema-path"], "required": false, "type": "typing.List[str]"}]}], "name": "Jina", "revision": null, "source": "https://github.com/jina-ai/jina/tree/master", "url": "https://jina.ai", "vendor": "Jina AI Limited", "version": "3.1.1"}