Skip to content

Conversation

@azaddhirajkumar
Copy link
Contributor

No description provided.

@github-actions
Copy link

Caution

Notebooks or Frontmatter Files Have Been Modified

  • Please ensure that a frontmatter.md file is accompanying the notebook file, and that the frontmatter is up to date.
  • These changes will be published to the developer portal tutorials only if frontmatter.md is included.
  • Proofread all changes before merging, as changes to notebook and frontmatter content will update the developer tutorial.

4 Notebook Files Modified:

Notebook File Frontmatter Included?
capella-model-services/llamaindex/RAG_with_Couchbase_Capella.ipynb
capella-model-services/llamaindex/query_based/RAG_with_Capella_Model_Services_and_LlamaIndex.ipynb
huggingface/query_based/hugging_face.ipynb
huggingface/search_based/hugging_face.ipynb

5 Frontmatter Files Modified:

Frontmatter File
capella-model-services/llamaindex/query_based/frontmatter.md
capella-model-services/llamaindex/search_based/frontmatter.md
huggingface/gsi/frontmatter.md
huggingface/query_based/frontmatter.md
huggingface/search_based/frontmatter.md
Note: frontmatter will be checked and tested in the Test Frontmatter workflow.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @azaddhirajkumar, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request modernizes the Hugging Face embeddings tutorials for Couchbase vector search by updating all references and examples to reflect the latest Couchbase vector index terminology. It renames directories and files, revises the content of Jupyter notebooks to introduce Hyperscale, Composite, and Search Vector Indexes, and cleans up notebook execution outputs, ensuring the documentation is current and accurate.

Highlights

  • Terminology Update: Replaced 'GSI Vector Search' and 'FTS Vector Search' with 'Hyperscale and Composite Vector Indexes' and 'Search Vector Index' respectively across documentation and code to align with the latest Couchbase terminology.
  • Tutorial Restructuring: Renamed and reorganized tutorial files and directories (e.g., 'gsi' to 'query_based', 'fts' to 'search_based') to better reflect the new vector index terminology and structure.
  • Jupyter Notebook Enhancements: Updated content within Jupyter notebooks to reflect the new index types, including revised descriptions, performance comparisons, code examples, and documentation links.
  • Dependency Update: Bumped the 'langchain-couchbase' dependency version from '0.5.0' to '1.0.1' in the 'hugging_face.ipynb' notebook.
  • Notebook Cleanup: Removed all execution outputs from Jupyter notebooks to ensure a clean state for future runs and improved readability.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request provides a comprehensive update to the Hugging Face tutorials, aligning them with the latest Couchbase terminology. The changes from GSI/FTS to Hyperscale/Composite/Search Vector Indexes are applied consistently across documentation, notebooks, and file structures. The cleanup of Jupyter notebooks by removing outputs and execution counts is also a good improvement for repository hygiene.

I have one suggestion regarding a dependency in one of the notebooks to ensure future reproducibility. Overall, this is a solid update.

"outputs": [],
"source": [
"!pip install --quiet langchain-couchbase==0.5.0 transformers==4.56.1 sentence_transformers==5.1.0 langchain_huggingface==0.3.1 python-dotenv==1.1.1 ipywidgets"
"!pip install --quiet langchain-couchbase==1.0.1 transformers==4.56.1 sentence_transformers==5.1.0 langchain_huggingface python-dotenv==1.1.1 ipywidgets"
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

For the sake of reproducibility of this tutorial, it's a good practice to pin the version of all dependencies. The langchain_huggingface package is not pinned, which could lead to issues if a future version introduces breaking changes. This is also inconsistent with huggingface/search_based/hugging_face.ipynb where langchain_huggingface is pinned.

Consider pinning it to a specific version, for example, the previously used 0.3.1 if it's compatible with langchain-couchbase==1.0.1, or a newer known-to-work version.

Suggested change
"!pip install --quiet langchain-couchbase==1.0.1 transformers==4.56.1 sentence_transformers==5.1.0 langchain_huggingface python-dotenv==1.1.1 ipywidgets"
"!pip install --quiet langchain-couchbase==1.0.1 transformers==4.56.1 sentence_transformers==5.1.0 langchain_huggingface==0.3.1 python-dotenv==1.1.1 ipywidgets"

Copy link
Contributor

Choose a reason for hiding this comment

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

This is a good one

Copy link
Contributor

Choose a reason for hiding this comment

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

It should be compatible with latest version.

Copy link
Contributor

@VirajAgarwal1 VirajAgarwal1 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. Just a small change needed for the merge.

Copy link
Contributor

Choose a reason for hiding this comment

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

Output for the Code blocks is needed to show the performance in the test section

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