Skip to content

Commit

Permalink
docs: fix formatting of generated client docstrings (#1009)
Browse files Browse the repository at this point in the history
chore: fix docstring for first attribute of protos

committer: @busunkim96
PiperOrigin-RevId: 401271153

Source-Link: googleapis/googleapis@787f8c9

Source-Link: googleapis/googleapis-gen@81decff
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODFkZWNmZmU5ZmM3MjM5NmE4MTUzZTc1NmQxZDY3YTZlZWNmZDYyMCJ9

* 🦉 Updates from OwlBot

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Tim Swast <swast@google.com>
  • Loading branch information
3 people committed Oct 8, 2021
1 parent c8124e9 commit f7b0ee4
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 2 deletions.
1 change: 1 addition & 0 deletions google/cloud/bigquery_v2/types/encryption_config.py
Expand Up @@ -25,6 +25,7 @@

class EncryptionConfiguration(proto.Message):
r"""
Attributes:
kms_key_name (google.protobuf.wrappers_pb2.StringValue):
Optional. Describes the Cloud KMS encryption
Expand Down
30 changes: 28 additions & 2 deletions google/cloud/bigquery_v2/types/model.py
Expand Up @@ -38,6 +38,7 @@

class Model(proto.Message):
r"""
Attributes:
etag (str):
Output only. A hash of this resource.
Expand Down Expand Up @@ -251,7 +252,8 @@ class FeedbackType(proto.Enum):
EXPLICIT = 2

class SeasonalPeriod(proto.Message):
r""" """
r"""
"""

class SeasonalPeriodType(proto.Enum):
r""""""
Expand All @@ -264,7 +266,8 @@ class SeasonalPeriodType(proto.Enum):
YEARLY = 6

class KmeansEnums(proto.Message):
r""" """
r"""
"""

class KmeansInitializationMethod(proto.Enum):
r"""Indicates the method used to initialize the centroids for
Expand Down Expand Up @@ -386,6 +389,7 @@ class BinaryClassificationMetrics(proto.Message):

class BinaryConfusionMatrix(proto.Message):
r"""Confusion matrix for binary classification models.
Attributes:
positive_class_threshold (google.protobuf.wrappers_pb2.DoubleValue):
Threshold value used when computing each of
Expand Down Expand Up @@ -464,6 +468,7 @@ class MultiClassClassificationMetrics(proto.Message):

class ConfusionMatrix(proto.Message):
r"""Confusion matrix for multi-class classification models.
Attributes:
confidence_threshold (google.protobuf.wrappers_pb2.DoubleValue):
Confidence threshold used when computing the
Expand All @@ -474,6 +479,7 @@ class ConfusionMatrix(proto.Message):

class Entry(proto.Message):
r"""A single entry in the confusion matrix.
Attributes:
predicted_label (str):
The predicted label. For confidence_threshold > 0, we will
Expand All @@ -491,6 +497,7 @@ class Entry(proto.Message):

class Row(proto.Message):
r"""A single row in the confusion matrix.
Attributes:
actual_label (str):
The original label of this row.
Expand Down Expand Up @@ -525,6 +532,7 @@ class Row(proto.Message):

class ClusteringMetrics(proto.Message):
r"""Evaluation metrics for clustering models.
Attributes:
davies_bouldin_index (google.protobuf.wrappers_pb2.DoubleValue):
Davies-Bouldin index.
Expand All @@ -537,6 +545,7 @@ class ClusteringMetrics(proto.Message):

class Cluster(proto.Message):
r"""Message containing the information about one cluster.
Attributes:
centroid_id (int):
Centroid id.
Expand All @@ -550,6 +559,7 @@ class Cluster(proto.Message):

class FeatureValue(proto.Message):
r"""Representative value of a single feature within the cluster.
Attributes:
feature_column (str):
The feature column name.
Expand All @@ -562,6 +572,7 @@ class FeatureValue(proto.Message):

class CategoricalValue(proto.Message):
r"""Representative value of a categorical feature.
Attributes:
category_counts (Sequence[google.cloud.bigquery_v2.types.Model.ClusteringMetrics.Cluster.FeatureValue.CategoricalValue.CategoryCount]):
Counts of all categories for the categorical feature. If
Expand All @@ -573,6 +584,7 @@ class CategoricalValue(proto.Message):

class CategoryCount(proto.Message):
r"""Represents the count of a single category within the cluster.
Attributes:
category (str):
The name of category.
Expand Down Expand Up @@ -668,6 +680,7 @@ class RankingMetrics(proto.Message):

class ArimaForecastingMetrics(proto.Message):
r"""Model evaluation metrics for ARIMA forecasting models.
Attributes:
non_seasonal_order (Sequence[google.cloud.bigquery_v2.types.Model.ArimaOrder]):
Non-seasonal order.
Expand Down Expand Up @@ -857,6 +870,7 @@ class ArimaOrder(proto.Message):

class ArimaFittingMetrics(proto.Message):
r"""ARIMA model fitting metrics.
Attributes:
log_likelihood (float):
Log-likelihood.
Expand Down Expand Up @@ -888,6 +902,7 @@ class GlobalExplanation(proto.Message):

class Explanation(proto.Message):
r"""Explanation for a single feature.
Attributes:
feature_name (str):
Full name of the feature. For non-numerical features, will
Expand All @@ -910,6 +925,7 @@ class Explanation(proto.Message):

class TrainingRun(proto.Message):
r"""Information about a single training query run for the model.
Attributes:
training_options (google.cloud.bigquery_v2.types.Model.TrainingRun.TrainingOptions):
Options that were used for this training run,
Expand All @@ -935,6 +951,7 @@ class TrainingRun(proto.Message):

class TrainingOptions(proto.Message):
r"""Options used in model training.
Attributes:
max_iterations (int):
The maximum number of iterations in training.
Expand Down Expand Up @@ -1182,6 +1199,7 @@ class TrainingOptions(proto.Message):

class IterationResult(proto.Message):
r"""Information about a single iteration of the training run.
Attributes:
index (google.protobuf.wrappers_pb2.Int32Value):
Index of the iteration, 0 based.
Expand All @@ -1205,6 +1223,7 @@ class IterationResult(proto.Message):

class ClusterInfo(proto.Message):
r"""Information about a single cluster for clustering model.
Attributes:
centroid_id (int):
Centroid id.
Expand Down Expand Up @@ -1241,6 +1260,7 @@ class ArimaResult(proto.Message):

class ArimaCoefficients(proto.Message):
r"""Arima coefficients.
Attributes:
auto_regressive_coefficients (Sequence[float]):
Auto-regressive coefficients, an array of
Expand All @@ -1263,6 +1283,7 @@ class ArimaCoefficients(proto.Message):

class ArimaModelInfo(proto.Message):
r"""Arima model information.
Attributes:
non_seasonal_order (google.cloud.bigquery_v2.types.Model.ArimaOrder):
Non-seasonal order.
Expand Down Expand Up @@ -1409,6 +1430,7 @@ class ArimaModelInfo(proto.Message):

class GetModelRequest(proto.Message):
r"""
Attributes:
project_id (str):
Required. Project ID of the requested model.
Expand All @@ -1425,6 +1447,7 @@ class GetModelRequest(proto.Message):

class PatchModelRequest(proto.Message):
r"""
Attributes:
project_id (str):
Required. Project ID of the model to patch.
Expand All @@ -1447,6 +1470,7 @@ class PatchModelRequest(proto.Message):

class DeleteModelRequest(proto.Message):
r"""
Attributes:
project_id (str):
Required. Project ID of the model to delete.
Expand All @@ -1463,6 +1487,7 @@ class DeleteModelRequest(proto.Message):

class ListModelsRequest(proto.Message):
r"""
Attributes:
project_id (str):
Required. Project ID of the models to list.
Expand All @@ -1487,6 +1512,7 @@ class ListModelsRequest(proto.Message):

class ListModelsResponse(proto.Message):
r"""
Attributes:
models (Sequence[google.cloud.bigquery_v2.types.Model]):
Models in the requested dataset. Only the following fields
Expand Down
1 change: 1 addition & 0 deletions google/cloud/bigquery_v2/types/model_reference.py
Expand Up @@ -23,6 +23,7 @@

class ModelReference(proto.Message):
r"""Id path of a model.
Attributes:
project_id (str):
Required. The ID of the project containing
Expand Down
3 changes: 3 additions & 0 deletions google/cloud/bigquery_v2/types/standard_sql.py
Expand Up @@ -78,6 +78,7 @@ class TypeKind(proto.Enum):

class StandardSqlField(proto.Message):
r"""A field or a column.
Attributes:
name (str):
Optional. The name of this field. Can be
Expand All @@ -96,6 +97,7 @@ class StandardSqlField(proto.Message):

class StandardSqlStructType(proto.Message):
r"""
Attributes:
fields (Sequence[google.cloud.bigquery_v2.types.StandardSqlField]):
Expand All @@ -106,6 +108,7 @@ class StandardSqlStructType(proto.Message):

class StandardSqlTableType(proto.Message):
r"""A table type
Attributes:
columns (Sequence[google.cloud.bigquery_v2.types.StandardSqlField]):
The columns in this table type
Expand Down
1 change: 1 addition & 0 deletions google/cloud/bigquery_v2/types/table_reference.py
Expand Up @@ -23,6 +23,7 @@

class TableReference(proto.Message):
r"""
Attributes:
project_id (str):
Required. The ID of the project containing
Expand Down

0 comments on commit f7b0ee4

Please sign in to comment.