
# Mini LM Sentis Similarity validated for Unity Sentis

This is the [Mini LM v6 model](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2) in the Sentis format to run on Unity 2023. It is a sentence similarity model that compares different sentences and gives a score depending on how similar they are.

## How to Use

* Create a new scene in Unity 2023
* Add the MiniLMv6.cs file to the Main Camera
* Add vocab.txt and MiniLMv6.sentis to the Assets/StreamingAssets folder
* Change the string1 and string2 variables to the desired strings
* Press play, the results will show in the Console

## Project Demonstration
Thomas, a member of the Hugging Face team, also a good [tutorial](https://thomassimonini.substack.com/p/create-an-ai-robot-npc-using-hugging) of using this model in a mini-game made.

# Example Inputs
```
string1 = "That is a happy person"

string2 = "That is a happy dog"
```

# Example Outputs
```
Similarity Score: 0.6945773
```

## Unity Sentis
Sentis is the inference engine for Unity. More can be found about it [here](https://unity.com/products/sentis)
{"license": "apache-2.0", "library_name": "unity-sentis", "pipeline_tag": "sentence-similarity"}
unity-sentis onnx sentence-similarity license:apache-2.0 region:us