sentis-MiniLM-v6 / README.md
UnityPaul's picture
Upload README.md
522203e verified
metadata
license: apache-2.0
library_name: unity-sentis
pipeline_tag: sentence-similarity

Mini LM Sentis Similarity validated for Unity Sentis (Version 1.4.0-pre.2*)

*Version 1.3.0 Sentis files are not compatible with Sentis 1.4.0 and need to be recreated/downloaded

This is the Mini LM v6 model 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
  • Install com.unity.sentis from the package manager
  • 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 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