Skip to content

Commit

Permalink
Embeddings normalization fixes (#14284)
Browse files Browse the repository at this point in the history
* Use cosine distance metric for vec tables

* Only apply normalization to multi modal searches

* Catch possible edge case in stddev calc

* Use sigmoid function for normalization for multi modal searches only

* Ensure we get model state on initial page load

* Only save stats for multi modal searches and only use cosine similarity for image -> image search
  • Loading branch information
hawkeye217 authored Oct 11, 2024
1 parent d4b9b5a commit 8a8a0c7
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 26 deletions.
33 changes: 16 additions & 17 deletions frigate/api/event.py
Original file line number Diff line number Diff line change
Expand Up @@ -473,28 +473,26 @@ def events_search(request: Request, params: EventsSearchQueryParams = Depends())
)

thumb_result = context.search_thumbnail(search_event)
thumb_ids = dict(
zip(
[result[0] for result in thumb_result],
context.thumb_stats.normalize([result[1] for result in thumb_result]),
)
)
thumb_ids = {result[0]: result[1] for result in thumb_result}
search_results = {
event_id: {"distance": distance, "source": "thumbnail"}
for event_id, distance in thumb_ids.items()
}
else:
search_types = search_type.split(",")

# only save stats for multi-modal searches
save_stats = "thumbnail" in search_types and "description" in search_types

if "thumbnail" in search_types:
thumb_result = context.search_thumbnail(query)

thumb_distances = context.thumb_stats.normalize(
[result[1] for result in thumb_result], save_stats
)

thumb_ids = dict(
zip(
[result[0] for result in thumb_result],
context.thumb_stats.normalize(
[result[1] for result in thumb_result]
),
)
zip([result[0] for result in thumb_result], thumb_distances)
)
search_results.update(
{
Expand All @@ -505,12 +503,13 @@ def events_search(request: Request, params: EventsSearchQueryParams = Depends())

if "description" in search_types:
desc_result = context.search_description(query)
desc_ids = dict(
zip(
[result[0] for result in desc_result],
context.desc_stats.normalize([result[1] for result in desc_result]),
)

desc_distances = context.desc_stats.normalize(
[result[1] for result in desc_result], save_stats
)

desc_ids = dict(zip([result[0] for result in desc_result], desc_distances))

for event_id, distance in desc_ids.items():
if (
event_id not in search_results
Expand Down
4 changes: 2 additions & 2 deletions frigate/db/sqlitevecq.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ def create_embeddings_tables(self) -> None:
self.execute_sql("""
CREATE VIRTUAL TABLE IF NOT EXISTS vec_thumbnails USING vec0(
id TEXT PRIMARY KEY,
thumbnail_embedding FLOAT[768]
thumbnail_embedding FLOAT[768] distance_metric=cosine
);
""")
self.execute_sql("""
CREATE VIRTUAL TABLE IF NOT EXISTS vec_descriptions USING vec0(
id TEXT PRIMARY KEY,
description_embedding FLOAT[768]
description_embedding FLOAT[768] distance_metric=cosine
);
""")
7 changes: 4 additions & 3 deletions frigate/embeddings/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,11 @@ def variance(self):

@property
def stddev(self):
return math.sqrt(self.variance)
return math.sqrt(self.variance) if self.variance > 0 else 0.0

def normalize(self, distances: list[float]):
self._update(distances)
def normalize(self, distances: list[float], save_stats: bool):
if save_stats:
self._update(distances)
if self.stddev == 0:
return distances
return [
Expand Down
9 changes: 9 additions & 0 deletions web/src/pages/Explore.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import {
useEmbeddingsReindexProgress,
useEventUpdate,
useModelState,
useWs,
} from "@/api/ws";
import ActivityIndicator from "@/components/indicators/activity-indicator";
import AnimatedCircularProgressBar from "@/components/ui/circular-progress-bar";
Expand Down Expand Up @@ -202,6 +203,14 @@ export default function Explore() {

// model states

const { send: sendCommand } = useWs("model_state", "modelState");

useEffect(() => {
sendCommand("modelState");
// only run on mount
// eslint-disable-next-line react-hooks/exhaustive-deps
}, []);

const { payload: textModelState } = useModelState(
"jinaai/jina-clip-v1-text_model_fp16.onnx",
);
Expand Down
14 changes: 10 additions & 4 deletions web/src/views/search/SearchView.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -187,13 +187,19 @@ export default function SearchView({
}
}, [searchResults, searchDetail]);

// confidence score - probably needs tweaking
// confidence score

const zScoreToConfidence = (score: number) => {
// Sigmoid function: 1 / (1 + e^x)
const confidence = 1 / (1 + Math.exp(score));
// Normalizing is not needed for similarity searches
// Sigmoid function for normalized: 1 / (1 + e^x)
// Cosine for similarity
if (searchFilter) {
const notNormalized = searchFilter?.search_type?.includes("similarity");

return Math.round(confidence * 100);
const confidence = notNormalized ? 1 - score : 1 / (1 + Math.exp(score));

return Math.round(confidence * 100);
}
};

const hasExistingSearch = useMemo(
Expand Down

0 comments on commit 8a8a0c7

Please sign in to comment.