diff --git a/tools/submission/README.md b/tools/submission/README.md index f87e7fed7..a6b835194 100644 --- a/tools/submission/README.md +++ b/tools/submission/README.md @@ -27,16 +27,16 @@ Creates an encrypted tarball and generate the SHA1 of the tarball. Currently sub ### Inputs Takes as input the path of the directory to run the checks on. ### Summary -Checks that a directory containing one or several submission is able to be uploaded to github. This script can be used by running the following command: +Checks that a directory containing one or several submissions is able to be uploaded to github. This script can be used by running the following command: ``` ./repository_checks.sh ``` ### Outputs -Logs in console the errors that could cause problem uploading the submission to github. +Logs in the console the errors that could cause problems uploading the submission to github. ## `submission_checker.py` ### Inputs -**input**: Path to directory containing one or several submissions.
+**input**: Path to the directory containing one or several submissions.
**version**: Checker version. E.g v1.1, v2.0, v2.1, v3.0, v3.1.
**submitter**: Filter submitters and only run the checks for some specific submitter.
**csv**: Output path where the csv with the results will be stored. E.g `results/summary.csv`.
@@ -60,7 +60,6 @@ python3 submission_checker.py --input [--skip_compliance] [--extra-model-benchmark-map ] [--submission-exceptions] - [--more-power-check] ``` ### Outputs @@ -70,11 +69,11 @@ python3 submission_checker.py --input ## `truncate_accuracy_log.py` ### Inputs **input**: Path to directory containing your submission
-**output**: Path to directory to output the submission with truncated files
+**output**: Path to the directory to output the submission with truncated files
**submitter**: Organization name
-**backup**: Path to directory to store an unmodified copy of the truncated files
+**backup**: Path to the directory to store an unmodified copy of the truncated files
### Summary -Takes a directory containing a submission and trucates `mlperf_log_accuracy.json` files. There are two ways to use this script. First, we could create a new submission directory with the truncated files by running: +Takes a directory containing a submission and truncates `mlperf_log_accuracy.json` files. There are two ways to use this script. First, we could create a new submission directory with the truncated files by running: ``` python truncate_accuracy_log.py --input --submitter --output ``` @@ -83,4 +82,11 @@ Second, we could truncate the desired files and place and store a copy of the un python tools/submission/truncate_accuracy_log.py --input --submitter --backup ``` ### Outputs -Output directory with submission with trucated `mlperf_log_accuracy.json` files +Output directory with submission with truncated `mlperf_log_accuracy.json` files + +## `preprocess_submission.py` +### Inputs +**input**: Path to directory containing your submission
+**submitter**: Organization name
+### Summary +The input submission directory is modified with empty directories removed and low accuracy results inferred and also multistream and offline scenario results wherever possible. The original input directory is saved in a timestamped directory.