Readme file
Browse files
README.md
CHANGED
|
@@ -1,3 +1,51 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: mit
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
base_model: microsoft/Phi-3.5-mini-instruct
|
| 4 |
+
---
|
| 5 |
+
|
| 6 |
+
# Phi-3.5-mini-instruct Sentis Conversion
|
| 7 |
+
|
| 8 |
+
This repository contains a conversion of Microsoft's Phi-3.5 mini model into Unity's Sentis format. The model has been quantized to uint8 for optimized performance.
|
| 9 |
+
|
| 10 |
+
## Model Information
|
| 11 |
+
|
| 12 |
+
- **Original Model**: [Microsoft Phi-3.5-mini-instruct](https://huggingface.co/microsoft/Phi-3.5-mini-instruct)
|
| 13 |
+
- **Conversion**: Phi-3.5 mini to Unity Sentis format
|
| 14 |
+
- **Quantization**: uint8
|
| 15 |
+
|
| 16 |
+
## Installation
|
| 17 |
+
|
| 18 |
+
To use this model in your Unity project:
|
| 19 |
+
|
| 20 |
+
1. Download the model JSON files and the `.sentis` model from this repository.
|
| 21 |
+
2. Place these files in your Unity project's `StreamingAssets` folder.
|
| 22 |
+
3. Download the Phi3Claude.cs script and put it into your Assets folder.
|
| 23 |
+
|
| 24 |
+
## Requirements
|
| 25 |
+
|
| 26 |
+
- **Unity Sentis Version**: 1.6.0-pre.1
|
| 27 |
+
|
| 28 |
+
To run the LlamaTokenizer in Unity, you need to download and include the `Microsoft.ML.Tokenizers.dll` DLL from [the Microsoft's nuget servers](https://www.nuget.org/packages/Microsoft.ML.Tokenizers) and all its dependencies in your project:
|
| 29 |
+
|
| 30 |
+
- `Google.Protobuf.dll`
|
| 31 |
+
- `Microsoft.Bcl.AsyncInterfaces.dll`
|
| 32 |
+
- `Microsoft.Bcl.HashCode.dll`
|
| 33 |
+
- `Microsoft.ML.Tokenizers.dll`
|
| 34 |
+
- `System.Runtime.CompilerServices.Unsafe.dll`
|
| 35 |
+
- `System.Text.Encodings.Web.dll`
|
| 36 |
+
- `System.Text.Json.dll`
|
| 37 |
+
|
| 38 |
+
## Usage
|
| 39 |
+
|
| 40 |
+
To use the Phi-3.5-mini-instruct model in your Unity project:
|
| 41 |
+
|
| 42 |
+
1. Ensure you have completed the installation steps and added the required DLLs to your project.
|
| 43 |
+
2. In your Unity scene, add the `Phi3Claude` script to the Camera GameObject.
|
| 44 |
+
3. Click the Play button to run your scene.
|
| 45 |
+
4. Check the Console window to inspect the generated text output.
|
| 46 |
+
|
| 47 |
+
The `Phi3Claude` script will run the text generation using the Sentis-converted Phi-3.5-mini-instruct model. You can modify this script to customize the input or adjust the generation as needed.
|
| 48 |
+
|
| 49 |
+
## Acknowledgements
|
| 50 |
+
|
| 51 |
+
This model is a conversion of the Microsoft Phi-3.5 mini model. Please refer to the [original model repository](https://huggingface.co/microsoft/Phi-3.5-mini-instruct) for more information about the base model.
|