1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\Bigquery;
19
20class TrainingOptions extends \Google\Collection
21{
22  protected $collection_key = 'timeSeriesIdColumns';
23  /**
24   * @var bool
25   */
26  public $adjustStepChanges;
27  /**
28   * @var bool
29   */
30  public $autoArima;
31  /**
32   * @var string
33   */
34  public $autoArimaMaxOrder;
35  /**
36   * @var string
37   */
38  public $batchSize;
39  /**
40   * @var string
41   */
42  public $boosterType;
43  /**
44   * @var bool
45   */
46  public $calculatePValues;
47  /**
48   * @var bool
49   */
50  public $cleanSpikesAndDips;
51  public $colsampleBylevel;
52  public $colsampleBynode;
53  public $colsampleBytree;
54  /**
55   * @var string
56   */
57  public $dartNormalizeType;
58  /**
59   * @var string
60   */
61  public $dataFrequency;
62  /**
63   * @var string
64   */
65  public $dataSplitColumn;
66  public $dataSplitEvalFraction;
67  /**
68   * @var string
69   */
70  public $dataSplitMethod;
71  /**
72   * @var bool
73   */
74  public $decomposeTimeSeries;
75  /**
76   * @var string
77   */
78  public $distanceType;
79  public $dropout;
80  /**
81   * @var bool
82   */
83  public $earlyStop;
84  /**
85   * @var bool
86   */
87  public $enableGlobalExplain;
88  /**
89   * @var string
90   */
91  public $feedbackType;
92  /**
93   * @var string[]
94   */
95  public $hiddenUnits;
96  /**
97   * @var string
98   */
99  public $holidayRegion;
100  /**
101   * @var string
102   */
103  public $horizon;
104  /**
105   * @var string[]
106   */
107  public $hparamTuningObjectives;
108  /**
109   * @var bool
110   */
111  public $includeDrift;
112  public $initialLearnRate;
113  /**
114   * @var string[]
115   */
116  public $inputLabelColumns;
117  /**
118   * @var string
119   */
120  public $integratedGradientsNumSteps;
121  /**
122   * @var string
123   */
124  public $itemColumn;
125  /**
126   * @var string
127   */
128  public $kmeansInitializationColumn;
129  /**
130   * @var string
131   */
132  public $kmeansInitializationMethod;
133  public $l1Regularization;
134  public $l2Regularization;
135  public $labelClassWeights;
136  public $learnRate;
137  /**
138   * @var string
139   */
140  public $learnRateStrategy;
141  /**
142   * @var string
143   */
144  public $lossType;
145  /**
146   * @var string
147   */
148  public $maxIterations;
149  /**
150   * @var string
151   */
152  public $maxParallelTrials;
153  /**
154   * @var string
155   */
156  public $maxTreeDepth;
157  public $minRelativeProgress;
158  public $minSplitLoss;
159  /**
160   * @var string
161   */
162  public $minTreeChildWeight;
163  /**
164   * @var string
165   */
166  public $modelUri;
167  protected $nonSeasonalOrderType = ArimaOrder::class;
168  protected $nonSeasonalOrderDataType = '';
169  /**
170   * @var string
171   */
172  public $numClusters;
173  /**
174   * @var string
175   */
176  public $numFactors;
177  /**
178   * @var string
179   */
180  public $numParallelTree;
181  /**
182   * @var string
183   */
184  public $numTrials;
185  /**
186   * @var string
187   */
188  public $optimizationStrategy;
189  /**
190   * @var bool
191   */
192  public $preserveInputStructs;
193  /**
194   * @var string
195   */
196  public $sampledShapleyNumPaths;
197  public $subsample;
198  /**
199   * @var string
200   */
201  public $timeSeriesDataColumn;
202  /**
203   * @var string
204   */
205  public $timeSeriesIdColumn;
206  /**
207   * @var string[]
208   */
209  public $timeSeriesIdColumns;
210  /**
211   * @var string
212   */
213  public $timeSeriesTimestampColumn;
214  /**
215   * @var string
216   */
217  public $treeMethod;
218  /**
219   * @var string
220   */
221  public $userColumn;
222  public $walsAlpha;
223  /**
224   * @var bool
225   */
226  public $warmStart;
227
228  /**
229   * @param bool
230   */
231  public function setAdjustStepChanges($adjustStepChanges)
232  {
233    $this->adjustStepChanges = $adjustStepChanges;
234  }
235  /**
236   * @return bool
237   */
238  public function getAdjustStepChanges()
239  {
240    return $this->adjustStepChanges;
241  }
242  /**
243   * @param bool
244   */
245  public function setAutoArima($autoArima)
246  {
247    $this->autoArima = $autoArima;
248  }
249  /**
250   * @return bool
251   */
252  public function getAutoArima()
253  {
254    return $this->autoArima;
255  }
256  /**
257   * @param string
258   */
259  public function setAutoArimaMaxOrder($autoArimaMaxOrder)
260  {
261    $this->autoArimaMaxOrder = $autoArimaMaxOrder;
262  }
263  /**
264   * @return string
265   */
266  public function getAutoArimaMaxOrder()
267  {
268    return $this->autoArimaMaxOrder;
269  }
270  /**
271   * @param string
272   */
273  public function setBatchSize($batchSize)
274  {
275    $this->batchSize = $batchSize;
276  }
277  /**
278   * @return string
279   */
280  public function getBatchSize()
281  {
282    return $this->batchSize;
283  }
284  /**
285   * @param string
286   */
287  public function setBoosterType($boosterType)
288  {
289    $this->boosterType = $boosterType;
290  }
291  /**
292   * @return string
293   */
294  public function getBoosterType()
295  {
296    return $this->boosterType;
297  }
298  /**
299   * @param bool
300   */
301  public function setCalculatePValues($calculatePValues)
302  {
303    $this->calculatePValues = $calculatePValues;
304  }
305  /**
306   * @return bool
307   */
308  public function getCalculatePValues()
309  {
310    return $this->calculatePValues;
311  }
312  /**
313   * @param bool
314   */
315  public function setCleanSpikesAndDips($cleanSpikesAndDips)
316  {
317    $this->cleanSpikesAndDips = $cleanSpikesAndDips;
318  }
319  /**
320   * @return bool
321   */
322  public function getCleanSpikesAndDips()
323  {
324    return $this->cleanSpikesAndDips;
325  }
326  public function setColsampleBylevel($colsampleBylevel)
327  {
328    $this->colsampleBylevel = $colsampleBylevel;
329  }
330  public function getColsampleBylevel()
331  {
332    return $this->colsampleBylevel;
333  }
334  public function setColsampleBynode($colsampleBynode)
335  {
336    $this->colsampleBynode = $colsampleBynode;
337  }
338  public function getColsampleBynode()
339  {
340    return $this->colsampleBynode;
341  }
342  public function setColsampleBytree($colsampleBytree)
343  {
344    $this->colsampleBytree = $colsampleBytree;
345  }
346  public function getColsampleBytree()
347  {
348    return $this->colsampleBytree;
349  }
350  /**
351   * @param string
352   */
353  public function setDartNormalizeType($dartNormalizeType)
354  {
355    $this->dartNormalizeType = $dartNormalizeType;
356  }
357  /**
358   * @return string
359   */
360  public function getDartNormalizeType()
361  {
362    return $this->dartNormalizeType;
363  }
364  /**
365   * @param string
366   */
367  public function setDataFrequency($dataFrequency)
368  {
369    $this->dataFrequency = $dataFrequency;
370  }
371  /**
372   * @return string
373   */
374  public function getDataFrequency()
375  {
376    return $this->dataFrequency;
377  }
378  /**
379   * @param string
380   */
381  public function setDataSplitColumn($dataSplitColumn)
382  {
383    $this->dataSplitColumn = $dataSplitColumn;
384  }
385  /**
386   * @return string
387   */
388  public function getDataSplitColumn()
389  {
390    return $this->dataSplitColumn;
391  }
392  public function setDataSplitEvalFraction($dataSplitEvalFraction)
393  {
394    $this->dataSplitEvalFraction = $dataSplitEvalFraction;
395  }
396  public function getDataSplitEvalFraction()
397  {
398    return $this->dataSplitEvalFraction;
399  }
400  /**
401   * @param string
402   */
403  public function setDataSplitMethod($dataSplitMethod)
404  {
405    $this->dataSplitMethod = $dataSplitMethod;
406  }
407  /**
408   * @return string
409   */
410  public function getDataSplitMethod()
411  {
412    return $this->dataSplitMethod;
413  }
414  /**
415   * @param bool
416   */
417  public function setDecomposeTimeSeries($decomposeTimeSeries)
418  {
419    $this->decomposeTimeSeries = $decomposeTimeSeries;
420  }
421  /**
422   * @return bool
423   */
424  public function getDecomposeTimeSeries()
425  {
426    return $this->decomposeTimeSeries;
427  }
428  /**
429   * @param string
430   */
431  public function setDistanceType($distanceType)
432  {
433    $this->distanceType = $distanceType;
434  }
435  /**
436   * @return string
437   */
438  public function getDistanceType()
439  {
440    return $this->distanceType;
441  }
442  public function setDropout($dropout)
443  {
444    $this->dropout = $dropout;
445  }
446  public function getDropout()
447  {
448    return $this->dropout;
449  }
450  /**
451   * @param bool
452   */
453  public function setEarlyStop($earlyStop)
454  {
455    $this->earlyStop = $earlyStop;
456  }
457  /**
458   * @return bool
459   */
460  public function getEarlyStop()
461  {
462    return $this->earlyStop;
463  }
464  /**
465   * @param bool
466   */
467  public function setEnableGlobalExplain($enableGlobalExplain)
468  {
469    $this->enableGlobalExplain = $enableGlobalExplain;
470  }
471  /**
472   * @return bool
473   */
474  public function getEnableGlobalExplain()
475  {
476    return $this->enableGlobalExplain;
477  }
478  /**
479   * @param string
480   */
481  public function setFeedbackType($feedbackType)
482  {
483    $this->feedbackType = $feedbackType;
484  }
485  /**
486   * @return string
487   */
488  public function getFeedbackType()
489  {
490    return $this->feedbackType;
491  }
492  /**
493   * @param string[]
494   */
495  public function setHiddenUnits($hiddenUnits)
496  {
497    $this->hiddenUnits = $hiddenUnits;
498  }
499  /**
500   * @return string[]
501   */
502  public function getHiddenUnits()
503  {
504    return $this->hiddenUnits;
505  }
506  /**
507   * @param string
508   */
509  public function setHolidayRegion($holidayRegion)
510  {
511    $this->holidayRegion = $holidayRegion;
512  }
513  /**
514   * @return string
515   */
516  public function getHolidayRegion()
517  {
518    return $this->holidayRegion;
519  }
520  /**
521   * @param string
522   */
523  public function setHorizon($horizon)
524  {
525    $this->horizon = $horizon;
526  }
527  /**
528   * @return string
529   */
530  public function getHorizon()
531  {
532    return $this->horizon;
533  }
534  /**
535   * @param string[]
536   */
537  public function setHparamTuningObjectives($hparamTuningObjectives)
538  {
539    $this->hparamTuningObjectives = $hparamTuningObjectives;
540  }
541  /**
542   * @return string[]
543   */
544  public function getHparamTuningObjectives()
545  {
546    return $this->hparamTuningObjectives;
547  }
548  /**
549   * @param bool
550   */
551  public function setIncludeDrift($includeDrift)
552  {
553    $this->includeDrift = $includeDrift;
554  }
555  /**
556   * @return bool
557   */
558  public function getIncludeDrift()
559  {
560    return $this->includeDrift;
561  }
562  public function setInitialLearnRate($initialLearnRate)
563  {
564    $this->initialLearnRate = $initialLearnRate;
565  }
566  public function getInitialLearnRate()
567  {
568    return $this->initialLearnRate;
569  }
570  /**
571   * @param string[]
572   */
573  public function setInputLabelColumns($inputLabelColumns)
574  {
575    $this->inputLabelColumns = $inputLabelColumns;
576  }
577  /**
578   * @return string[]
579   */
580  public function getInputLabelColumns()
581  {
582    return $this->inputLabelColumns;
583  }
584  /**
585   * @param string
586   */
587  public function setIntegratedGradientsNumSteps($integratedGradientsNumSteps)
588  {
589    $this->integratedGradientsNumSteps = $integratedGradientsNumSteps;
590  }
591  /**
592   * @return string
593   */
594  public function getIntegratedGradientsNumSteps()
595  {
596    return $this->integratedGradientsNumSteps;
597  }
598  /**
599   * @param string
600   */
601  public function setItemColumn($itemColumn)
602  {
603    $this->itemColumn = $itemColumn;
604  }
605  /**
606   * @return string
607   */
608  public function getItemColumn()
609  {
610    return $this->itemColumn;
611  }
612  /**
613   * @param string
614   */
615  public function setKmeansInitializationColumn($kmeansInitializationColumn)
616  {
617    $this->kmeansInitializationColumn = $kmeansInitializationColumn;
618  }
619  /**
620   * @return string
621   */
622  public function getKmeansInitializationColumn()
623  {
624    return $this->kmeansInitializationColumn;
625  }
626  /**
627   * @param string
628   */
629  public function setKmeansInitializationMethod($kmeansInitializationMethod)
630  {
631    $this->kmeansInitializationMethod = $kmeansInitializationMethod;
632  }
633  /**
634   * @return string
635   */
636  public function getKmeansInitializationMethod()
637  {
638    return $this->kmeansInitializationMethod;
639  }
640  public function setL1Regularization($l1Regularization)
641  {
642    $this->l1Regularization = $l1Regularization;
643  }
644  public function getL1Regularization()
645  {
646    return $this->l1Regularization;
647  }
648  public function setL2Regularization($l2Regularization)
649  {
650    $this->l2Regularization = $l2Regularization;
651  }
652  public function getL2Regularization()
653  {
654    return $this->l2Regularization;
655  }
656  public function setLabelClassWeights($labelClassWeights)
657  {
658    $this->labelClassWeights = $labelClassWeights;
659  }
660  public function getLabelClassWeights()
661  {
662    return $this->labelClassWeights;
663  }
664  public function setLearnRate($learnRate)
665  {
666    $this->learnRate = $learnRate;
667  }
668  public function getLearnRate()
669  {
670    return $this->learnRate;
671  }
672  /**
673   * @param string
674   */
675  public function setLearnRateStrategy($learnRateStrategy)
676  {
677    $this->learnRateStrategy = $learnRateStrategy;
678  }
679  /**
680   * @return string
681   */
682  public function getLearnRateStrategy()
683  {
684    return $this->learnRateStrategy;
685  }
686  /**
687   * @param string
688   */
689  public function setLossType($lossType)
690  {
691    $this->lossType = $lossType;
692  }
693  /**
694   * @return string
695   */
696  public function getLossType()
697  {
698    return $this->lossType;
699  }
700  /**
701   * @param string
702   */
703  public function setMaxIterations($maxIterations)
704  {
705    $this->maxIterations = $maxIterations;
706  }
707  /**
708   * @return string
709   */
710  public function getMaxIterations()
711  {
712    return $this->maxIterations;
713  }
714  /**
715   * @param string
716   */
717  public function setMaxParallelTrials($maxParallelTrials)
718  {
719    $this->maxParallelTrials = $maxParallelTrials;
720  }
721  /**
722   * @return string
723   */
724  public function getMaxParallelTrials()
725  {
726    return $this->maxParallelTrials;
727  }
728  /**
729   * @param string
730   */
731  public function setMaxTreeDepth($maxTreeDepth)
732  {
733    $this->maxTreeDepth = $maxTreeDepth;
734  }
735  /**
736   * @return string
737   */
738  public function getMaxTreeDepth()
739  {
740    return $this->maxTreeDepth;
741  }
742  public function setMinRelativeProgress($minRelativeProgress)
743  {
744    $this->minRelativeProgress = $minRelativeProgress;
745  }
746  public function getMinRelativeProgress()
747  {
748    return $this->minRelativeProgress;
749  }
750  public function setMinSplitLoss($minSplitLoss)
751  {
752    $this->minSplitLoss = $minSplitLoss;
753  }
754  public function getMinSplitLoss()
755  {
756    return $this->minSplitLoss;
757  }
758  /**
759   * @param string
760   */
761  public function setMinTreeChildWeight($minTreeChildWeight)
762  {
763    $this->minTreeChildWeight = $minTreeChildWeight;
764  }
765  /**
766   * @return string
767   */
768  public function getMinTreeChildWeight()
769  {
770    return $this->minTreeChildWeight;
771  }
772  /**
773   * @param string
774   */
775  public function setModelUri($modelUri)
776  {
777    $this->modelUri = $modelUri;
778  }
779  /**
780   * @return string
781   */
782  public function getModelUri()
783  {
784    return $this->modelUri;
785  }
786  /**
787   * @param ArimaOrder
788   */
789  public function setNonSeasonalOrder(ArimaOrder $nonSeasonalOrder)
790  {
791    $this->nonSeasonalOrder = $nonSeasonalOrder;
792  }
793  /**
794   * @return ArimaOrder
795   */
796  public function getNonSeasonalOrder()
797  {
798    return $this->nonSeasonalOrder;
799  }
800  /**
801   * @param string
802   */
803  public function setNumClusters($numClusters)
804  {
805    $this->numClusters = $numClusters;
806  }
807  /**
808   * @return string
809   */
810  public function getNumClusters()
811  {
812    return $this->numClusters;
813  }
814  /**
815   * @param string
816   */
817  public function setNumFactors($numFactors)
818  {
819    $this->numFactors = $numFactors;
820  }
821  /**
822   * @return string
823   */
824  public function getNumFactors()
825  {
826    return $this->numFactors;
827  }
828  /**
829   * @param string
830   */
831  public function setNumParallelTree($numParallelTree)
832  {
833    $this->numParallelTree = $numParallelTree;
834  }
835  /**
836   * @return string
837   */
838  public function getNumParallelTree()
839  {
840    return $this->numParallelTree;
841  }
842  /**
843   * @param string
844   */
845  public function setNumTrials($numTrials)
846  {
847    $this->numTrials = $numTrials;
848  }
849  /**
850   * @return string
851   */
852  public function getNumTrials()
853  {
854    return $this->numTrials;
855  }
856  /**
857   * @param string
858   */
859  public function setOptimizationStrategy($optimizationStrategy)
860  {
861    $this->optimizationStrategy = $optimizationStrategy;
862  }
863  /**
864   * @return string
865   */
866  public function getOptimizationStrategy()
867  {
868    return $this->optimizationStrategy;
869  }
870  /**
871   * @param bool
872   */
873  public function setPreserveInputStructs($preserveInputStructs)
874  {
875    $this->preserveInputStructs = $preserveInputStructs;
876  }
877  /**
878   * @return bool
879   */
880  public function getPreserveInputStructs()
881  {
882    return $this->preserveInputStructs;
883  }
884  /**
885   * @param string
886   */
887  public function setSampledShapleyNumPaths($sampledShapleyNumPaths)
888  {
889    $this->sampledShapleyNumPaths = $sampledShapleyNumPaths;
890  }
891  /**
892   * @return string
893   */
894  public function getSampledShapleyNumPaths()
895  {
896    return $this->sampledShapleyNumPaths;
897  }
898  public function setSubsample($subsample)
899  {
900    $this->subsample = $subsample;
901  }
902  public function getSubsample()
903  {
904    return $this->subsample;
905  }
906  /**
907   * @param string
908   */
909  public function setTimeSeriesDataColumn($timeSeriesDataColumn)
910  {
911    $this->timeSeriesDataColumn = $timeSeriesDataColumn;
912  }
913  /**
914   * @return string
915   */
916  public function getTimeSeriesDataColumn()
917  {
918    return $this->timeSeriesDataColumn;
919  }
920  /**
921   * @param string
922   */
923  public function setTimeSeriesIdColumn($timeSeriesIdColumn)
924  {
925    $this->timeSeriesIdColumn = $timeSeriesIdColumn;
926  }
927  /**
928   * @return string
929   */
930  public function getTimeSeriesIdColumn()
931  {
932    return $this->timeSeriesIdColumn;
933  }
934  /**
935   * @param string[]
936   */
937  public function setTimeSeriesIdColumns($timeSeriesIdColumns)
938  {
939    $this->timeSeriesIdColumns = $timeSeriesIdColumns;
940  }
941  /**
942   * @return string[]
943   */
944  public function getTimeSeriesIdColumns()
945  {
946    return $this->timeSeriesIdColumns;
947  }
948  /**
949   * @param string
950   */
951  public function setTimeSeriesTimestampColumn($timeSeriesTimestampColumn)
952  {
953    $this->timeSeriesTimestampColumn = $timeSeriesTimestampColumn;
954  }
955  /**
956   * @return string
957   */
958  public function getTimeSeriesTimestampColumn()
959  {
960    return $this->timeSeriesTimestampColumn;
961  }
962  /**
963   * @param string
964   */
965  public function setTreeMethod($treeMethod)
966  {
967    $this->treeMethod = $treeMethod;
968  }
969  /**
970   * @return string
971   */
972  public function getTreeMethod()
973  {
974    return $this->treeMethod;
975  }
976  /**
977   * @param string
978   */
979  public function setUserColumn($userColumn)
980  {
981    $this->userColumn = $userColumn;
982  }
983  /**
984   * @return string
985   */
986  public function getUserColumn()
987  {
988    return $this->userColumn;
989  }
990  public function setWalsAlpha($walsAlpha)
991  {
992    $this->walsAlpha = $walsAlpha;
993  }
994  public function getWalsAlpha()
995  {
996    return $this->walsAlpha;
997  }
998  /**
999   * @param bool
1000   */
1001  public function setWarmStart($warmStart)
1002  {
1003    $this->warmStart = $warmStart;
1004  }
1005  /**
1006   * @return bool
1007   */
1008  public function getWarmStart()
1009  {
1010    return $this->warmStart;
1011  }
1012}
1013
1014// Adding a class alias for backwards compatibility with the previous class name.
1015class_alias(TrainingOptions::class, 'Google_Service_Bigquery_TrainingOptions');
1016