Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Fixed docstrings for wildcards and matching engine type #1220

Merged
merged 6 commits into from
Jun 23, 2022
Merged

fix: Fixed docstrings for wildcards and matching engine type #1220

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
063d15c
fix: Fixed docstrings for wildcards and matching engine type
ivanmkc May 11, 2022
46ac631
Reverted FeatureStore wildcard removal from docstring
ivanmkc May 31, 2022
5ba4d19
Merge branch 'main' into imkc--fix-docstrings
ivanmkc Jun 3, 2022
e518637
Merge branch 'main' into imkc--fix-docstrings
ivanmkc Jun 9, 2022
52918a5
Merge branch 'main' into imkc--fix-docstrings
nayaknishant Jun 22, 2022
b72d47e
Merge branch 'main' into imkc--fix-docstrings
rosiezou Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions google/cloud/aiplatform/datasets/_datasources.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,9 @@ def __init__(
Args:
gcs_source (Union[str, Sequence[str]]):
Required. The Google Cloud Storage location for the input content.
Google Cloud Storage URI(-s) to the input file(s). May contain
wildcards. For more information on wildcards, see
https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
examples:
Google Cloud Storage URI(-s) to the input file(s).

Examples:
str: "gs://bucket/file.csv"
Sequence[str]: ["gs://bucket/file1.csv", "gs://bucket/file2.csv"]
import_schema_uri (str):
Expand Down Expand Up @@ -185,10 +184,9 @@ def create_datasource(
`OpenAPI 3.0.2 Schema
gcs_source (Union[str, Sequence[str]]):
The Google Cloud Storage location for the input content.
Google Cloud Storage URI(-s) to the input file(s). May contain
wildcards. For more information on wildcards, see
https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
examples:
Google Cloud Storage URI(-s) to the input file(s).

Examples:
str: "gs://bucket/file.csv"
Sequence[str]: ["gs://bucket/file1.csv", "gs://bucket/file2.csv"]
bq_source (str):
Expand Down
7 changes: 3 additions & 4 deletions google/cloud/aiplatform/datasets/image_dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,9 @@ def create(
of any UTF-8 characters.
gcs_source (Union[str, Sequence[str]]):
Google Cloud Storage URI(-s) to the
input file(s). May contain wildcards. For more
information on wildcards, see
https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
examples:
input file(s).

Examples:
str: "gs://bucket/file.csv"
Sequence[str]: ["gs://bucket/file1.csv", "gs://bucket/file2.csv"]
import_schema_uri (str):
Expand Down
7 changes: 3 additions & 4 deletions google/cloud/aiplatform/datasets/tabular_dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,9 @@ def create(
of any UTF-8 characters.
gcs_source (Union[str, Sequence[str]]):
Google Cloud Storage URI(-s) to the
input file(s). May contain wildcards. For more
information on wildcards, see
https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
examples:
input file(s).

Examples:
str: "gs://bucket/file.csv"
Sequence[str]: ["gs://bucket/file1.csv", "gs://bucket/file2.csv"]
bq_source (str):
Expand Down
7 changes: 3 additions & 4 deletions google/cloud/aiplatform/datasets/text_dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,9 @@ def create(
of any UTF-8 characters.
gcs_source (Union[str, Sequence[str]]):
Google Cloud Storage URI(-s) to the
input file(s). May contain wildcards. For more
information on wildcards, see
https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
examples:
input file(s).

Examples:
str: "gs://bucket/file.csv"
Sequence[str]: ["gs://bucket/file1.csv", "gs://bucket/file2.csv"]
import_schema_uri (str):
Expand Down
7 changes: 3 additions & 4 deletions google/cloud/aiplatform/datasets/time_series_dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,9 @@ def create(
of any UTF-8 characters.
gcs_source (Union[str, Sequence[str]]):
Google Cloud Storage URI(-s) to the
input file(s). May contain wildcards. For more
information on wildcards, see
https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
examples:
input file(s).

Examples:
str: "gs://bucket/file.csv"
Sequence[str]: ["gs://bucket/file1.csv", "gs://bucket/file2.csv"]
bq_source (str):
Expand Down
7 changes: 3 additions & 4 deletions google/cloud/aiplatform/datasets/video_dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,9 @@ def create(
of any UTF-8 characters.
gcs_source (Union[str, Sequence[str]]):
Google Cloud Storage URI(-s) to the
input file(s). May contain wildcards. For more
information on wildcards, see
https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
examples:
input file(s).

Examples:
str: "gs://bucket/file.csv"
Sequence[str]: ["gs://bucket/file1.csv", "gs://bucket/file2.csv"]
import_schema_uri (str):
Expand Down
3 changes: 1 addition & 2 deletions google/cloud/aiplatform/jobs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,8 +407,7 @@ def create(
gcs_source (Optional[Sequence[str]]):
Google Cloud Storage URI(-s) to your instances to run
batch prediction on. They must match `instances_format`.
May contain wildcards. For more information on wildcards, see
https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.

bigquery_source (Optional[str]):
BigQuery URI to a table, up to 2000 characters long. For example:
`bq://projectId.bqDatasetId.bqTableId`
Expand Down
2 changes: 1 addition & 1 deletion google/cloud/aiplatform/matching_engine/matching_engine_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ def update_embeddings(
The expected structure and format of the files this URI points to is
described at
https://docs.google.com/document/d/12DLVB6Nq6rdv8grxfBsPhUA283KWrQ9ZenPBp0zUC30
is_complete_overwrite (str):
is_complete_overwrite (bool):
Optional. If this field is set together with contentsDeltaUri when calling IndexService.UpdateIndex,
then existing content of the Index will be replaced by the data from the contentsDeltaUri.
request_metadata (Sequence[Tuple[str, str]]):
Expand Down
2 changes: 0 additions & 2 deletions google/cloud/aiplatform/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2497,8 +2497,6 @@ def batch_predict(
gcs_source: Optional[Sequence[str]] = None
nayaknishant marked this conversation as resolved.
Show resolved Hide resolved
Google Cloud Storage URI(-s) to your instances to run
batch prediction on. They must match `instances_format`.
May contain wildcards. For more information on wildcards, see
https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
bigquery_source: Optional[str] = None
BigQuery URI to a table, up to 2000 characters long. For example:
`bq://projectId.bqDatasetId.bqTableId`
Expand Down