Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minor documentation updates #754

Merged
merged 3 commits into from
Dec 6, 2023
Merged

Minor documentation updates #754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7fdc98b
updated cli message
scap3yvt Dec 6, 2023
322ead2
updated citation
scap3yvt Dec 6, 2023
e168f93
Update usage.md
scap3yvt Dec 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion GANDLF/cli/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
2 changes: 1 addition & 1 deletion docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```

Expand Down
2 changes: 1 addition & 1 deletion gandlf_generateMetrics
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading