Merge pull request #754 from mlcommons/some_doc_updates

Minor documentation updates
mlcommons · Dec 6, 2023 · 9c262ce · 9c262ce
2 parents 38fa03b + e168f93
commit 9c262ce
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/GANDLF/cli/__init__.py b/GANDLF/cli/__init__.py
@@ -13,5 +13,5 @@
     "Contact: gandlf@mlcommons.org\n\n"
     + "This program is NOT FDA/CE approved and NOT intended for clinical use.\nCopyright (c) "
     + str(date.today().year)
-    + " MLCommons. All rights reserved.\n\nCitation: https://arxiv.org/abs/2103.01006"
+    + " MLCommons. All rights reserved.\n\nCitation: https://doi.org/10.1038/s44172-023-00066-3"
 )
diff --git a/docs/usage.md b/docs/usage.md
@@ -236,7 +236,7 @@ GaNDLF provides a script to generate metrics after an inference process is done.
   # -h, --help         Show help message and exit
   # -v, --version      Show program's version number and exit.
   -c , --config       The configuration file (contains all the information related to the training/inference session)
-  -i , --inputdata    CSV file that is used to generate the metrics; should contain 3 columns: 'subjectid, prediction, target'
+  -i , --inputdata    CSV file that is used to generate the metrics; should contain 3 columns: 'SubjectID,Target,Prediction'
   -o , --outputfile   Location to save the output dictionary. If not provided, will print to stdout.
 ```
 

diff --git a/gandlf_generateMetrics b/gandlf_generateMetrics
@@ -32,7 +32,7 @@ if __name__ == "__main__":
         metavar="",
         type=str,
         required=True,
-        help="CSV file that is used to generate the metrics; should contain 3 columns: 'subjectid, prediction, target'",
+        help="The CSV file of input data that is used to generate the metrics; should contain 3 columns: 'SubjectID,Target,Prediction'",
     )
     parser.add_argument(
         "-o",