summaryrefslogtreecommitdiff
path: root/EXAMPLES
blob: cdf2b47fdd2aee4e82731569e21e7435e153e178 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
API-Definition 
===================================================================

see http://opentox.org/dev/apis/api-1.1/Validation


API-Examples
===================================================================

how to
-------------------------------------------------------------------
the examples listed below can be performed with the command line tool curl 


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


get validation
-------------------------------------------------------------------

>>> curl <validation_service>/<validation_id>

supported accept-headers: "text/x-yaml" and "application/rdf-xml"			
	
	
validate model on test-dateset
-------------------------------------------------------------------	

>>> curl -X POST -d model_uri="<model_uri>" \
 -d test_dataset_uri="<test_dataset_uri>" \
 -d prediction_feature="<prediction_feature>" \
 <validation_service>
	
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 training- and test-dataset
-------------------------------------------------------------------

>>> curl -X POST -d algorithm_uri="<algorithm_uri>" \
 -d training_dataset_uri="<training_dataset_uri>" \
 -d test_dataset_uri="<test_dataset_uri>" \
 -d prediction_feature="<prediction_feature>" \
 -d algorithm_params="<algorithm_params>" \
 <validation_service>

optional params:
algorithm_params, default is empty
	
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
-------------------------------------------------------------------

>>> 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

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)			
<<< not yet supported

result example (accept-header: text/uri-list)
<<< <validation_service>/id_i


get list of available crossvalidations
-------------------------------------------------------------------

>>> curl <validation_service>/crossvalidation

result example (accept-header: application/rdf-xml)			
<<< not yet supported

result example (accept-header: text/uri-list)
<<< <validation_service>/crossvalidation/<crossvalidation_id>
<<< <validation_service>/crossvalidation/crossvalidation_id_i
<<< <validation_service>/crossvalidation/crossvalidation_id_j


get crossvalidation
-------------------------------------------------------------------

>>> curl <validation_service>/crossvalidation/<crossvalidation_id>

supported accept-headers: "text/x-yaml" and "application/rdf-xml"			
	

validate an algorithm on a dataset via crossvalidation
(may take a couple of minutes)
-------------------------------------------------------------------

>>> curl -X POST -d algorithm_uri="<algorithm_uri>" \
 -d dataset_uri="<dataset_uri>" \
 -d prediction_feature="<prediction_feature>" \
 -d algorithm_params="<algorithm_params>" \
 -d num_folds=5 \
 -d random_seed=2 \
 -d stratified=false \
 <validation_service>/crossvalidation

optional params:
algorithm_params, default is empty
num_folds, default is 10
random_seed, default is 1
stratified, default is false
	
result example (accept-header: application/rdf-xml)			
<<< not yet supported

result example (accept-header: text/uri-list)
<<< <validation_service>/crossvalidation/id_i