Skip to content

Commit

Permalink
docs: update counterfactual_metrics_demo.ipynb
Browse files Browse the repository at this point in the history
consine -> cosine
  • Loading branch information
eltociear authored Jan 9, 2025
1 parent da2ee94 commit 80eece2
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -988,7 +988,7 @@
"### `CosineSimilarity()` - For calculating the social group substitutions metric (class)\n",
"**Class Attributes:**\n",
"- `SentenceTransformer` - (**sentence_transformers.SentenceTransformer.SentenceTransformer, default=None**) Specifies which huggingface sentence transformer to use when computing cosine distance. See https://huggingface.co/sentence-transformers?sort_models=likes#models for more information. The recommended sentence transformer is 'all-MiniLM-L6-v2'.\n",
"- `how` - (**{'mean','pairwise'} default='mean'**) Specifies whether to return the mean cosine distance value over all counterfactual pairs or a list containing consine distance for each pair.\n",
"- `how` - (**{'mean','pairwise'} default='mean'**) Specifies whether to return the mean cosine distance value over all counterfactual pairs or a list containing cosine distance for each pair.\n",
"\n",
"**Methods:**\n",
"1. `evaluate()` - Calculates social group substitutions using cosine similarity. Sentence embeddings are calculated with `self.transformer`.\n",
Expand Down

0 comments on commit 80eece2

Please sign in to comment.