/
bigquery_v2.models.html
1522 lines (1487 loc) 路 140 KB
/
bigquery_v2.models.html
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.models.html">models</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(projectId, datasetId, modelId)</a></code></p>
<p class="firstline">Deletes the model specified by modelId from the dataset.</p>
<p class="toc_element">
<code><a href="#get">get(projectId, datasetId, modelId)</a></code></p>
<p class="firstline">Gets the specified model resource by model ID.</p>
<p class="toc_element">
<code><a href="#list">list(projectId, datasetId, maxResults=None, pageToken=None)</a></code></p>
<p class="firstline">Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(projectId, datasetId, modelId, body=None)</a></code></p>
<p class="firstline">Patch specific fields in the specified model.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(projectId, datasetId, modelId)</code>
<pre>Deletes the model specified by modelId from the dataset.
Args:
projectId: string, Required. Project ID of the model to delete. (required)
datasetId: string, Required. Dataset ID of the model to delete. (required)
modelId: string, Required. Model ID of the model to delete. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(projectId, datasetId, modelId)</code>
<pre>Gets the specified model resource by model ID.
Args:
projectId: string, Required. Project ID of the requested model. (required)
datasetId: string, Required. Dataset ID of the requested model. (required)
modelId: string, Required. Model ID of the requested model. (required)
Returns:
An object of the form:
{
"bestTrialId": "A String", # The best trial_id across all training runs.
"creationTime": "A String", # Output only. The time when this model was created, in millisecs since the epoch.
"description": "A String", # Optional. A user-friendly description of this model.
"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model.
"kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"etag": "A String", # Output only. A hash of this resource.
"expirationTime": "A String", # Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.
"featureColumns": [ # Output only. Input feature columns that were used to train this model.
{ # A field or a column.
"name": "A String", # Optional. The name of this field. Can be absent for struct fields.
"type": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).
"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
"fields": [
# Object with schema name: StandardSqlField
],
},
"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
},
],
"friendlyName": "A String", # Optional. A descriptive name for this model.
"labelColumns": [ # Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.
{ # A field or a column.
"name": "A String", # Optional. The name of this field. Can be absent for struct fields.
"type": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).
"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
"fields": [
# Object with schema name: StandardSqlField
],
},
"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
},
],
"labels": { # The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
"a_key": "A String",
},
"lastModifiedTime": "A String", # Output only. The time when this model was last modified, in millisecs since the epoch.
"location": "A String", # Output only. The geographic location where the model resides. This value is inherited from the dataset.
"modelReference": { # Required. Unique identifier for this model.
"datasetId": "A String", # [Required] The ID of the dataset containing this model.
"modelId": "A String", # [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # [Required] The ID of the project containing this model.
},
"modelType": "A String", # Output only. Type of the model resource.
"trainingRuns": [ # Output only. Information for all training runs in increasing order of start_time.
{ # Information about a single training query run for the model.
"dataSplitResult": { # Data split result. This contains references to the training and evaluation data tables that were used to train the model. # Data split result of the training run. Only set when the input data is actually split.
"evaluationTable": { # Table reference of the evaluation data after split.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
"projectId": "A String", # [Required] The ID of the project containing this table.
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
"trainingTable": { # Table reference of the training data after split.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
"projectId": "A String", # [Required] The ID of the project containing this table.
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
},
"evaluationMetrics": { # Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models. # The evaluation metrics over training/eval data that were computed at the end of training.
"arimaForecastingMetrics": { # Model evaluation metrics for ARIMA forecasting models. # Populated for ARIMA models.
"arimaFittingMetrics": [ # Arima model fitting metrics.
{ # ARIMA model fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
],
"arimaSingleModelForecastingMetrics": [ # Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
{ # Model evaluation metrics for a single ARIMA forecasting model.
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Is arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"hasDrift": [ # Whether Arima model fitted with drift or not. It is always false when d is not 1.
True or False,
],
"nonSeasonalOrder": [ # Non-seasonal order.
{ # Arima order, can be used for both non-seasonal and seasonal parts.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": [ # Id to differentiate different time series for the large-scale case.
"A String",
],
},
"binaryClassificationMetrics": { # Evaluation metrics for binary classification/classifier models. # Populated for binary classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds.
{ # Confusion matrix for binary classification models.
"accuracy": 3.14, # The fraction of predictions given the correct label.
"f1Score": 3.14, # The equally weighted average of recall and precision.
"falseNegatives": "A String", # Number of false samples predicted as false.
"falsePositives": "A String", # Number of false samples predicted as true.
"positiveClassThreshold": 3.14, # Threshold value used when computing each of the following metric.
"precision": 3.14, # The fraction of actual positive predictions that had positive actual labels.
"recall": 3.14, # The fraction of actual positive labels that were given a positive prediction.
"trueNegatives": "A String", # Number of true samples predicted as false.
"truePositives": "A String", # Number of true samples predicted as true.
},
],
"negativeLabel": "A String", # Label representing the negative class.
"positiveLabel": "A String", # Label representing the positive class.
},
"clusteringMetrics": { # Evaluation metrics for clustering models. # Populated for clustering models.
"clusters": [ # Information for all clusters.
{ # Message containing the information about one cluster.
"centroidId": "A String", # Centroid id.
"count": "A String", # Count of training data rows that were assigned to this cluster.
"featureValues": [ # Values of highly variant features for this cluster.
{ # Representative value of a single feature within the cluster.
"categoricalValue": { # Representative value of a categorical feature. # The categorical feature value.
"categoryCounts": [ # Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
{ # Represents the count of a single category within the cluster.
"category": "A String", # The name of category.
"count": "A String", # The count of training samples matching the category within the cluster.
},
],
},
"featureColumn": "A String", # The feature column name.
"numericalValue": 3.14, # The numerical feature value. This is the centroid value for this feature.
},
],
},
],
"daviesBouldinIndex": 3.14, # Davies-Bouldin index.
"meanSquaredDistance": 3.14, # Mean of squared distances between each sample to its cluster centroid.
},
"multiClassClassificationMetrics": { # Evaluation metrics for multi-class classification/classifier models. # Populated for multi-class classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"confusionMatrixList": [ # Confusion matrix at different thresholds.
{ # Confusion matrix for multi-class classification models.
"confidenceThreshold": 3.14, # Confidence threshold used when computing the entries of the confusion matrix.
"rows": [ # One row per actual label.
{ # A single row in the confusion matrix.
"actualLabel": "A String", # The original label of this row.
"entries": [ # Info describing predicted label distribution.
{ # A single entry in the confusion matrix.
"itemCount": "A String", # Number of items being predicted as this label.
"predictedLabel": "A String", # The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
},
],
},
],
},
],
},
"rankingMetrics": { # Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit. # Populated for implicit feedback type matrix factorization models.
"averageRank": 3.14, # Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.
"meanAveragePrecision": 3.14, # Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.
"meanSquaredError": 3.14, # Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.
"normalizedDiscountedCumulativeGain": 3.14, # A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.
},
"regressionMetrics": { # Evaluation metrics for regression and explicit feedback type matrix factorization models. # Populated for regression models and explicit feedback type matrix factorization models.
"meanAbsoluteError": 3.14, # Mean absolute error.
"meanSquaredError": 3.14, # Mean squared error.
"meanSquaredLogError": 3.14, # Mean squared log error.
"medianAbsoluteError": 3.14, # Median absolute error.
"rSquared": 3.14, # R^2 score. This corresponds to r2_score in ML.EVALUATE.
},
},
"globalExplanations": [ # Global explanations for important features of the model. For multi-class models, there is one entry for each label class. For other models, there is only one entry in the list.
{ # Global explanations containing the top most important features after training.
"classLabel": "A String", # Class label for this set of global explanations. Will be empty/null for binary logistic and linear regression models. Sorted alphabetically in descending order.
"explanations": [ # A list of the top global explanations. Sorted by absolute value of attribution in descending order.
{ # Explanation for a single feature.
"attribution": 3.14, # Attribution of feature.
"featureName": "A String", # Full name of the feature. For non-numerical features, will be formatted like .. Overall size of feature name will always be truncated to first 120 characters.
},
],
},
],
"results": [ # Output of each iteration run, results.size() <= max_iterations.
{ # Information about a single iteration of the training run.
"arimaResult": { # (Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results.
"arimaModelInfo": [ # This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.
{ # Arima model information.
"arimaCoefficients": { # Arima coefficients. # Arima coefficients.
"autoRegressiveCoefficients": [ # Auto-regressive coefficients, an array of double.
3.14,
],
"interceptCoefficient": 3.14, # Intercept coefficient, just a double not an array.
"movingAverageCoefficients": [ # Moving-average coefficients, an array of double.
3.14,
],
},
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Whether Arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
},
"clusterInfos": [ # Information about top clusters for clustering models.
{ # Information about a single cluster for clustering model.
"centroidId": "A String", # Centroid id.
"clusterRadius": 3.14, # Cluster radius, the average distance from centroid to each point assigned to the cluster.
"clusterSize": "A String", # Cluster size, the total number of points assigned to the cluster.
},
],
"durationMs": "A String", # Time taken to run the iteration in milliseconds.
"evalLoss": 3.14, # Loss computed on the eval data at the end of iteration.
"index": 42, # Index of the iteration, 0 based.
"learnRate": 3.14, # Learn rate used for this iteration.
"trainingLoss": 3.14, # Loss computed on the training data at the end of iteration.
},
],
"startTime": "A String", # The start time of this training run.
"trainingOptions": { # Options used in model training. # Options that were used for this training run, includes user specified and default options that were used.
"adjustStepChanges": True or False, # If true, detect step changes and make data adjustment in the input time series.
"autoArima": True or False, # Whether to enable auto ARIMA or not.
"autoArimaMaxOrder": "A String", # The max value of non-seasonal p and q.
"batchSize": "A String", # Batch size for dnn models.
"cleanSpikesAndDips": True or False, # If true, clean spikes and dips in the input time series.
"dataFrequency": "A String", # The data frequency of a time series.
"dataSplitColumn": "A String", # The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties
"dataSplitEvalFraction": 3.14, # The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.
"dataSplitMethod": "A String", # The data split type for training and evaluation, e.g. RANDOM.
"decomposeTimeSeries": True or False, # If true, perform decompose time series and save the results.
"distanceType": "A String", # Distance type for clustering models.
"dropout": 3.14, # Dropout probability for dnn models.
"earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.
"feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization.
"hiddenUnits": [ # Hidden units for dnn models.
"A String",
],
"holidayRegion": "A String", # The geographical region based on which the holidays are considered in time series modeling. If a valid value is specified, then holiday effects modeling is enabled.
"horizon": "A String", # The number of periods ahead that need to be forecasted.
"includeDrift": True or False, # Include drift when fitting an ARIMA model.
"initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy.
"inputLabelColumns": [ # Name of input label columns in training data.
"A String",
],
"itemColumn": "A String", # Item column specified for matrix factorization models.
"kmeansInitializationColumn": "A String", # The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.
"kmeansInitializationMethod": "A String", # The method used to initialize the centroids for kmeans algorithm.
"l1Regularization": 3.14, # L1 regularization coefficient.
"l2Regularization": 3.14, # L2 regularization coefficient.
"labelClassWeights": { # Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.
"a_key": 3.14,
},
"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms.
"learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration.
"lossType": "A String", # Type of loss function used during training run.
"maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms.
"maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models.
"minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.
"minSplitLoss": 3.14, # Minimum split loss for boosted tree models.
"modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"numClusters": "A String", # Number of clusters for clustering models.
"numFactors": "A String", # Num factors specified for matrix factorization models.
"optimizationStrategy": "A String", # Optimization strategy for training linear regression models.
"preserveInputStructs": True or False, # Whether to preserve the input structs in output feature names. Suppose there is a struct A with field b. When false (default), the output feature name is A_b. When true, the output feature name is A.b.
"subsample": 3.14, # Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.
"timeSeriesDataColumn": "A String", # Column to be designated as time series data for ARIMA model.
"timeSeriesIdColumn": "A String", # The time series id column that was used during ARIMA model training.
"timeSeriesIdColumns": [ # The time series id columns that were used during ARIMA model training.
"A String",
],
"timeSeriesTimestampColumn": "A String", # Column to be designated as time series timestamp for ARIMA model.
"userColumn": "A String", # User column specified for matrix factorization models.
"walsAlpha": 3.14, # Hyperparameter for matrix factoration when implicit feedback type is specified.
"warmStart": True or False, # Whether to train a model from the last checkpoint.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(projectId, datasetId, maxResults=None, pageToken=None)</code>
<pre>Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method.
Args:
projectId: string, Required. Project ID of the models to list. (required)
datasetId: string, Required. Dataset ID of the models to list. (required)
maxResults: integer, The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageToken: string, Page token, returned by a previous call to request the next page of results
Returns:
An object of the form:
{
"models": [ # Models in the requested dataset. Only the following fields are populated: model_reference, model_type, creation_time, last_modified_time and labels.
{
"bestTrialId": "A String", # The best trial_id across all training runs.
"creationTime": "A String", # Output only. The time when this model was created, in millisecs since the epoch.
"description": "A String", # Optional. A user-friendly description of this model.
"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model.
"kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"etag": "A String", # Output only. A hash of this resource.
"expirationTime": "A String", # Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.
"featureColumns": [ # Output only. Input feature columns that were used to train this model.
{ # A field or a column.
"name": "A String", # Optional. The name of this field. Can be absent for struct fields.
"type": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).
"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
"fields": [
# Object with schema name: StandardSqlField
],
},
"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
},
],
"friendlyName": "A String", # Optional. A descriptive name for this model.
"labelColumns": [ # Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.
{ # A field or a column.
"name": "A String", # Optional. The name of this field. Can be absent for struct fields.
"type": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).
"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
"fields": [
# Object with schema name: StandardSqlField
],
},
"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
},
],
"labels": { # The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
"a_key": "A String",
},
"lastModifiedTime": "A String", # Output only. The time when this model was last modified, in millisecs since the epoch.
"location": "A String", # Output only. The geographic location where the model resides. This value is inherited from the dataset.
"modelReference": { # Required. Unique identifier for this model.
"datasetId": "A String", # [Required] The ID of the dataset containing this model.
"modelId": "A String", # [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # [Required] The ID of the project containing this model.
},
"modelType": "A String", # Output only. Type of the model resource.
"trainingRuns": [ # Output only. Information for all training runs in increasing order of start_time.
{ # Information about a single training query run for the model.
"dataSplitResult": { # Data split result. This contains references to the training and evaluation data tables that were used to train the model. # Data split result of the training run. Only set when the input data is actually split.
"evaluationTable": { # Table reference of the evaluation data after split.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
"projectId": "A String", # [Required] The ID of the project containing this table.
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
"trainingTable": { # Table reference of the training data after split.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
"projectId": "A String", # [Required] The ID of the project containing this table.
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
},
"evaluationMetrics": { # Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models. # The evaluation metrics over training/eval data that were computed at the end of training.
"arimaForecastingMetrics": { # Model evaluation metrics for ARIMA forecasting models. # Populated for ARIMA models.
"arimaFittingMetrics": [ # Arima model fitting metrics.
{ # ARIMA model fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
],
"arimaSingleModelForecastingMetrics": [ # Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
{ # Model evaluation metrics for a single ARIMA forecasting model.
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Is arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"hasDrift": [ # Whether Arima model fitted with drift or not. It is always false when d is not 1.
True or False,
],
"nonSeasonalOrder": [ # Non-seasonal order.
{ # Arima order, can be used for both non-seasonal and seasonal parts.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": [ # Id to differentiate different time series for the large-scale case.
"A String",
],
},
"binaryClassificationMetrics": { # Evaluation metrics for binary classification/classifier models. # Populated for binary classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds.
{ # Confusion matrix for binary classification models.
"accuracy": 3.14, # The fraction of predictions given the correct label.
"f1Score": 3.14, # The equally weighted average of recall and precision.
"falseNegatives": "A String", # Number of false samples predicted as false.
"falsePositives": "A String", # Number of false samples predicted as true.
"positiveClassThreshold": 3.14, # Threshold value used when computing each of the following metric.
"precision": 3.14, # The fraction of actual positive predictions that had positive actual labels.
"recall": 3.14, # The fraction of actual positive labels that were given a positive prediction.
"trueNegatives": "A String", # Number of true samples predicted as false.
"truePositives": "A String", # Number of true samples predicted as true.
},
],
"negativeLabel": "A String", # Label representing the negative class.
"positiveLabel": "A String", # Label representing the positive class.
},
"clusteringMetrics": { # Evaluation metrics for clustering models. # Populated for clustering models.
"clusters": [ # Information for all clusters.
{ # Message containing the information about one cluster.
"centroidId": "A String", # Centroid id.
"count": "A String", # Count of training data rows that were assigned to this cluster.
"featureValues": [ # Values of highly variant features for this cluster.
{ # Representative value of a single feature within the cluster.
"categoricalValue": { # Representative value of a categorical feature. # The categorical feature value.
"categoryCounts": [ # Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
{ # Represents the count of a single category within the cluster.
"category": "A String", # The name of category.
"count": "A String", # The count of training samples matching the category within the cluster.
},
],
},
"featureColumn": "A String", # The feature column name.
"numericalValue": 3.14, # The numerical feature value. This is the centroid value for this feature.
},
],
},
],
"daviesBouldinIndex": 3.14, # Davies-Bouldin index.
"meanSquaredDistance": 3.14, # Mean of squared distances between each sample to its cluster centroid.
},
"multiClassClassificationMetrics": { # Evaluation metrics for multi-class classification/classifier models. # Populated for multi-class classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"confusionMatrixList": [ # Confusion matrix at different thresholds.
{ # Confusion matrix for multi-class classification models.
"confidenceThreshold": 3.14, # Confidence threshold used when computing the entries of the confusion matrix.
"rows": [ # One row per actual label.
{ # A single row in the confusion matrix.
"actualLabel": "A String", # The original label of this row.
"entries": [ # Info describing predicted label distribution.
{ # A single entry in the confusion matrix.
"itemCount": "A String", # Number of items being predicted as this label.
"predictedLabel": "A String", # The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.
},
],
},
],
},
],
},
"rankingMetrics": { # Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit. # Populated for implicit feedback type matrix factorization models.
"averageRank": 3.14, # Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.
"meanAveragePrecision": 3.14, # Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.
"meanSquaredError": 3.14, # Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.
"normalizedDiscountedCumulativeGain": 3.14, # A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.
},
"regressionMetrics": { # Evaluation metrics for regression and explicit feedback type matrix factorization models. # Populated for regression models and explicit feedback type matrix factorization models.
"meanAbsoluteError": 3.14, # Mean absolute error.
"meanSquaredError": 3.14, # Mean squared error.
"meanSquaredLogError": 3.14, # Mean squared log error.
"medianAbsoluteError": 3.14, # Median absolute error.
"rSquared": 3.14, # R^2 score. This corresponds to r2_score in ML.EVALUATE.
},
},
"globalExplanations": [ # Global explanations for important features of the model. For multi-class models, there is one entry for each label class. For other models, there is only one entry in the list.
{ # Global explanations containing the top most important features after training.
"classLabel": "A String", # Class label for this set of global explanations. Will be empty/null for binary logistic and linear regression models. Sorted alphabetically in descending order.
"explanations": [ # A list of the top global explanations. Sorted by absolute value of attribution in descending order.
{ # Explanation for a single feature.
"attribution": 3.14, # Attribution of feature.
"featureName": "A String", # Full name of the feature. For non-numerical features, will be formatted like .. Overall size of feature name will always be truncated to first 120 characters.
},
],
},
],
"results": [ # Output of each iteration run, results.size() <= max_iterations.
{ # Information about a single iteration of the training run.
"arimaResult": { # (Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results.
"arimaModelInfo": [ # This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.
{ # Arima model information.
"arimaCoefficients": { # Arima coefficients. # Arima coefficients.
"autoRegressiveCoefficients": [ # Auto-regressive coefficients, an array of double.
3.14,
],
"interceptCoefficient": 3.14, # Intercept coefficient, just a double not an array.
"movingAverageCoefficients": [ # Moving-average coefficients, an array of double.
3.14,
],
},
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Whether Arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
},
"clusterInfos": [ # Information about top clusters for clustering models.
{ # Information about a single cluster for clustering model.
"centroidId": "A String", # Centroid id.
"clusterRadius": 3.14, # Cluster radius, the average distance from centroid to each point assigned to the cluster.
"clusterSize": "A String", # Cluster size, the total number of points assigned to the cluster.
},
],
"durationMs": "A String", # Time taken to run the iteration in milliseconds.
"evalLoss": 3.14, # Loss computed on the eval data at the end of iteration.
"index": 42, # Index of the iteration, 0 based.
"learnRate": 3.14, # Learn rate used for this iteration.
"trainingLoss": 3.14, # Loss computed on the training data at the end of iteration.
},
],
"startTime": "A String", # The start time of this training run.
"trainingOptions": { # Options used in model training. # Options that were used for this training run, includes user specified and default options that were used.
"adjustStepChanges": True or False, # If true, detect step changes and make data adjustment in the input time series.
"autoArima": True or False, # Whether to enable auto ARIMA or not.
"autoArimaMaxOrder": "A String", # The max value of non-seasonal p and q.
"batchSize": "A String", # Batch size for dnn models.
"cleanSpikesAndDips": True or False, # If true, clean spikes and dips in the input time series.
"dataFrequency": "A String", # The data frequency of a time series.
"dataSplitColumn": "A String", # The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties
"dataSplitEvalFraction": 3.14, # The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.
"dataSplitMethod": "A String", # The data split type for training and evaluation, e.g. RANDOM.
"decomposeTimeSeries": True or False, # If true, perform decompose time series and save the results.
"distanceType": "A String", # Distance type for clustering models.
"dropout": 3.14, # Dropout probability for dnn models.
"earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.
"feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization.
"hiddenUnits": [ # Hidden units for dnn models.
"A String",
],
"holidayRegion": "A String", # The geographical region based on which the holidays are considered in time series modeling. If a valid value is specified, then holiday effects modeling is enabled.
"horizon": "A String", # The number of periods ahead that need to be forecasted.
"includeDrift": True or False, # Include drift when fitting an ARIMA model.
"initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy.
"inputLabelColumns": [ # Name of input label columns in training data.
"A String",
],
"itemColumn": "A String", # Item column specified for matrix factorization models.
"kmeansInitializationColumn": "A String", # The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.
"kmeansInitializationMethod": "A String", # The method used to initialize the centroids for kmeans algorithm.
"l1Regularization": 3.14, # L1 regularization coefficient.
"l2Regularization": 3.14, # L2 regularization coefficient.
"labelClassWeights": { # Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.
"a_key": 3.14,
},
"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms.
"learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration.
"lossType": "A String", # Type of loss function used during training run.
"maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms.
"maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models.
"minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.
"minSplitLoss": 3.14, # Minimum split loss for boosted tree models.
"modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"numClusters": "A String", # Number of clusters for clustering models.
"numFactors": "A String", # Num factors specified for matrix factorization models.
"optimizationStrategy": "A String", # Optimization strategy for training linear regression models.
"preserveInputStructs": True or False, # Whether to preserve the input structs in output feature names. Suppose there is a struct A with field b. When false (default), the output feature name is A_b. When true, the output feature name is A.b.
"subsample": 3.14, # Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.
"timeSeriesDataColumn": "A String", # Column to be designated as time series data for ARIMA model.
"timeSeriesIdColumn": "A String", # The time series id column that was used during ARIMA model training.
"timeSeriesIdColumns": [ # The time series id columns that were used during ARIMA model training.
"A String",
],
"timeSeriesTimestampColumn": "A String", # Column to be designated as time series timestamp for ARIMA model.
"userColumn": "A String", # User column specified for matrix factorization models.
"walsAlpha": 3.14, # Hyperparameter for matrix factoration when implicit feedback type is specified.
"warmStart": True or False, # Whether to train a model from the last checkpoint.
},
},
],
},
],
"nextPageToken": "A String", # A token to request the next page of results.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(projectId, datasetId, modelId, body=None)</code>
<pre>Patch specific fields in the specified model.
Args:
projectId: string, Required. Project ID of the model to patch. (required)
datasetId: string, Required. Dataset ID of the model to patch. (required)
modelId: string, Required. Model ID of the model to patch. (required)
body: object, The request body.
The object takes the form of:
{
"bestTrialId": "A String", # The best trial_id across all training runs.
"creationTime": "A String", # Output only. The time when this model was created, in millisecs since the epoch.
"description": "A String", # Optional. A user-friendly description of this model.
"encryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model.
"kmsKeyName": "A String", # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
},
"etag": "A String", # Output only. A hash of this resource.
"expirationTime": "A String", # Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.
"featureColumns": [ # Output only. Input feature columns that were used to train this model.
{ # A field or a column.
"name": "A String", # Optional. The name of this field. Can be absent for struct fields.
"type": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).
"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
"fields": [
# Object with schema name: StandardSqlField
],
},
"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
},
],
"friendlyName": "A String", # Optional. A descriptive name for this model.
"labelColumns": [ # Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.
{ # A field or a column.
"name": "A String", # Optional. The name of this field. Can be absent for struct fields.
"type": { # The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}} # Optional. The type of this parameter. Absent if not explicitly specified (e.g., CREATE FUNCTION statement can omit the return type; in this case the output parameter does not have this "type" field).
"arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
"structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
"fields": [
# Object with schema name: StandardSqlField
],
},
"typeKind": "A String", # Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
},
],
"labels": { # The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
"a_key": "A String",
},
"lastModifiedTime": "A String", # Output only. The time when this model was last modified, in millisecs since the epoch.
"location": "A String", # Output only. The geographic location where the model resides. This value is inherited from the dataset.
"modelReference": { # Required. Unique identifier for this model.
"datasetId": "A String", # [Required] The ID of the dataset containing this model.
"modelId": "A String", # [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"projectId": "A String", # [Required] The ID of the project containing this model.
},
"modelType": "A String", # Output only. Type of the model resource.
"trainingRuns": [ # Output only. Information for all training runs in increasing order of start_time.
{ # Information about a single training query run for the model.
"dataSplitResult": { # Data split result. This contains references to the training and evaluation data tables that were used to train the model. # Data split result of the training run. Only set when the input data is actually split.
"evaluationTable": { # Table reference of the evaluation data after split.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
"projectId": "A String", # [Required] The ID of the project containing this table.
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
"trainingTable": { # Table reference of the training data after split.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
"projectId": "A String", # [Required] The ID of the project containing this table.
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
},
"evaluationMetrics": { # Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models. # The evaluation metrics over training/eval data that were computed at the end of training.
"arimaForecastingMetrics": { # Model evaluation metrics for ARIMA forecasting models. # Populated for ARIMA models.
"arimaFittingMetrics": [ # Arima model fitting metrics.
{ # ARIMA model fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
],
"arimaSingleModelForecastingMetrics": [ # Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
{ # Model evaluation metrics for a single ARIMA forecasting model.
"arimaFittingMetrics": { # ARIMA model fitting metrics. # Arima fitting metrics.
"aic": 3.14, # AIC.
"logLikelihood": 3.14, # Log-likelihood.
"variance": 3.14, # Variance.
},
"hasDrift": True or False, # Is arima model fitted with drift or not. It is always false when d is not 1.
"hasHolidayEffect": True or False, # If true, holiday_effect is a part of time series decomposition result.
"hasSpikesAndDips": True or False, # If true, spikes_and_dips is a part of time series decomposition result.
"hasStepChanges": True or False, # If true, step_changes is a part of time series decomposition result.
"nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # Non-seasonal order.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": "A String", # The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.
"timeSeriesIds": [ # The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.
"A String",
],
},
],
"hasDrift": [ # Whether Arima model fitted with drift or not. It is always false when d is not 1.
True or False,
],
"nonSeasonalOrder": [ # Non-seasonal order.
{ # Arima order, can be used for both non-seasonal and seasonal parts.
"d": "A String", # Order of the differencing part.
"p": "A String", # Order of the autoregressive part.
"q": "A String", # Order of the moving-average part.
},
],
"seasonalPeriods": [ # Seasonal periods. Repeated because multiple periods are supported for one time series.
"A String",
],
"timeSeriesId": [ # Id to differentiate different time series for the large-scale case.
"A String",
],
},
"binaryClassificationMetrics": { # Evaluation metrics for binary classification/classifier models. # Populated for binary classification/classifier models.
"aggregateClassificationMetrics": { # Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows. # Aggregate classification metrics.
"accuracy": 3.14, # Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
"f1Score": 3.14, # The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
"logLoss": 3.14, # Logarithmic Loss. For multiclass this is a macro-averaged metric.
"precision": 3.14, # Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
"recall": 3.14, # Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
"rocAuc": 3.14, # Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
"threshold": 3.14, # Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.
},
"binaryConfusionMatrixList": [ # Binary confusion matrix at multiple thresholds.
{ # Confusion matrix for binary classification models.
"accuracy": 3.14, # The fraction of predictions given the correct label.
"f1Score": 3.14, # The equally weighted average of recall and precision.
"falseNegatives": "A String", # Number of false samples predicted as false.
"falsePositives": "A String", # Number of false samples predicted as true.
"positiveClassThreshold": 3.14, # Threshold value used when computing each of the following metric.
"precision": 3.14, # The fraction of actual positive predictions that had positive actual labels.
"recall": 3.14, # The fraction of actual positive labels that were given a positive prediction.
"trueNegatives": "A String", # Number of true samples predicted as false.
"truePositives": "A String", # Number of true samples predicted as true.
},
],
"negativeLabel": "A String", # Label representing the negative class.
"positiveLabel": "A String", # Label representing the positive class.
},
"clusteringMetrics": { # Evaluation metrics for clustering models. # Populated for clustering models.
"clusters": [ # Information for all clusters.
{ # Message containing the information about one cluster.
"centroidId": "A String", # Centroid id.
"count": "A String", # Count of training data rows that were assigned to this cluster.
"featureValues": [ # Values of highly variant features for this cluster.
{ # Representative value of a single feature within the cluster.
"categoricalValue": { # Representative value of a categorical feature. # The categorical feature value.
"categoryCounts": [ # Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "_OTHER_" and count as aggregate counts of remaining categories.
{ # Represents the count of a single category within the cluster.
"category": "A String", # The name of category.
"count": "A String", # The count of training samples matching the category within the cluster.
},
],
},
"featureColumn": "A String", # The feature column name.
"numericalValue": 3.14, # The numerical feature value. This is the centroid value for this feature.
},