Commit ab3e63d96b0a245a551ab26374c8b3be418fc65b
1 parent
b0627f34
Added cross validate info
Showing
1 changed file
with
11 additions
and
0 deletions
docs/docs/api_docs/cl_api.md
| @@ -59,6 +59,17 @@ DOCUMENT ME | @@ -59,6 +59,17 @@ DOCUMENT ME | ||
| 59 | 59 | ||
| 60 | * **wraps:** [br_pairwise_compare](c_api/functions.md#br_pairwise_compare) | 60 | * **wraps:** [br_pairwise_compare](c_api/functions.md#br_pairwise_compare) |
| 61 | 61 | ||
| 62 | +### -crossValidate {: #crossvalidate } | ||
| 63 | + | ||
| 64 | +Either performs n fold cross validation (if nFolds > 0), or a single iteration of a train / test split with the first of the n folds as the test partition (nFolds < 0). | ||
| 65 | + | ||
| 66 | +* **arguments:** | ||
| 67 | + | ||
| 68 | + -crossValidate <nFolds> -algorithm "CrossValidate(description=$ALG,randomSeed=5):CrossValidate+Dist" -train <inputFile> <model> | ||
| 69 | + | ||
| 70 | + -crossValidate <nFolds> -algorithm <model> -enroll <inputFile> input.gal -compare input.gal . out.eval | ||
| 71 | + | ||
| 72 | + | ||
| 62 | ### -eval {: #eval } | 73 | ### -eval {: #eval } |
| 63 | 74 | ||
| 64 | Evaluate a similarity matrix | 75 | Evaluate a similarity matrix |