Skip to content

Add code snippet for embeddings normalization #13507

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
37 changes: 37 additions & 0 deletions generative_ai/embeddings/normalize_embeddings.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import numpy as np


def normalize_embedding(embedding_np: np.ndarray) -> np.ndarray:
"""
Normalizes an embedding array to have a magnitude (L2 norm) of 1.

Args:
embedding_np: The input NumPy array to be normalized.

Returns:
The normalized NumPy array with a magnitude of 1.
Returns the original vector if its magnitude is 0.
"""
# Calculate the L2 norm (magnitude) of the vector
norm = np.linalg.norm(embedding_np)

# Avoid division by zero if the vector is all zeros
if norm == 0:
return embedding_np

# Divide the vector by its norm to normalize it
return embedding_np / norm