blob: 304328988318d1e7033547f8e7bd9567efc2134f [file] [log] [blame]
Joe Gregorio761c4562011-10-28 14:36:24 -04001
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete&nbsp;a&nbsp;trained&nbsp;model.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;unique&nbsp;name&nbsp;for&nbsp;the&nbsp;predictive&nbsp;model.&nbsp;(required)</tt></dd></dl>
21
22<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Check&nbsp;training&nbsp;status&nbsp;of&nbsp;your&nbsp;model.<br>
23&nbsp;<br>
24Args:<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050025&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;unique&nbsp;name&nbsp;for&nbsp;the&nbsp;predictive&nbsp;model.&nbsp;(required)<br>
26&nbsp;<br>
27Returns:<br>
28&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
29&nbsp;<br>
30&nbsp;&nbsp;&nbsp;&nbsp;{<br>
31&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"prediction#training",&nbsp;#&nbsp;What&nbsp;kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is.<br>
32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"storageDataLocation":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Google&nbsp;storage&nbsp;location&nbsp;of&nbsp;the&nbsp;training&nbsp;data&nbsp;file.<br>
33&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dataAnalysis":&nbsp;{&nbsp;#&nbsp;Data&nbsp;Analysis.<br>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"warnings":&nbsp;[<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"trainingStatus":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;current&nbsp;status&nbsp;of&nbsp;the&nbsp;training&nbsp;job.&nbsp;This&nbsp;can&nbsp;be&nbsp;one&nbsp;of&nbsp;following:&nbsp;RUNNING;&nbsp;DONE;&nbsp;ERROR;&nbsp;ERROR:&nbsp;TRAINING&nbsp;JOB&nbsp;NOT&nbsp;FOUND<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"modelInfo":&nbsp;{&nbsp;#&nbsp;Model&nbsp;metadata.<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"confusionMatrixRowTotals":&nbsp;{&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;the&nbsp;confusion&nbsp;matrix&nbsp;row&nbsp;totals<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"numberLabels":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Number&nbsp;of&nbsp;class&nbsp;labels&nbsp;in&nbsp;the&nbsp;trained&nbsp;model&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"confusionMatrix":&nbsp;{&nbsp;#&nbsp;An&nbsp;output&nbsp;confusion&nbsp;matrix.&nbsp;This&nbsp;shows&nbsp;an&nbsp;estimate&nbsp;for&nbsp;how&nbsp;this&nbsp;model&nbsp;will&nbsp;do&nbsp;in&nbsp;predictions.&nbsp;This&nbsp;is&nbsp;first&nbsp;indexed&nbsp;by&nbsp;the&nbsp;true&nbsp;class&nbsp;label.&nbsp;For&nbsp;each&nbsp;true&nbsp;class&nbsp;label,&nbsp;this&nbsp;provides&nbsp;a&nbsp;pair&nbsp;{predicted_label,&nbsp;count},&nbsp;where&nbsp;count&nbsp;is&nbsp;the&nbsp;estimated&nbsp;number&nbsp;of&nbsp;times&nbsp;the&nbsp;model&nbsp;will&nbsp;predict&nbsp;the&nbsp;predicted&nbsp;label&nbsp;given&nbsp;the&nbsp;true&nbsp;label&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
44&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
45&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"meanSquaredError":&nbsp;3.140000,&nbsp;#&nbsp;An&nbsp;estimated&nbsp;mean&nbsp;squared&nbsp;error.&nbsp;The&nbsp;can&nbsp;be&nbsp;used&nbsp;to&nbsp;measure&nbsp;the&nbsp;quality&nbsp;of&nbsp;the&nbsp;predicted&nbsp;model&nbsp;[Regression&nbsp;models&nbsp;only].<br>
46&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"modelType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;predictive&nbsp;model&nbsp;(CLASSIFICATION&nbsp;or&nbsp;REGRESSION)<br>
47&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"numberInstances":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Number&nbsp;of&nbsp;valid&nbsp;data&nbsp;instances&nbsp;used&nbsp;in&nbsp;the&nbsp;trained&nbsp;model.<br>
48&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"classWeightedAccuracy":&nbsp;3.140000,&nbsp;#&nbsp;Estimated&nbsp;accuracy&nbsp;of&nbsp;model&nbsp;taking&nbsp;utility&nbsp;weights&nbsp;into&nbsp;account&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
49&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"classificationAccuracy":&nbsp;3.140000,&nbsp;#&nbsp;A&nbsp;number&nbsp;between&nbsp;0.0&nbsp;and&nbsp;1.0,&nbsp;where&nbsp;1.0&nbsp;is&nbsp;100%&nbsp;accurate.&nbsp;This&nbsp;is&nbsp;an&nbsp;estimate,&nbsp;based&nbsp;on&nbsp;the&nbsp;amount&nbsp;and&nbsp;quality&nbsp;of&nbsp;the&nbsp;training&nbsp;data,&nbsp;of&nbsp;the&nbsp;estimated&nbsp;prediction&nbsp;accuracy.&nbsp;You&nbsp;can&nbsp;use&nbsp;this&nbsp;is&nbsp;a&nbsp;guide&nbsp;to&nbsp;decide&nbsp;whether&nbsp;the&nbsp;results&nbsp;are&nbsp;accurate&nbsp;enough&nbsp;for&nbsp;your&nbsp;needs.&nbsp;This&nbsp;estimate&nbsp;will&nbsp;be&nbsp;more&nbsp;reliable&nbsp;if&nbsp;your&nbsp;real&nbsp;input&nbsp;data&nbsp;is&nbsp;similar&nbsp;to&nbsp;your&nbsp;training&nbsp;data&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
51&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"storagePMMLLocation":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Google&nbsp;storage&nbsp;location&nbsp;of&nbsp;the&nbsp;preprocessing&nbsp;pmml&nbsp;file.<br>
52&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;unique&nbsp;name&nbsp;for&nbsp;the&nbsp;predictive&nbsp;model.<br>
53&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;URL&nbsp;to&nbsp;re-request&nbsp;this&nbsp;resource.<br>
54&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"utility":&nbsp;[&nbsp;#&nbsp;A&nbsp;class&nbsp;weighting&nbsp;function,&nbsp;which&nbsp;allows&nbsp;the&nbsp;importance&nbsp;weights&nbsp;for&nbsp;class&nbsp;labels&nbsp;to&nbsp;be&nbsp;specified&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
55&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Class&nbsp;label&nbsp;(string).<br>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
58&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio761c4562011-10-28 14:36:24 -040059
60<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Begin&nbsp;training&nbsp;your&nbsp;model.<br>
61&nbsp;<br>
62Args:<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050063&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
64&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
65&nbsp;<br>
66{<br>
67&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"prediction#training",&nbsp;#&nbsp;What&nbsp;kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is.<br>
68&nbsp;&nbsp;&nbsp;&nbsp;"storageDataLocation":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Google&nbsp;storage&nbsp;location&nbsp;of&nbsp;the&nbsp;training&nbsp;data&nbsp;file.<br>
69&nbsp;&nbsp;&nbsp;&nbsp;"dataAnalysis":&nbsp;{&nbsp;#&nbsp;Data&nbsp;Analysis.<br>
70&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"warnings":&nbsp;[<br>
71&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
72&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
73&nbsp;&nbsp;&nbsp;&nbsp;},<br>
74&nbsp;&nbsp;&nbsp;&nbsp;"trainingStatus":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;current&nbsp;status&nbsp;of&nbsp;the&nbsp;training&nbsp;job.&nbsp;This&nbsp;can&nbsp;be&nbsp;one&nbsp;of&nbsp;following:&nbsp;RUNNING;&nbsp;DONE;&nbsp;ERROR;&nbsp;ERROR:&nbsp;TRAINING&nbsp;JOB&nbsp;NOT&nbsp;FOUND<br>
75&nbsp;&nbsp;&nbsp;&nbsp;"modelInfo":&nbsp;{&nbsp;#&nbsp;Model&nbsp;metadata.<br>
76&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"confusionMatrixRowTotals":&nbsp;{&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;the&nbsp;confusion&nbsp;matrix&nbsp;row&nbsp;totals<br>
77&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
78&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"numberLabels":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Number&nbsp;of&nbsp;class&nbsp;labels&nbsp;in&nbsp;the&nbsp;trained&nbsp;model&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
79&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"confusionMatrix":&nbsp;{&nbsp;#&nbsp;An&nbsp;output&nbsp;confusion&nbsp;matrix.&nbsp;This&nbsp;shows&nbsp;an&nbsp;estimate&nbsp;for&nbsp;how&nbsp;this&nbsp;model&nbsp;will&nbsp;do&nbsp;in&nbsp;predictions.&nbsp;This&nbsp;is&nbsp;first&nbsp;indexed&nbsp;by&nbsp;the&nbsp;true&nbsp;class&nbsp;label.&nbsp;For&nbsp;each&nbsp;true&nbsp;class&nbsp;label,&nbsp;this&nbsp;provides&nbsp;a&nbsp;pair&nbsp;{predicted_label,&nbsp;count},&nbsp;where&nbsp;count&nbsp;is&nbsp;the&nbsp;estimated&nbsp;number&nbsp;of&nbsp;times&nbsp;the&nbsp;model&nbsp;will&nbsp;predict&nbsp;the&nbsp;predicted&nbsp;label&nbsp;given&nbsp;the&nbsp;true&nbsp;label&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
80&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
81&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"meanSquaredError":&nbsp;3.140000,&nbsp;#&nbsp;An&nbsp;estimated&nbsp;mean&nbsp;squared&nbsp;error.&nbsp;The&nbsp;can&nbsp;be&nbsp;used&nbsp;to&nbsp;measure&nbsp;the&nbsp;quality&nbsp;of&nbsp;the&nbsp;predicted&nbsp;model&nbsp;[Regression&nbsp;models&nbsp;only].<br>
82&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"modelType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;predictive&nbsp;model&nbsp;(CLASSIFICATION&nbsp;or&nbsp;REGRESSION)<br>
83&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"numberInstances":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Number&nbsp;of&nbsp;valid&nbsp;data&nbsp;instances&nbsp;used&nbsp;in&nbsp;the&nbsp;trained&nbsp;model.<br>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"classWeightedAccuracy":&nbsp;3.140000,&nbsp;#&nbsp;Estimated&nbsp;accuracy&nbsp;of&nbsp;model&nbsp;taking&nbsp;utility&nbsp;weights&nbsp;into&nbsp;account&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"classificationAccuracy":&nbsp;3.140000,&nbsp;#&nbsp;A&nbsp;number&nbsp;between&nbsp;0.0&nbsp;and&nbsp;1.0,&nbsp;where&nbsp;1.0&nbsp;is&nbsp;100%&nbsp;accurate.&nbsp;This&nbsp;is&nbsp;an&nbsp;estimate,&nbsp;based&nbsp;on&nbsp;the&nbsp;amount&nbsp;and&nbsp;quality&nbsp;of&nbsp;the&nbsp;training&nbsp;data,&nbsp;of&nbsp;the&nbsp;estimated&nbsp;prediction&nbsp;accuracy.&nbsp;You&nbsp;can&nbsp;use&nbsp;this&nbsp;is&nbsp;a&nbsp;guide&nbsp;to&nbsp;decide&nbsp;whether&nbsp;the&nbsp;results&nbsp;are&nbsp;accurate&nbsp;enough&nbsp;for&nbsp;your&nbsp;needs.&nbsp;This&nbsp;estimate&nbsp;will&nbsp;be&nbsp;more&nbsp;reliable&nbsp;if&nbsp;your&nbsp;real&nbsp;input&nbsp;data&nbsp;is&nbsp;similar&nbsp;to&nbsp;your&nbsp;training&nbsp;data&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
86&nbsp;&nbsp;&nbsp;&nbsp;},<br>
87&nbsp;&nbsp;&nbsp;&nbsp;"storagePMMLLocation":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Google&nbsp;storage&nbsp;location&nbsp;of&nbsp;the&nbsp;preprocessing&nbsp;pmml&nbsp;file.<br>
88&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;unique&nbsp;name&nbsp;for&nbsp;the&nbsp;predictive&nbsp;model.<br>
89&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;URL&nbsp;to&nbsp;re-request&nbsp;this&nbsp;resource.<br>
90&nbsp;&nbsp;&nbsp;&nbsp;"utility":&nbsp;[&nbsp;#&nbsp;A&nbsp;class&nbsp;weighting&nbsp;function,&nbsp;which&nbsp;allows&nbsp;the&nbsp;importance&nbsp;weights&nbsp;for&nbsp;class&nbsp;labels&nbsp;to&nbsp;be&nbsp;specified&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
91&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Class&nbsp;label&nbsp;(string).<br>
92&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
93&nbsp;&nbsp;&nbsp;&nbsp;],<br>
94&nbsp;&nbsp;}<br>
95&nbsp;<br>
96&nbsp;<br>
97Returns:<br>
98&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
99&nbsp;<br>
100&nbsp;&nbsp;&nbsp;&nbsp;{<br>
101&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"prediction#training",&nbsp;#&nbsp;What&nbsp;kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is.<br>
102&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"storageDataLocation":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Google&nbsp;storage&nbsp;location&nbsp;of&nbsp;the&nbsp;training&nbsp;data&nbsp;file.<br>
103&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dataAnalysis":&nbsp;{&nbsp;#&nbsp;Data&nbsp;Analysis.<br>
104&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"warnings":&nbsp;[<br>
105&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
106&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
107&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
108&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"trainingStatus":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;current&nbsp;status&nbsp;of&nbsp;the&nbsp;training&nbsp;job.&nbsp;This&nbsp;can&nbsp;be&nbsp;one&nbsp;of&nbsp;following:&nbsp;RUNNING;&nbsp;DONE;&nbsp;ERROR;&nbsp;ERROR:&nbsp;TRAINING&nbsp;JOB&nbsp;NOT&nbsp;FOUND<br>
109&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"modelInfo":&nbsp;{&nbsp;#&nbsp;Model&nbsp;metadata.<br>
110&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"confusionMatrixRowTotals":&nbsp;{&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;the&nbsp;confusion&nbsp;matrix&nbsp;row&nbsp;totals<br>
111&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
112&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"numberLabels":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Number&nbsp;of&nbsp;class&nbsp;labels&nbsp;in&nbsp;the&nbsp;trained&nbsp;model&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
113&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"confusionMatrix":&nbsp;{&nbsp;#&nbsp;An&nbsp;output&nbsp;confusion&nbsp;matrix.&nbsp;This&nbsp;shows&nbsp;an&nbsp;estimate&nbsp;for&nbsp;how&nbsp;this&nbsp;model&nbsp;will&nbsp;do&nbsp;in&nbsp;predictions.&nbsp;This&nbsp;is&nbsp;first&nbsp;indexed&nbsp;by&nbsp;the&nbsp;true&nbsp;class&nbsp;label.&nbsp;For&nbsp;each&nbsp;true&nbsp;class&nbsp;label,&nbsp;this&nbsp;provides&nbsp;a&nbsp;pair&nbsp;{predicted_label,&nbsp;count},&nbsp;where&nbsp;count&nbsp;is&nbsp;the&nbsp;estimated&nbsp;number&nbsp;of&nbsp;times&nbsp;the&nbsp;model&nbsp;will&nbsp;predict&nbsp;the&nbsp;predicted&nbsp;label&nbsp;given&nbsp;the&nbsp;true&nbsp;label&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
114&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
115&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"meanSquaredError":&nbsp;3.140000,&nbsp;#&nbsp;An&nbsp;estimated&nbsp;mean&nbsp;squared&nbsp;error.&nbsp;The&nbsp;can&nbsp;be&nbsp;used&nbsp;to&nbsp;measure&nbsp;the&nbsp;quality&nbsp;of&nbsp;the&nbsp;predicted&nbsp;model&nbsp;[Regression&nbsp;models&nbsp;only].<br>
116&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"modelType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;predictive&nbsp;model&nbsp;(CLASSIFICATION&nbsp;or&nbsp;REGRESSION)<br>
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"numberInstances":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Number&nbsp;of&nbsp;valid&nbsp;data&nbsp;instances&nbsp;used&nbsp;in&nbsp;the&nbsp;trained&nbsp;model.<br>
118&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"classWeightedAccuracy":&nbsp;3.140000,&nbsp;#&nbsp;Estimated&nbsp;accuracy&nbsp;of&nbsp;model&nbsp;taking&nbsp;utility&nbsp;weights&nbsp;into&nbsp;account&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
119&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"classificationAccuracy":&nbsp;3.140000,&nbsp;#&nbsp;A&nbsp;number&nbsp;between&nbsp;0.0&nbsp;and&nbsp;1.0,&nbsp;where&nbsp;1.0&nbsp;is&nbsp;100%&nbsp;accurate.&nbsp;This&nbsp;is&nbsp;an&nbsp;estimate,&nbsp;based&nbsp;on&nbsp;the&nbsp;amount&nbsp;and&nbsp;quality&nbsp;of&nbsp;the&nbsp;training&nbsp;data,&nbsp;of&nbsp;the&nbsp;estimated&nbsp;prediction&nbsp;accuracy.&nbsp;You&nbsp;can&nbsp;use&nbsp;this&nbsp;is&nbsp;a&nbsp;guide&nbsp;to&nbsp;decide&nbsp;whether&nbsp;the&nbsp;results&nbsp;are&nbsp;accurate&nbsp;enough&nbsp;for&nbsp;your&nbsp;needs.&nbsp;This&nbsp;estimate&nbsp;will&nbsp;be&nbsp;more&nbsp;reliable&nbsp;if&nbsp;your&nbsp;real&nbsp;input&nbsp;data&nbsp;is&nbsp;similar&nbsp;to&nbsp;your&nbsp;training&nbsp;data&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
120&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
121&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"storagePMMLLocation":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Google&nbsp;storage&nbsp;location&nbsp;of&nbsp;the&nbsp;preprocessing&nbsp;pmml&nbsp;file.<br>
122&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;unique&nbsp;name&nbsp;for&nbsp;the&nbsp;predictive&nbsp;model.<br>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;URL&nbsp;to&nbsp;re-request&nbsp;this&nbsp;resource.<br>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"utility":&nbsp;[&nbsp;#&nbsp;A&nbsp;class&nbsp;weighting&nbsp;function,&nbsp;which&nbsp;allows&nbsp;the&nbsp;importance&nbsp;weights&nbsp;for&nbsp;class&nbsp;labels&nbsp;to&nbsp;be&nbsp;specified&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
125&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Class&nbsp;label&nbsp;(string).<br>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
128&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio761c4562011-10-28 14:36:24 -0400129
130<dl><dt><a name="Resource-predict"><strong>predict</strong></a> = method(self, **kwargs)</dt><dd><tt>Submit&nbsp;model&nbsp;id&nbsp;and&nbsp;request&nbsp;a&nbsp;prediction<br>
131&nbsp;<br>
132Args:<br>
133&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500134&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
135&nbsp;<br>
136{<br>
137&nbsp;&nbsp;&nbsp;&nbsp;"input":&nbsp;{&nbsp;#&nbsp;Input&nbsp;to&nbsp;the&nbsp;model&nbsp;for&nbsp;a&nbsp;prediction<br>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"csvInstance":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;input&nbsp;features,&nbsp;these&nbsp;can&nbsp;be&nbsp;strings&nbsp;or&nbsp;doubles.<br>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"",<br>
140&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
141&nbsp;&nbsp;&nbsp;&nbsp;},<br>
142&nbsp;&nbsp;}<br>
143&nbsp;<br>
144&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;unique&nbsp;name&nbsp;for&nbsp;the&nbsp;predictive&nbsp;model.&nbsp;(required)<br>
145&nbsp;<br>
146Returns:<br>
147&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
148&nbsp;<br>
149&nbsp;&nbsp;&nbsp;&nbsp;{<br>
150&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"prediction#output",&nbsp;#&nbsp;What&nbsp;kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is.<br>
151&nbsp;&nbsp;&nbsp;&nbsp;"outputLabel":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;most&nbsp;likely&nbsp;class&nbsp;label&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
152&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;unique&nbsp;name&nbsp;for&nbsp;the&nbsp;predictive&nbsp;model.<br>
153&nbsp;&nbsp;&nbsp;&nbsp;"outputMulti":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;class&nbsp;labels&nbsp;with&nbsp;their&nbsp;estimated&nbsp;probabilities&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"score":&nbsp;3.140000,&nbsp;#&nbsp;The&nbsp;probability&nbsp;of&nbsp;the&nbsp;class&nbsp;label.<br>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"label":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;class&nbsp;label.<br>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
158&nbsp;&nbsp;&nbsp;&nbsp;],<br>
159&nbsp;&nbsp;&nbsp;&nbsp;"outputValue":&nbsp;3.140000,&nbsp;#&nbsp;The&nbsp;estimated&nbsp;regression&nbsp;value&nbsp;[Regression&nbsp;models&nbsp;only].<br>
160&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;URL&nbsp;to&nbsp;re-request&nbsp;this&nbsp;resource.<br>
161&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio761c4562011-10-28 14:36:24 -0400162
163<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Add&nbsp;new&nbsp;data&nbsp;to&nbsp;a&nbsp;trained&nbsp;model.<br>
164&nbsp;<br>
165Args:<br>
166&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500167&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
168&nbsp;<br>
169{<br>
170&nbsp;&nbsp;&nbsp;&nbsp;"csvInstance":&nbsp;[&nbsp;#&nbsp;The&nbsp;input&nbsp;features&nbsp;for&nbsp;this&nbsp;instance<br>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"",<br>
172&nbsp;&nbsp;&nbsp;&nbsp;],<br>
173&nbsp;&nbsp;&nbsp;&nbsp;"label":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;true&nbsp;class&nbsp;label&nbsp;of&nbsp;this&nbsp;instance<br>
174&nbsp;&nbsp;}<br>
175&nbsp;<br>
176&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;unique&nbsp;name&nbsp;for&nbsp;the&nbsp;predictive&nbsp;model.&nbsp;(required)<br>
177&nbsp;<br>
178Returns:<br>
179&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
180&nbsp;<br>
181&nbsp;&nbsp;&nbsp;&nbsp;{<br>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"prediction#training",&nbsp;#&nbsp;What&nbsp;kind&nbsp;of&nbsp;resource&nbsp;this&nbsp;is.<br>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"storageDataLocation":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Google&nbsp;storage&nbsp;location&nbsp;of&nbsp;the&nbsp;training&nbsp;data&nbsp;file.<br>
184&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dataAnalysis":&nbsp;{&nbsp;#&nbsp;Data&nbsp;Analysis.<br>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"warnings":&nbsp;[<br>
186&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"trainingStatus":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;current&nbsp;status&nbsp;of&nbsp;the&nbsp;training&nbsp;job.&nbsp;This&nbsp;can&nbsp;be&nbsp;one&nbsp;of&nbsp;following:&nbsp;RUNNING;&nbsp;DONE;&nbsp;ERROR;&nbsp;ERROR:&nbsp;TRAINING&nbsp;JOB&nbsp;NOT&nbsp;FOUND<br>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"modelInfo":&nbsp;{&nbsp;#&nbsp;Model&nbsp;metadata.<br>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"confusionMatrixRowTotals":&nbsp;{&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;the&nbsp;confusion&nbsp;matrix&nbsp;row&nbsp;totals<br>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
193&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"numberLabels":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Number&nbsp;of&nbsp;class&nbsp;labels&nbsp;in&nbsp;the&nbsp;trained&nbsp;model&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"confusionMatrix":&nbsp;{&nbsp;#&nbsp;An&nbsp;output&nbsp;confusion&nbsp;matrix.&nbsp;This&nbsp;shows&nbsp;an&nbsp;estimate&nbsp;for&nbsp;how&nbsp;this&nbsp;model&nbsp;will&nbsp;do&nbsp;in&nbsp;predictions.&nbsp;This&nbsp;is&nbsp;first&nbsp;indexed&nbsp;by&nbsp;the&nbsp;true&nbsp;class&nbsp;label.&nbsp;For&nbsp;each&nbsp;true&nbsp;class&nbsp;label,&nbsp;this&nbsp;provides&nbsp;a&nbsp;pair&nbsp;{predicted_label,&nbsp;count},&nbsp;where&nbsp;count&nbsp;is&nbsp;the&nbsp;estimated&nbsp;number&nbsp;of&nbsp;times&nbsp;the&nbsp;model&nbsp;will&nbsp;predict&nbsp;the&nbsp;predicted&nbsp;label&nbsp;given&nbsp;the&nbsp;true&nbsp;label&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"meanSquaredError":&nbsp;3.140000,&nbsp;#&nbsp;An&nbsp;estimated&nbsp;mean&nbsp;squared&nbsp;error.&nbsp;The&nbsp;can&nbsp;be&nbsp;used&nbsp;to&nbsp;measure&nbsp;the&nbsp;quality&nbsp;of&nbsp;the&nbsp;predicted&nbsp;model&nbsp;[Regression&nbsp;models&nbsp;only].<br>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"modelType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;predictive&nbsp;model&nbsp;(CLASSIFICATION&nbsp;or&nbsp;REGRESSION)<br>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"numberInstances":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Number&nbsp;of&nbsp;valid&nbsp;data&nbsp;instances&nbsp;used&nbsp;in&nbsp;the&nbsp;trained&nbsp;model.<br>
199&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"classWeightedAccuracy":&nbsp;3.140000,&nbsp;#&nbsp;Estimated&nbsp;accuracy&nbsp;of&nbsp;model&nbsp;taking&nbsp;utility&nbsp;weights&nbsp;into&nbsp;account&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"classificationAccuracy":&nbsp;3.140000,&nbsp;#&nbsp;A&nbsp;number&nbsp;between&nbsp;0.0&nbsp;and&nbsp;1.0,&nbsp;where&nbsp;1.0&nbsp;is&nbsp;100%&nbsp;accurate.&nbsp;This&nbsp;is&nbsp;an&nbsp;estimate,&nbsp;based&nbsp;on&nbsp;the&nbsp;amount&nbsp;and&nbsp;quality&nbsp;of&nbsp;the&nbsp;training&nbsp;data,&nbsp;of&nbsp;the&nbsp;estimated&nbsp;prediction&nbsp;accuracy.&nbsp;You&nbsp;can&nbsp;use&nbsp;this&nbsp;is&nbsp;a&nbsp;guide&nbsp;to&nbsp;decide&nbsp;whether&nbsp;the&nbsp;results&nbsp;are&nbsp;accurate&nbsp;enough&nbsp;for&nbsp;your&nbsp;needs.&nbsp;This&nbsp;estimate&nbsp;will&nbsp;be&nbsp;more&nbsp;reliable&nbsp;if&nbsp;your&nbsp;real&nbsp;input&nbsp;data&nbsp;is&nbsp;similar&nbsp;to&nbsp;your&nbsp;training&nbsp;data&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
201&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"storagePMMLLocation":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Google&nbsp;storage&nbsp;location&nbsp;of&nbsp;the&nbsp;preprocessing&nbsp;pmml&nbsp;file.<br>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;unique&nbsp;name&nbsp;for&nbsp;the&nbsp;predictive&nbsp;model.<br>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;URL&nbsp;to&nbsp;re-request&nbsp;this&nbsp;resource.<br>
205&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"utility":&nbsp;[&nbsp;#&nbsp;A&nbsp;class&nbsp;weighting&nbsp;function,&nbsp;which&nbsp;allows&nbsp;the&nbsp;importance&nbsp;weights&nbsp;for&nbsp;class&nbsp;labels&nbsp;to&nbsp;be&nbsp;specified&nbsp;[Categorical&nbsp;models&nbsp;only].<br>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Class&nbsp;label&nbsp;(string).<br>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
209&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio761c4562011-10-28 14:36:24 -0400210
211<hr>
212Data descriptors defined here:<br>
213<dl><dt><strong>__dict__</strong></dt>
214<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
215</dl>
216<dl><dt><strong>__weakref__</strong></dt>
217<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
218</dl>
219</td></tr></table>
220</body></html>