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.

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

feat(vertexai): Add fields to Vertex AI FeatureStore EntityType for Feature Value Monitoring #6699

Conversation

shotarok
Copy link
Contributor

@shotarok shotarok commented Oct 16, 2022

part of hashicorp/terraform-provider-google#9298

Add fields to Vertex AI FeatureStore EntityType for Feature Value Monitoring. This is the GA API reference: https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.featurestores.entityTypes#FeaturestoreMonitoringConfig.

If this PR is for Terraform, I acknowledge that I have:

  • Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
  • Generated Terraform, and ran make test and make lint to ensure it passes unit and linter tests.
  • Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
  • Ran relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)

vertexai: add fields to `vertex_ai_featurestore_entitytype` to support feature value monitoring

@modular-magician
Copy link
Collaborator

Hello! I am a robot who works on Magic Modules PRs.

I've detected that you're a community contributor. @megan07, a repository maintainer, has been assigned to assist you and help review your changes.

❓ First time contributing? Click here for more details

Your assigned reviewer will help review your code by:

  • Ensuring it's backwards compatible, covers common error cases, etc.
  • Summarizing the change into a user-facing changelog note.
  • Passes tests, either our "VCR" suite, a set of presubmit tests, or with manual test runs.

You can help make sure that review is quick by running local tests and ensuring they're passing in between each push you make to your PR's branch. Also, try to leave a comment with each push you make, as pushes generally don't generate emails.

If your reviewer doesn't get back to you within a week after your most recent change, please feel free to leave a comment on the issue asking them to take a look! In the absence of a dedicated review dashboard most maintainers manage their pending reviews through email, and those will sometimes get lost in their inbox.


@modular-magician
Copy link
Collaborator

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 3 files changed, 384 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 3 files changed, 385 insertions(+), 2 deletions(-))
TF Validator: Diff ( 3 files changed, 126 insertions(+), 3 deletions(-))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2191
Passed tests 1948
Skipped tests: 239
Failed tests: 4

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests
TestAccDataSourceGoogleServiceAccountIdToken_basic|TestAccVertexAIFeaturestoreEntitytype_vertexAiFeaturestoreEntitytypeExample|TestAccVertexAIFeaturestoreEntitytypeFeature_vertexAiFeaturestoreEntitytypeFeatureWithBetaFieldsExample|TestAccVertexAIFeaturestoreEntitytype_vertexAiFeaturestoreEntitytypeWithBetaFieldsExample

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccDataSourceGoogleServiceAccountIdToken_basic[Debug log]
TestAccVertexAIFeaturestoreEntitytype_vertexAiFeaturestoreEntitytypeExample[Debug log]

Tests failed during RECORDING mode:
TestAccVertexAIFeaturestoreEntitytypeFeature_vertexAiFeaturestoreEntitytypeFeatureWithBetaFieldsExample[Error message] [Debug log]
TestAccVertexAIFeaturestoreEntitytype_vertexAiFeaturestoreEntitytypeWithBetaFieldsExample[Error message] [Debug log]

Please fix these to complete your PR
View the build log or the debug log for each test

@shotarok
Copy link
Contributor Author

shotarok commented Oct 16, 2022

[MEMO] Based on the test error logs I reproduced locally, I updated the code to deal with the fixed default values in 7141575.

@modular-magician
Copy link
Collaborator

Hi! I'm the modular magician. Your PR generated some diffs in downstreams - here they are.

Diff report:

Terraform GA: Diff ( 4 files changed, 403 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 5 files changed, 420 insertions(+), 2 deletions(-))
TF Validator: Diff ( 3 files changed, 126 insertions(+), 3 deletions(-))
TF OiCS: Diff ( 1 file changed, 8 insertions(+))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2191
Passed tests 1950
Skipped tests: 239
Failed tests: 2

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests
TestAccVertexAIFeaturestoreEntitytype_vertexAiFeaturestoreEntitytypeWithBetaFieldsExample|TestAccVertexAIFeaturestoreEntitytypeFeature_vertexAiFeaturestoreEntitytypeFeatureWithBetaFieldsExample

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccVertexAIFeaturestoreEntitytype_vertexAiFeaturestoreEntitytypeWithBetaFieldsExample[Debug log]
TestAccVertexAIFeaturestoreEntitytypeFeature_vertexAiFeaturestoreEntitytypeFeatureWithBetaFieldsExample[Debug log]

All tests passed
View the build log or the debug log for each test

@shotarok
Copy link
Contributor Author

@megan07 All tests passed. Could you please review this PR when you have time? Thanks

@shotarok
Copy link
Contributor Author

shotarok commented Oct 24, 2022

Hi @megan07, please let me ping you based on the step 10. 🙏


Hello @slevenick, we discussed the previous PR: #6565 (review). I'd appreciate it if I could get some advice on #6699 (comment). Thanks

@shotarok shotarok changed the title Add fields to Vertex AI FeatureStore EntityType for Feature Value Monitoring feat(vertexai): Add fields to Vertex AI FeatureStore EntityType for Feature Value Monitoring Oct 24, 2022
Copy link
Contributor

@megan07 megan07 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I have a couple of minor comments. Thanks!

mmv1/products/vertexai/api.yaml Outdated Show resolved Hide resolved
mmv1/products/vertexai/api.yaml Outdated Show resolved Hide resolved
name: 'value'
description: |
Specify a threshold value that can trigger the alert. For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence. Each feature must have a non-zero threshold if they need to be monitored. Otherwise no alert will be triggered for that feature. The default value is 0.3.
default_value: 0.3
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we want to make this required rather than having a default, as we don't want numerical_threshold_config to be an empty block. Same with categorical_threshold_config below. What are your thoughts?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I remember correctly, the API returned 0.3 when not specifying the fields. That said, I agree. we don't want them to be empty fields. I'll make them required. Thanks!

mmv1/products/vertexai/terraform.yaml Show resolved Hide resolved
@modular-magician
Copy link
Collaborator

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

Terraform GA: Diff ( 4 files changed, 397 insertions(+), 2 deletions(-))
Terraform Beta: Diff ( 5 files changed, 414 insertions(+), 2 deletions(-))
TF Validator: Diff ( 3 files changed, 126 insertions(+), 3 deletions(-))
TF OiCS: Diff ( 1 file changed, 8 insertions(+))

@modular-magician
Copy link
Collaborator

Tests analytics

Total tests: 2230
Passed tests 1987
Skipped tests: 241
Failed tests: 2

Action taken

Triggering VCR tests in RECORDING mode for the tests that failed during VCR. Click here to see the failed tests
TestAccComputeForwardingRule_update|TestAccBigQueryDataTable_bigtable

@modular-magician
Copy link
Collaborator

Tests passed during RECORDING mode:
TestAccComputeForwardingRule_update[Debug log]
TestAccBigQueryDataTable_bigtable[Debug log]

All tests passed
View the build log or the debug log for each test

@shotarok
Copy link
Contributor Author

shotarok commented Nov 8, 2022

Hi @megan07, I updated the code, and all tests passed. Could you please review this PR again? Thanks!

Copy link
Contributor

@megan07 megan07 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks!

hao-nan-li pushed a commit to hao-nan-li/magic-modules that referenced this pull request Dec 6, 2022
…eature Value Monitoring (GoogleCloudPlatform#6699)

* feat: add fields for feature monitoring

* fix: use default_value for the fixed default values

* fix: update code based on feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants