Skip to content

Commit 249b960

Browse files
committed
add CLI docs
1 parent 6f54b6a commit 249b960

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

docs/source/overview/cli.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,9 @@ evaluate_model: !obj:selene_sdk.EvaluateModel {
172172
features: !obj:selene_sdk.utils.load_features_list {
173173
input_path: /path/to/features_list.txt
174174
},
175+
use_features_ord: !obj:selene_sdk.utils.load_features_list {
176+
input_path: /path/to/features_subset_ordered.txt
177+
},
175178
trained_model_path: /path/to/trained/model.pth.tar,
176179
batch_size: 64,
177180
n_test_samples: 640000,
@@ -190,6 +193,7 @@ evaluate_model: !obj:selene_sdk.EvaluateModel {
190193
- `report_gt_feature_n_positives`: Default is 10. In total, each class/feature must have more than `report_gt_feature_n_positives` positive examples in the test set to be considered in the performance computation. The output file that reports each class's performance will report 'NA' for classes that do not have enough positive samples.
191194
- `use_cuda`: Default is False. Specify whether CUDA-enabled GPUs are available for torch to use.
192195
- `data_parallel`: Default is False. Specify whether multiple GPUs are available for torch to use.
196+
- `use_features_ord`: Default is None. Specify an ordered list of features for which to run the evaluation. The features in this list must be identical to or a subset of `features`, and in the order you want the resulting `test_targets.npz` and `test_predictions.npz` to be saved.
193197

194198
#### Additional notes
195199
Similar to the `train_model` configuration, any arguments that you find in [the documentation](https://selene.flatironinstitute.org/selene.html#evaluatemodel) that are not present in the function-type value's arguments are automatically instantiated and passed in by Selene.

selene_sdk/evaluate_model.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,11 @@ class EvaluateModel(object):
5858
data_parallel : bool, optional
5959
Default is `False`. Specify whether multiple GPUs are available
6060
for torch to use during training.
61+
use_features_ord : list(str) or None, optional
62+
Default is None. Specify an ordered list of features for which to
63+
run the evaluation. The features in this list must be identical to or
64+
a subset of `features`, and in the order you want the resulting
65+
`test_targets.npz` and `test_predictions.npz` to be saved.
6166
6267
Attributes
6368
----------

0 commit comments

Comments
 (0)