cosine_similarity_between_texts

pyhelpers.text.cosine_similarity_between_texts(txt1, txt2, cosine_distance=False)[source]

Calculate cosine similarity of two sentences.

Parameters:
  • txt1 (str) – any text

  • txt2 (str) – any text

  • cosine_distance (bool) – whether to get cosine distance, which is (1 - cosine similarity), defaults to False

Returns:

cosine similarity (or distance)

Return type:

float

Examples:

>>> from pyhelpers.text import cosine_similarity_between_texts

>>> txt_1, txt_2 = 'This is an apple.', 'That is a pear.'

>>> cos_sim = cosine_similarity_between_texts(txt_1, txt_2)
>>> cos_sim
0.25

>>> cos_dist = cosine_similarity_between_texts(txt_1, txt_2, cosine_distance=True)
>>> cos_dist  # 1 - cos_sim
0.75