diff options
Diffstat (limited to 'EXAMPLES')
| -rwxr-xr-x[-rw-r--r--] | EXAMPLES | 143 |
1 files changed, 94 insertions, 49 deletions
@@ -17,23 +17,7 @@ get list of available validations >>> curl <validation_service> -result example (accept-header: application/rdf-xml) -<<< not yet supported - -result example (accept-header: text/uri-list) -<<< <validation_service>/<validation_id> -<<< <validation_service>/validation_id_i -<<< <validation_service>/validation_id_j - - -search available validations with url-encoded parameters -------------------------------------------------------------------- - ->>> curl <validation_service>?training_dataset_uri=<training_dataset_uri>&algorithm_uri=<algorithm_uri> - -Hint: you can perform a pattern search (instead of an exact match search) by adding a _like to the parameter, i.e. training_dataset_uri_like - -result example (accept-header: application/rdf-xml) +result example (accept-header: application/rdf+xml) <<< not yet supported result example (accept-header: text/uri-list) @@ -47,7 +31,7 @@ get validation >>> curl <validation_service>/<validation_id> -supported accept-headers: "text/x-yaml" and "application/rdf-xml" +supported accept-headers: "text/x-yaml" and "application/rdf+xml" validate model on test-dateset @@ -56,12 +40,12 @@ validate model on test-dateset >>> curl -X POST -d model_uri="<model_uri>" \ -d test_dataset_uri="<test_dataset_uri>" \ -d test_target_dataset_uri="<dataset_uri>" \ - <validation_service> + <validation_service>/test_set_validation optional params: test_target_dataset_uri, default is test_dataset_uri -result example (accept-header: application/rdf-xml) +result example (accept-header: application/rdf+xml) <<< not yet supported result example (accept-header: text/uri-list) @@ -77,55 +61,57 @@ validate an algorithm on a training- and test-dataset -d test_target_dataset_uri="<dataset_uri>" \ -d prediction_feature="<prediction_feature>" \ -d algorithm_params="<algorithm_params>" \ - <validation_service> + <validation_service>/training_test_validation optional params: algorithm_params, default is empty test_target_dataset_uri, default is test_dataset_uri -result example (accept-header: application/rdf-xml) +result example (accept-header: application/rdf+xml) <<< not yet supported result example (accept-header: text/uri-list) <<< <validation_service>/id_i + +validate an algorithm on a dataset via training-test-split +------------------------------------------------------------------- -create a validation by comparing feature values ------------------------------------------------------ - ->>> curl -X POST -d test_dataset_uri="<test_dataset_uri>" \ - -d test_target_dataset_uri="<dataset_uri>" \ - -d prediction_dataset_uri="<prediction_dataset_uri>" \ +>>> curl -X POST -d algorithm_uri="<algorithm_uri>" \ + -d dataset_uri="<dataset_uri>" \ -d prediction_feature="<prediction_feature>" \ - -d predicted_feature="<predicted_feature>" \ - -d classification="true" \ - <validation_service>/validate_datasets + -d algorithm_params="<algorithm_params>" \ + -d split_ratio=0.9 \ + -d random_seed=2 \ + <validation_service>/training_test_split optional params: -test_target_dataset_uri, default is test_dataset_uri -regression or classification has to be specified - +algorithm_params, default is empty +split_ratio, default is 0.67 +random_seed, default is 1 + +result example (accept-header: application/rdf+xml) +<<< not yet supported + result example (accept-header: text/uri-list) <<< <validation_service>/id_i - -validate an algorithm on a dataset via training-test-split + +validate an algorithm on a dataset via bootstrapping ------------------------------------------------------------------- >>> curl -X POST -d algorithm_uri="<algorithm_uri>" \ -d dataset_uri="<dataset_uri>" \ -d prediction_feature="<prediction_feature>" \ -d algorithm_params="<algorithm_params>" \ - -d split_ratio=0.9 \ -d random_seed=2 \ - <validation_service>/training_test_split + <validation_service>/bootstrapping optional params: algorithm_params, default is empty -split_ratio, default is 0.67 random_seed, default is 1 -result example (accept-header: application/rdf-xml) +result example (accept-header: application/rdf+xml) <<< not yet supported result example (accept-header: text/uri-list) @@ -137,7 +123,7 @@ get list of available crossvalidations >>> curl <validation_service>/crossvalidation -result example (accept-header: application/rdf-xml) +result example (accept-header: application/rdf+xml) <<< not yet supported result example (accept-header: text/uri-list) @@ -151,7 +137,7 @@ get crossvalidation >>> curl <validation_service>/crossvalidation/<crossvalidation_id> -supported accept-headers: "text/x-yaml" and "application/rdf-xml" +supported accept-headers: "text/x-yaml" and "application/rdf+xml" validate an algorithm on a dataset via crossvalidation @@ -173,7 +159,7 @@ num_folds, default is 10 random_seed, default is 1 stratified, default is false -result example (accept-header: application/rdf-xml) +result example (accept-header: application/rdf+xml) <<< not yet supported result example (accept-header: text/uri-list) @@ -190,7 +176,7 @@ get list of available report types >>> curl <validation_service>/report -result example (accept-header: application/rdf-xml) +result example (accept-header: application/rdf+xml) <<< not yet supported result example (accept-header: text/uri-list) @@ -204,7 +190,7 @@ get list of available reports of type validation >>> curl <validation_service>/report/validation -result example (accept-header: application/rdf-xml) +result example (accept-header: application/rdf+xml) <<< not yet supported result example (accept-header: text/uri-list) @@ -233,7 +219,7 @@ create validation report from validation >>> curl -X POST -d validation_uris="<validation_service>/<validation_id>" \ <validation_service>/report/validation -result example (accept-header: application/rdf-xml) +result example (accept-header: application/rdf+xml) <<< not yet supported result example (accept-header: text/uri-list) @@ -245,7 +231,7 @@ get list of available reports of type crossvalidation >>> curl <validation_service>/report/crossvalidation -result example (accept-header: application/rdf-xml) +result example (accept-header: application/rdf+xml) <<< not yet supported result example (accept-header: text/uri-list) @@ -274,7 +260,7 @@ create crossvalidation report from crossvalidation >>> curl -X POST -d validation_uris="<validation_service>/crossvalidation/<crossvalidation_id>" \ <validation_service>/report/crossvalidation -result example (accept-header: application/rdf-xml) +result example (accept-header: application/rdf+xml) <<< not yet supported result example (accept-header: text/uri-list) @@ -289,8 +275,67 @@ manually format html report This explicity invokes the report convertion to html, with css-style-sheet as parameter. -result example (accept-header: application/rdf-xml) +result example (accept-header: application/rdf+xml) <<< not yet supported result example (accept-header: text/uri-list) <<< <validation_service>/report/crossvalidation/id_i + + + +Filter resources +=================================================================== + +It is possible to filter the list of available resources (i.e. validations, crossvalidation, reports) according to property-values. + + +filter available validations for a particular training dataset and model +------------------------------------------------------------------- + +>>> curl <validation_service>?trainingDataset=<training_dataset_uri>\&model=<model_uri> + +alternatively, use property names in (internal) yaml format: + +>>> curl <validation_service>?training_dataset_uri=<training_dataset_uri>\&model_uri=<model_uri> + + +search available validation report for a particular algorithm +------------------------------------------------------------------- + +>>> curl <validation_service>/report/validation?algorithm=lazar + +alternatively, use property names in (internal) yaml format: + +>>> curl <validation_service>/report/validation?algorithm_uris=lazar + + + +Reach reporting +=================================================================== + + +get list of available qmrf report +------------------------------------------------------------------- + +>>> curl <validation_service>/reach_report/qmrf + +result example (accept-header: application/rdf+xml) +<<< not yet supported + +result example (accept-header: text/uri-list) +<<< <validation_service>/reach_report/qmrf/<qmrf_id> +<<< <validation_service>/reach_report/qmrf/report_id_i +<<< <validation_service>/reach_report/qmrf/report_id_j + + +create a QMRF from a model +------------------------------------------------------------------- + +>>> curl -X POST -d model_uri="<model_uri>" \ + <validation_service>/reach_report/qmrf + +result example (accept-header: application/rdf+xml) +<<< not yet supported + +result example (accept-header: text/uri-list) +<<< <validation_service>/reach_report/qmrf/id
\ No newline at end of file |