Skip to content

Commit

Permalink
clean up docstrings that are not rendered properly in reference doc (#24
Browse files Browse the repository at this point in the history 
)

Co-authored-by: Vinny Senthil <vinnysenthil@gmail.com>
  • Loading branch information
@dizcology @vinnysenthil
dizcology and vinnysenthil committed Oct 12, 2020
1 parent d3d8670 commit 0fc50ab
Show file tree
Hide file tree
Showing 34 changed files with 534 additions and 498 deletions.
41 changes: 20 additions & 21 deletions google/cloud/aiplatform_v1beta1/services/dataset_service/client.py
View file
Expand Up @@ -165,7 +165,7 @@ def create_dataset(
Args:
request (:class:`~.dataset_service.CreateDatasetRequest`):
The request object. Request message for
[DatasetService.CreateDataset][google.cloud.aiplatform.v1beta1.DatasetService.CreateDataset].
``DatasetService.CreateDataset``.
parent (:class:`str`):
Required. The resource name of the Location to create
the Dataset in. Format:
Expand All @@ -190,7 +190,7 @@ def create_dataset(
An object representing a long-running operation.
The result type for the operation will be
:class:``~.gca_dataset.Dataset``: A collection of
:class:`~.gca_dataset.Dataset`: A collection of
DataItems and Annotations on them.
"""
Expand Down Expand Up @@ -249,7 +249,7 @@ def get_dataset(
Args:
request (:class:`~.dataset_service.GetDatasetRequest`):
The request object. Request message for
[DatasetService.GetDataset][google.cloud.aiplatform.v1beta1.DatasetService.GetDataset].
``DatasetService.GetDataset``.
name (:class:`str`):
Required. The name of the Dataset
resource.
Expand Down Expand Up @@ -319,7 +319,7 @@ def update_dataset(
Args:
request (:class:`~.dataset_service.UpdateDatasetRequest`):
The request object. Request message for
[DatasetService.UpdateDataset][google.cloud.aiplatform.v1beta1.DatasetService.UpdateDataset].
``DatasetService.UpdateDataset``.
dataset (:class:`~.gca_dataset.Dataset`):
Required. The Dataset which replaces
the resource on the server.
Expand All @@ -330,8 +330,7 @@ def update_dataset(
Required. The update mask applies to the resource. For
the ``FieldMask`` definition, see
[FieldMask](https:
//tinyurl.com/dev-google-protobuf#google.protobuf.FieldMask).
[FieldMask](https://tinyurl.com/dev-google-protobuf#google.protobuf.FieldMask).
Updatable fields:
- ``display_name``
Expand Down Expand Up @@ -400,7 +399,7 @@ def list_datasets(
Args:
request (:class:`~.dataset_service.ListDatasetsRequest`):
The request object. Request message for
[DatasetService.ListDatasets][google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets].
``DatasetService.ListDatasets``.
parent (:class:`str`):
Required. The name of the Dataset's parent resource.
Format: ``projects/{project}/locations/{location}``
Expand All @@ -417,7 +416,7 @@ def list_datasets(
Returns:
~.pagers.ListDatasetsPager:
Response message for
[DatasetService.ListDatasets][google.cloud.aiplatform.v1beta1.DatasetService.ListDatasets].
``DatasetService.ListDatasets``.
Iterating over this object will yield results and
resolve additional pages automatically.
Expand Down Expand Up @@ -480,7 +479,7 @@ def delete_dataset(
Args:
request (:class:`~.dataset_service.DeleteDatasetRequest`):
The request object. Request message for
[DatasetService.DeleteDataset][google.cloud.aiplatform.v1beta1.DatasetService.DeleteDataset].
``DatasetService.DeleteDataset``.
name (:class:`str`):
Required. The resource name of the Dataset to delete.
Format:
Expand All @@ -500,7 +499,7 @@ def delete_dataset(
An object representing a long-running operation.
The result type for the operation will be
:class:``~.empty.Empty``: A generic empty message that
:class:`~.empty.Empty`: A generic empty message that
you can re-use to avoid defining duplicated empty
messages in your APIs. A typical example is to use it as
the request or the response type of an API method. For
Expand Down Expand Up @@ -570,7 +569,7 @@ def import_data(
Args:
request (:class:`~.dataset_service.ImportDataRequest`):
The request object. Request message for
[DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData].
``DatasetService.ImportData``.
name (:class:`str`):
Required. The name of the Dataset resource. Format:
``projects/{project}/locations/{location}/datasets/{dataset}``
Expand All @@ -596,9 +595,9 @@ def import_data(
An object representing a long-running operation.
The result type for the operation will be
:class:``~.dataset_service.ImportDataResponse``:
:class:`~.dataset_service.ImportDataResponse`:
Response message for
[DatasetService.ImportData][google.cloud.aiplatform.v1beta1.DatasetService.ImportData].
``DatasetService.ImportData``.
"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -655,7 +654,7 @@ def export_data(
Args:
request (:class:`~.dataset_service.ExportDataRequest`):
The request object. Request message for
[DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData].
``DatasetService.ExportData``.
name (:class:`str`):
Required. The name of the Dataset resource. Format:
``projects/{project}/locations/{location}/datasets/{dataset}``
Expand All @@ -680,9 +679,9 @@ def export_data(
An object representing a long-running operation.
The result type for the operation will be
:class:``~.dataset_service.ExportDataResponse``:
:class:`~.dataset_service.ExportDataResponse`:
Response message for
[DatasetService.ExportData][google.cloud.aiplatform.v1beta1.DatasetService.ExportData].
``DatasetService.ExportData``.
"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -738,7 +737,7 @@ def list_data_items(
Args:
request (:class:`~.dataset_service.ListDataItemsRequest`):
The request object. Request message for
[DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems].
``DatasetService.ListDataItems``.
parent (:class:`str`):
Required. The resource name of the Dataset to list
DataItems from. Format:
Expand All @@ -756,7 +755,7 @@ def list_data_items(
Returns:
~.pagers.ListDataItemsPager:
Response message for
[DatasetService.ListDataItems][google.cloud.aiplatform.v1beta1.DatasetService.ListDataItems].
``DatasetService.ListDataItems``.
Iterating over this object will yield results and
resolve additional pages automatically.
Expand Down Expand Up @@ -819,7 +818,7 @@ def get_annotation_spec(
Args:
request (:class:`~.dataset_service.GetAnnotationSpecRequest`):
The request object. Request message for
[DatasetService.GetAnnotationSpec][google.cloud.aiplatform.v1beta1.DatasetService.GetAnnotationSpec].
``DatasetService.GetAnnotationSpec``.
name (:class:`str`):
Required. The name of the AnnotationSpec resource.
Format:
Expand Down Expand Up @@ -892,7 +891,7 @@ def list_annotations(
Args:
request (:class:`~.dataset_service.ListAnnotationsRequest`):
The request object. Request message for
[DatasetService.ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations].
``DatasetService.ListAnnotations``.
parent (:class:`str`):
Required. The resource name of the DataItem to list
Annotations from. Format:
Expand All @@ -911,7 +910,7 @@ def list_annotations(
Returns:
~.pagers.ListAnnotationsPager:
Response message for
[DatasetService.ListAnnotations][google.cloud.aiplatform.v1beta1.DatasetService.ListAnnotations].
``DatasetService.ListAnnotations``.
Iterating over this object will yield results and
resolve additional pages automatically.
Expand Down
38 changes: 19 additions & 19 deletions google/cloud/aiplatform_v1beta1/services/endpoint_service/client.py
View file
Expand Up @@ -161,7 +161,7 @@ def create_endpoint(
Args:
request (:class:`~.endpoint_service.CreateEndpointRequest`):
The request object. Request message for
[EndpointService.CreateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.CreateEndpoint].
``EndpointService.CreateEndpoint``.
parent (:class:`str`):
Required. The resource name of the Location to create
the Endpoint in. Format:
Expand All @@ -186,7 +186,7 @@ def create_endpoint(
An object representing a long-running operation.
The result type for the operation will be
:class:``~.gca_endpoint.Endpoint``: Models are deployed
:class:`~.gca_endpoint.Endpoint`: Models are deployed
into it, and afterwards Endpoint is called to obtain
predictions and explanations.
Expand Down Expand Up @@ -246,7 +246,7 @@ def get_endpoint(
Args:
request (:class:`~.endpoint_service.GetEndpointRequest`):
The request object. Request message for
[EndpointService.GetEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.GetEndpoint]
``EndpointService.GetEndpoint``
name (:class:`str`):
Required. The name of the Endpoint resource. Format:
``projects/{project}/locations/{location}/endpoints/{endpoint}``
Expand Down Expand Up @@ -318,7 +318,7 @@ def list_endpoints(
Args:
request (:class:`~.endpoint_service.ListEndpointsRequest`):
The request object. Request message for
[EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints].
``EndpointService.ListEndpoints``.
parent (:class:`str`):
Required. The resource name of the Location from which
to list the Endpoints. Format:
Expand All @@ -336,7 +336,7 @@ def list_endpoints(
Returns:
~.pagers.ListEndpointsPager:
Response message for
[EndpointService.ListEndpoints][google.cloud.aiplatform.v1beta1.EndpointService.ListEndpoints].
``EndpointService.ListEndpoints``.
Iterating over this object will yield results and
resolve additional pages automatically.
Expand Down Expand Up @@ -400,7 +400,7 @@ def update_endpoint(
Args:
request (:class:`~.endpoint_service.UpdateEndpointRequest`):
The request object. Request message for
[EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint].
``EndpointService.UpdateEndpoint``.
endpoint (:class:`~.gca_endpoint.Endpoint`):
Required. The Endpoint which replaces
the resource on the server.
Expand Down Expand Up @@ -474,7 +474,7 @@ def delete_endpoint(
Args:
request (:class:`~.endpoint_service.DeleteEndpointRequest`):
The request object. Request message for
[EndpointService.DeleteEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.DeleteEndpoint].
``EndpointService.DeleteEndpoint``.
name (:class:`str`):
Required. The name of the Endpoint resource to be
deleted. Format:
Expand All @@ -494,7 +494,7 @@ def delete_endpoint(
An object representing a long-running operation.
The result type for the operation will be
:class:``~.empty.Empty``: A generic empty message that
:class:`~.empty.Empty`: A generic empty message that
you can re-use to avoid defining duplicated empty
messages in your APIs. A typical example is to use it as
the request or the response type of an API method. For
Expand Down Expand Up @@ -568,7 +568,7 @@ def deploy_model(
Args:
request (:class:`~.endpoint_service.DeployModelRequest`):
The request object. Request message for
[EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel].
``EndpointService.DeployModel``.
endpoint (:class:`str`):
Required. The name of the Endpoint resource into which
to deploy a Model. Format:
Expand All @@ -579,10 +579,10 @@ def deploy_model(
deployed_model (:class:`~.gca_endpoint.DeployedModel`):
Required. The DeployedModel to be created within the
Endpoint. Note that
[Endpoint.traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split]
``Endpoint.traffic_split``
must be updated for the DeployedModel to start receiving
traffic, either as part of this call, or via
[EndpointService.UpdateEndpoint][google.cloud.aiplatform.v1beta1.EndpointService.UpdateEndpoint].
``EndpointService.UpdateEndpoint``.
This corresponds to the ``deployed_model`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
Expand All @@ -592,15 +592,15 @@ def deploy_model(
DeployedModel.
If this field is non-empty, then the Endpoint's
[traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split]
``traffic_split``
will be overwritten with it. To refer to the ID of the
just being deployed Model, a "0" should be used, and the
actual ID of the new DeployedModel will be filled in its
place by this method. The traffic percentage values must
add up to 100.
If this field is empty, then the Endpoint's
[traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split]
``traffic_split``
is not updated.
This corresponds to the ``traffic_split`` field
on the ``request`` instance; if ``request`` is provided, this
Expand All @@ -617,9 +617,9 @@ def deploy_model(
An object representing a long-running operation.
The result type for the operation will be
:class:``~.endpoint_service.DeployModelResponse``:
:class:`~.endpoint_service.DeployModelResponse`:
Response message for
[EndpointService.DeployModel][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel].
``EndpointService.DeployModel``.
"""
# Create or coerce a protobuf request object.
Expand Down Expand Up @@ -685,7 +685,7 @@ def undeploy_model(
Args:
request (:class:`~.endpoint_service.UndeployModelRequest`):
The request object. Request message for
[EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel].
``EndpointService.UndeployModel``.
endpoint (:class:`str`):
Required. The name of the Endpoint resource from which
to undeploy a Model. Format:
Expand All @@ -701,7 +701,7 @@ def undeploy_model(
should not be set.
traffic_split (:class:`Sequence[~.endpoint_service.UndeployModelRequest.TrafficSplitEntry]`):
If this field is provided, then the Endpoint's
[traffic_split][google.cloud.aiplatform.v1beta1.Endpoint.traffic_split]
``traffic_split``
will be overwritten with it. If last DeployedModel is
being undeployed from the Endpoint, the
[Endpoint.traffic_split] will always end up empty when
Expand All @@ -724,9 +724,9 @@ def undeploy_model(
An object representing a long-running operation.
The result type for the operation will be
:class:``~.endpoint_service.UndeployModelResponse``:
:class:`~.endpoint_service.UndeployModelResponse`:
Response message for
[EndpointService.UndeployModel][google.cloud.aiplatform.v1beta1.EndpointService.UndeployModel].
``EndpointService.UndeployModel``.
"""
# Create or coerce a protobuf request object.
Expand Down

0 comments on commit 0fc50ab

Please sign in to comment.