styledistance / README.md
AjayP13's picture
Update README.md
a3fd10e verified
---
base_model: FacebookAI/roberta-base
datasets:
- SynthSTEL/styledistance_training_triplets
- StyleDistance/synthstel
library_name: sentence-transformers
pipeline_tag: sentence-similarity
tags:
- datadreamer
- datadreamer-0.35.0
- synthetic
- sentence-transformers
- feature-extraction
- sentence-similarity
widget:
- example_title: Example 1
source_sentence: >-
Did you hear about the Wales wing? He'll h8 2 withdraw due 2 injuries from
future competitions.
sentences:
- >-
We're raising funds 2 improve our school's storage facilities and add new
playground equipment!
- >-
Did you hear about the Wales wing? He'll hate to withdraw due to injuries
from future competitions.
- example_title: Example 2
source_sentence: >-
You planned the DesignMeets Decades of Design event; you executed it
perfectly.
sentences:
- We'll find it hard to prove the thief didn't face a real threat!
- >-
You orchestrated the DesignMeets Decades of Design gathering; you actualized
it flawlessly.
- example_title: Example 3
source_sentence: >-
Did the William Barr maintain a commitment to allow Robert Mueller to finish
the inquiry?
sentences:
- >-
Will the artist be compiling a music album, or will there be a different
focus in the future?
- >-
Did William Barr maintain commitment to allow Robert Mueller to finish
inquiry?
license: mit
language:
- en
---
# Model Card
StyleDistance is a **style embedding model** that aims to embed texts with similar writing styles closely and different styles far apart, regardless of content. You may find this model useful for stylistic analysis of text, clustering, authorship identfication and verification tasks, and automatic style transfer evaluation.
## Training Data and Variants of StyleDistance
StyleDistance was contrastively trained on [SynthSTEL](https://huggingface.co/datasets/StyleDistance/synthstel), a synthetically generated dataset of positive and negative examples of 40 style features being used in text. By utilizing this synthetic dataset, StyleDistance is able to achieve stronger content-independence than other style embeddding models currently available. This particular model was trained using a combination of the synthetic dataset and a [real dataset that makes use of authorship datasets from Reddit to train style embeddings](https://aclanthology.org/2022.repl4nlp-1.26/). For a version that is purely trained on synthetic data, see this other version of [StyleDistance](https://huggingface.co/StyleDistance/styledistance_synthetic_only).
## Example Usage
```python3
from sentence_transformers import SentenceTransformer
from sentence_transformers.util import cos_sim
model = SentenceTransformer('StyleDistance/styledistance') # Load model
input = model.encode("Did you hear about the Wales wing? He'll h8 2 withdraw due 2 injuries from future competitions.")
others = model.encode(["We're raising funds 2 improve our school's storage facilities and add new playground equipment!", "Did you hear about the Wales wing? He'll hate to withdraw due to injuries from future competitions."])
print(cos_sim(input, others))
```
---
## Trained with DataDreamer
This model was trained with a synthetic dataset with [DataDreamer 🤖💤](https://datadreamer.dev). The synthetic dataset card and model card can be found [here](datadreamer.json). The training arguments can be found [here](training_args.json).
---
#### Funding Acknowledgements
<small> This research is supported in part by the Office of the Director of National Intelligence (ODNI), Intelligence Advanced Research Projects Activity (IARPA), via the HIATUS Program contract #2022-22072200005. The views and conclusions contained herein are those of the authors and should not be interpreted as necessarily representing the official policies, either expressed or implied, of ODNI, IARPA, or the U.S. Government. The U.S. Government is authorized to reproduce and distribute reprints for governmental purposes notwithstanding any copyright annotation therein. </small>