Validation
Validation
Component description
A validation corresponds to the validation of a model on a test dataset. The results are stored in another dataset. Parameters with default values are optional.
REST operations
| Description | Method | URI | Parameters | Result | Status codes |
| Get all validations |
GET | /validations | - | List of validation URIs | 200,404 |
| Retrieves a validation in XML (or other formats) | GET | /validation/{id} | - | Validation (see XML schema below) |
200,404 |
| Validates a model on a test dataset |
POST | /validation | model_uri test_dataset_uri |
Validation URI |
200,202,400,404,500 |
| Builds a model on a training dataset and validates it on a test dataset |
POST |
/validation | algorithm_uri algorithm_params (string, default="") training_dataset_uri test_dataset_uri y_scramble (boolean, default=false) y_scramble_seed (integer, default=1) |
Validation URI |
200,202,400,404,500 |
| OPTIONAL: Splits a dataset into training and test dataset according to a certain ratio, and performs a validation |
POST | /validation/training_test_split | algorithm_uri algorithm_params (string, default="") dataset_uri split_ratio(float, default=0.66) random_seed(integer, default=1) y_scramble (boolean, default=false) y_scramble_seed (integer, default=1) |
Validation URI |
200,202,400,404,500 |
| OPTIONAL: Performs a bootstrap validation |
POST | /validation/bootstrap | algorithm_uri dataset_params (string, default="") dataset_uri bootstrap_percentage(float, default=0.66) random_seed(integer, default=1) y_scramble (boolean, default=false) y_scramble_seed (integer, default=1) |
Validation URI |
200,202,400,404,500 |
| Deletes a validation. | DELETE | /validation/{id} | - | - |
200,404 |
Output (file) format
See XML schema definition for validation object
HTTP status codes
| Interpretation | Nr | Name |
| Success | 200 | OK |
| Validation not found | 404 | Not Found |
| Illegal model/algorithm/dataset/algorithm params | 400 | Bad request |
| Validation/prediction error | 500 | Internal Server Error |
| Validation running | 202 | Accepted |
Cross-Validation
Component description
Performs a k-fold cross-validation, which results in k validations. Parameters with default values are optional.
REST operations
| Description | Method | URI | Parameters | Result | Status codes |
| Get all cross-validations |
GET | /crossvalidations | - | List of crossvalidation URIs | 200,404 |
| Retrieves a cross-validation in XML (or other formats) | GET | /crossvalidation/{id} | - | Cross-Validation (see XML schema below) |
200,404 |
| Returns all (k) validations that belong to a crossvalidation |
GET | /crossvalidation/{id}/validations | - | List of validation URIs |
200,404 |
| Performs a k-fold cross-validation. |
POST |
/crossvalidation | algorithm_uri algorithm_params (string, default="") num_folds (integer, default=10) random_seed (integer, default=1) stratified (boolean, default=true) y_scramble (boolean, default=false) y_scramble_seed (integer, default=1) |
Cross-Validation URI |
200,202,400,404,500 |
| Performs a leave-one-out cross-validation. |
POST |
/crossvalidation/loo | algorithm_uri algorithm_params (string, default="") y_scramble (boolean, default=false) y_scramble_seed (integer, default=1) |
Cross-Validation URI |
200,202,400,404,500 |
| Deletes a cross-validation. | DELETE | /crossvalidation/{id} | - | - |
200,404 |
Output (file) format
See XML schema definition for crossvalidation object
HTTP status codes
| Interpretation | Nr | Name |
| Success | 200 | OK |
| Cross validation not found | 404 | Not Found |
| Illegal model/algorithm/dataset/algorithm params | 400 | Bad request |
| Validation/prediction error | 500 | Internal Server Error |
| Cross validation running | 202 | Accepted |
