Skip to content

Commit 52273c2

Browse files
authored
docs: Include time dependency in documentation for weight, time, and target columns. (#1102)
Updates documentation for Vertex Forecasting run function to specify column types for columns with time dependency properties.
1 parent a9a8f44 commit 52273c2

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

google/cloud/aiplatform/training_jobs.py

+10-6
Original file line numberDiff line numberDiff line change
@@ -4005,9 +4005,11 @@ def run(
40054005
For time series Datasets, all their data is exported to
40064006
training, to pick and choose from.
40074007
target_column (str):
4008-
Required. Name of the column that the Model is to predict values for.
4008+
Required. Name of the column that the Model is to predict values for. This
4009+
column must be unavailable at forecast.
40094010
time_column (str):
40104011
Required. Name of the column that identifies time order in the time series.
4012+
This column must be available at forecast.
40114013
time_series_identifier_column (str):
40124014
Required. Name of the column that identifies the time series.
40134015
unavailable_at_forecast_columns (List[str]):
@@ -4046,7 +4048,7 @@ def run(
40464048
during Model training. The column must have numeric values between 0 and
40474049
10000 inclusively, and 0 value means that the row is ignored.
40484050
If the weight column field is not set, then all rows are assumed to have
4049-
equal weight of 1.
4051+
equal weight of 1. This column must be available at forecast.
40504052
time_series_attribute_columns (List[str]):
40514053
Optional. Column names that should be used as attribute columns.
40524054
Each column is constant within a time series.
@@ -4078,7 +4080,7 @@ def run(
40784080
Applies only if [export_evaluated_data_items] is True and
40794081
[export_evaluated_data_items_bigquery_destination_uri] is specified.
40804082
quantiles (List[float]):
4081-
Quantiles to use for the `minizmize-quantile-loss`
4083+
Quantiles to use for the `minimize-quantile-loss`
40824084
[AutoMLForecastingTrainingJob.optimization_objective]. This argument is required in
40834085
this case.
40844086
@@ -4236,9 +4238,11 @@ def _run(
42364238
For time series Datasets, all their data is exported to
42374239
training, to pick and choose from.
42384240
target_column (str):
4239-
Required. Name of the column that the Model is to predict values for.
4241+
Required. Name of the column that the Model is to predict values for. This
4242+
column must be unavailable at forecast.
42404243
time_column (str):
42414244
Required. Name of the column that identifies time order in the time series.
4245+
This column must be available at forecast.
42424246
time_series_identifier_column (str):
42434247
Required. Name of the column that identifies the time series.
42444248
unavailable_at_forecast_columns (List[str]):
@@ -4286,7 +4290,7 @@ def _run(
42864290
during Model training. The column must have numeric values between 0 and
42874291
10000 inclusively, and 0 value means that the row is ignored.
42884292
If the weight column field is not set, then all rows are assumed to have
4289-
equal weight of 1.
4293+
equal weight of 1. This column must be available at forecast.
42904294
time_series_attribute_columns (List[str]):
42914295
Optional. Column names that should be used as attribute columns.
42924296
Each column is constant within a time series.
@@ -4317,7 +4321,7 @@ def _run(
43174321
Applies only if [export_evaluated_data_items] is True and
43184322
[export_evaluated_data_items_bigquery_destination_uri] is specified.
43194323
quantiles (List[float]):
4320-
Quantiles to use for the `minizmize-quantile-loss`
4324+
Quantiles to use for the `minimize-quantile-loss`
43214325
[AutoMLForecastingTrainingJob.optimization_objective]. This argument is required in
43224326
this case.
43234327

0 commit comments

Comments
 (0)