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: add online serving w/multiple entities notebook #3245

Merged
merged 1 commit into from
Jul 18, 2024

Conversation

mrkumar9001
Copy link
Collaborator

REQUIRED: Add a summary of your PR here, typically including why the change is needed and what was changed. Include any design alternatives for discussion purposes.


add online serving w/multiple entities notebook - introduces StreamingFetchFeatureValues API


REQUIRED: Fill out the below checklists or remove if irrelevant

  1. If you are opening a PR for Official Notebooks under the notebooks/official folder, follow this mandatory checklist:
  • Use the notebook template as a starting point.
  • Follow the style and grammar rules outlined in the above notebook template.
  • Verify the notebook runs successfully in Colab since the automated tests cannot guarantee this even when it passes.
  • Passes all the required automated checks. You can locally test for formatting and linting with these instructions.
  • You have consulted with a tech writer to see if tech writer review is necessary. If so, the notebook has been reviewed by a tech writer, and they have approved it.
  • This notebook has been added to the CODEOWNERS file under the Official Notebooks section, pointing to the author or the author's team.
  • The Jupyter notebook cleans up any artifacts it has created (datasets, ML models, endpoints, etc) so as not to eat up unnecessary resources.

  1. If you are opening a PR for Community Notebooks under the notebooks/community folder:
  • This notebook has been added to the CODEOWNERS file under the Community Notebooks section, pointing to the author or the author's team.
  • Passes all the required formatting and linting checks. You can locally test with these instructions.

  1. If you are opening a PR for Community Content under the community-content folder:
  • Make sure your main Content Directory Name is descriptive, informative, and includes some of the key products and attributes of your content, so that it is differentiable from other content
  • The main content directory has been added to the CODEOWNERS file under the Community Content section, pointing to the author or the author's team.
  • Passes all the required formatting and linting checks. You can locally test with these instructions.

@mrkumar9001 mrkumar9001 requested a review from a team as a code owner July 10, 2024 19:23
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Contributor

@sen-sam sen-sam left a comment

Choose a reason for hiding this comment

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

Added a few nits. Main (global) feedback:

  • Avoid the use of the first person (I/we).
  • Avoid directional text such as "below". Preferred: "following".
  • Having a description before a code sample can help improve usability.

"## Overview\n",
"\n",
"This notebook demonstrates how to fetch multiple entities (and their feature\n",
"values) in real-time. This notebook introduces the *StreamingFetchFeatureValues* (SFFV) API for faster multi-entity lookup.\n",
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if it's okay for us to surface the "SFFV" in the docs. Has its use in public artifacts been approved by Alex/Raiyaan?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

For now Raiyaan has okayed usage. Will follow up with Alex.

},
"source": [
"<div class=\"alert alert-block alert-warning\">\n",
"<b>⚠️ The kernel is going to restart. Wait until it's finished before continuing to the next step. ⚠️</b>\n",
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm unfamiliar with this annotation. How is this rendered?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

image
ptal at review NB link or via files.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is this a standard text or can we shorten it to, say, "Wait for the kernel to restart before continuing to the next step"?

Also, I feel we should render this as a "Caution:" such as what's illustrated here i.e. without the icons: https://developers.google.com/style/notices

However, please feel free to ignore these comments if this is a standard note that's been used elsewhere.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is standard from the template - https://github.com/GoogleCloudPlatform/vertex-ai-samples/blob/main/notebooks/notebook_template.ipynb. @gericdong to comment if this should be changed to caution?

@mrkumar9001 mrkumar9001 force-pushed the sffv-notebook branch 3 times, most recently from 98cb371 to 9b7dcbd Compare July 17, 2024 22:05
Copy link
Contributor

@sen-sam sen-sam left a comment

Choose a reason for hiding this comment

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

Just one nit. LGTM otherwise!

},
"source": [
"<div class=\"alert alert-block alert-warning\">\n",
"<b>⚠️ The kernel is going to restart. Wait until it's finished before continuing to the next step. ⚠️</b>\n",
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this a standard text or can we shorten it to, say, "Wait for the kernel to restart before continuing to the next step"?

Also, I feel we should render this as a "Caution:" such as what's illustrated here i.e. without the icons: https://developers.google.com/style/notices

However, please feel free to ignore these comments if this is a standard note that's been used elsewhere.

@gericdong gericdong added this pull request to the merge queue Jul 18, 2024
Merged via the queue into GoogleCloudPlatform:main with commit d893c78 Jul 18, 2024
6 checks passed
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.

None yet

3 participants