Skip to content

Commit 468c46b

Browse files
committed
Update argparse help and readme
1 parent d9a55ca commit 468c46b

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,7 @@ The script accepts the following parameters:
507507
./send-inference-request.sh [-h] [-i INPUT] [-l] [--host HOST] [-p PORT] [-o OUTPUT]
508508
[-a ATTACHMENTS [ATTACHMENTS ...]] [-S] [-c INFERENCE_COMMAND]
509509
[-r ROUTE] [--request_study_path REQUEST_STUDY_PATH]
510-
[-C ENCODED_CONFIG_XML] [-K PLWMKEY]
510+
[--request_options KEY=VALUE [KEY=VALUE ...]]
511511
```
512512

513513
Parameters:
@@ -519,8 +519,10 @@ Parameters:
519519
* `-S`: If the study size should be send in the request JSON
520520
* `-c`: If set, overrides the 'inference_command' send in the request
521521
* `--request_study_path`: If set, only the given study path is sent to the inference SDK, rather than the study images being sent through HTTP. When set, ensure volumes are mounted appropriately in the inference docker container
522-
* `-C`: Optional encoded XML config to be passed as encodedConfigXML in request JSON
523-
* `-K`: Optional base64 encoded license key, only required for some models
522+
* `--request_options`: Set a number of key-value pairs to be sent in the request JSON (do not put spaces before or after the = sign).
523+
If a value contains spaces, you should define it with double quotes.
524+
Values are always treated as strings.
525+
e.g. --request_options foo=bar a=b greeting="hello there"
524526

525527
> PNG images will be generated and saved in the `inference-test-tool/output` directory as output of the test tool.
526528
You can check if the model's output will be correctly displayed on the Arterys web app.

inference-test-tool/run.py

+4-6
Original file line numberDiff line numberDiff line change
@@ -222,17 +222,15 @@ def parse_args():
222222
parser.add_argument("-c", "--inference_command", default='', help="If set, overrides the 'inference_command' send in the request")
223223
parser.add_argument("-r", "--route", default='/', help="If set, the inference command is directed to the given route. Defaults to '/' route.")
224224
parser.add_argument("--request_study_path", default='', type=str,
225-
help="If set, only the given study path is sent to the inference SDK, rather than the study images being sent through HTTP. " \
225+
help="If set, only the given study path is sent to the inference SDK, rather than the study images being sent through HTTP. "
226226
"When set, ensure volumes are mounted appropriately in the inference docker container")
227227
parser.add_argument("--request_options", "-R",
228228
metavar="KEY=VALUE",
229229
nargs='+',
230-
help="Set a number of key-value pairs to be sent in the request JSON"
231-
"(do not put spaces before or after the = sign). "
230+
help="Set a number of key-value pairs to be sent in the request JSON (do not put spaces before or after the = sign). "
232231
"If a value contains spaces, you should define "
233-
"it with double quotes: "
234-
'foo="this is a sentence". Note that '
235-
"values are always treated as strings.")
232+
"it with double quotes. Values are always treated as strings. "
233+
"e.g. --request_options foo=bar a=b greeting=\"hello there\"")
236234
args = parser.parse_args()
237235

238236
return args

0 commit comments

Comments
 (0)