PB Unity commited on
Commit
55b34d4
1 Parent(s): 1880905

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +38 -0
README.md CHANGED
@@ -1,3 +1,41 @@
1
  ---
2
  license: mit
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: mit
3
+ library_name: unity-sentis
4
+ pipeline_tag: text-generation
5
  ---
6
+
7
+ # Tiny Stories Model in Unity Sentis Format
8
+ This is the [Microsoft Phi 1.5](https://huggingface.co/microsoft/phi-1_5) checked to run on Unity 2023. Phi 1.5 is a Large Language Model that was trained on synthesized data.
9
+
10
+
11
+ ## How to Use
12
+ * Create a new scene in Unity 2023
13
+ * Install `com.unity.sentis` and `com.unity.nuget.newtonsoft-json` packages
14
+ * Add the RunPhi15.cs file to the Main Camera
15
+ * Put `phi15.sentis`, `vocab.json` and `merges.txt` in the Assets/StreamingAssets folder
16
+ * Adjust some of the variables such as the `outputText` string to set the prompt
17
+ * Press run
18
+ * The output will appear in the console window
19
+
20
+ ## Example Input
21
+ ```
22
+ One day an alien came down from Mars. It saw a chicken
23
+ ```
24
+ ## Example Output
25
+ ```
26
+ One day an alien came down from Mars. It saw a chicken and said, "Hello, little chicken. What are you doing here?"
27
+
28
+ The chicken replied, "I'm looking for a place to stay. I'm very tired."
29
+
30
+ The alien said, "You can stay here. I have a nice place for you. It's very comfortable."
31
+
32
+ The chicken was so happy. She thanked the alien and said, "Thank you. I'm very comfortable here."
33
+
34
+ The alien smiled and said, "You're welcome
35
+ ```
36
+
37
+ ## Unity Sentis
38
+ Unity Sentis is the inference engine which runs on Unity 2023. More can be found about it [here](https://unity.com/products/sentis)
39
+
40
+ ## Disclaimer
41
+ The model was trained on children's stories so very unlikely to produce undesirable text. As an extra precaution, we removed a few tokens from vocab.json that might not be suitable for younger audiences. The original json can be found on the Tiny Stories original page.