From a334cf1a90d3af31032273b50c044d58f807f4ff Mon Sep 17 00:00:00 2001 From: David Gardner Date: Fri, 24 Jan 2025 10:06:45 -0800 Subject: [PATCH] Update with exact copy/paste --- examples/ransomware_detection/README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/examples/ransomware_detection/README.md b/examples/ransomware_detection/README.md index 5825d73c9..d4f677cc7 100644 --- a/examples/ransomware_detection/README.md +++ b/examples/ransomware_detection/README.md @@ -88,22 +88,24 @@ Usage: run.py [OPTIONS] Options: --debug BOOLEAN - --num_threads INTEGER RANGE Number of internal pipeline threads to use + --num_threads INTEGER RANGE Number of internal pipeline threads to use. [x>=1] - --n_dask_workers INTEGER RANGE Number of dask workers [x>=1] + --n_dask_workers INTEGER RANGE Number of dask workers. [x>=1] --threads_per_dask_worker INTEGER RANGE - Number of threads per each dask worker + Number of threads per each dask worker. [x>=1] --model_max_batch_size INTEGER RANGE - Max batch size to use for the model [x>=1] - --model_fea_length INTEGER RANGE - Features length to use for the model [x>=1] - --features_file TEXT File path for ransomware detection features + Max batch size to use for the model. [x>=1] + --pipeline_batch_size INTEGER RANGE + Internal batch size for the pipeline. Can be + much larger than the model batch size. + [x>=1] + --conf_file TEXT Ransomware detection configuration filepath. --model_name TEXT The name of the model that is deployed on - Tritonserver - --server_url TEXT Tritonserver url [required] + Tritonserver. + --server_url TEXT Tritonserver url. [required] --sliding_window INTEGER RANGE Sliding window to be used for model input - request [x>=1] + request. [x>=3] --input_glob TEXT Input glob pattern to match files to read. For example, './input_dir/*/snapshot-*/*.json' would read @@ -120,6 +122,6 @@ Options: --output_file TEXT The path to the file where the inference output will be saved. --help Show this message and exit. - ``` +``` > **Note**: There is a known race condition in `dask.distributed` which occasionally causes `tornado.iostream.StreamClosedError` to be raised during shutdown, but does not affect the output of the pipeline. If you see this exception during shutdown, it is typically safe to ignore unless it corresponds to other undesirable behavior. For more information see ([#2026](https://github.com/nv-morpheus/Morpheus/issues/2026)).