Navpy commited on
Commit
f540239
·
verified ·
1 Parent(s): b04e14f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +85 -6
README.md CHANGED
@@ -3,16 +3,95 @@ tags:
3
  - gguf
4
  - llama.cpp
5
  - unsloth
6
-
 
 
 
 
 
 
7
  ---
 
 
 
 
 
 
 
 
 
8
 
9
  # phi-3.5-AI-Vtuber-json : GGUF
10
 
11
- This model was finetuned and converted to GGUF format using [Unsloth](https://github.com/unslothai/unsloth).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
13
- **Example usage**:
14
- - For text only LLMs: `llama-cli -hf Navpy/phi-3.5-AI-Vtuber-json --jinja`
15
- - For multimodal models: `llama-mtmd-cli -hf Navpy/phi-3.5-AI-Vtuber-json --jinja`
16
 
17
  ## Available Model files:
18
  - `phi-3.5-mini-instruct.Q4_K_M.gguf`
@@ -20,4 +99,4 @@ This model was finetuned and converted to GGUF format using [Unsloth](https://gi
20
  ## Ollama
21
  An Ollama Modelfile is included for easy deployment.
22
  This was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth)
23
- [<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
 
3
  - gguf
4
  - llama.cpp
5
  - unsloth
6
+ - text-generation-inference
7
+ license: mit
8
+ language:
9
+ - en
10
+ base_model:
11
+ - microsoft/Phi-3.5-mini-instruct
12
+ pipeline_tag: text-generation
13
  ---
14
+ # Version 2.0: The "Native JSON" Update
15
+ The model has been completely re-trained from the ground up to be more stable, expressive, and structurally sound.
16
+ ## What's New in V2?
17
+ While V1 was successfully fine-tuned to repond in JSON format, it required a System Prompt to guide the model for that behavior. V2 has been deeply trained (455 steps, 0.39 loss) to make JSON and the personality its native language. It now understands the JSON structure at a foundational level, making it more 'alive,' talkative, and responsive even with minimal prompting.
18
+ If you are downloading the new version, you can still use your old Modelfile! However, you will notice that responses feels much more talkative and emotional because the model is deeply fine-tuned.
19
+
20
+ - For Ollama users A Modelfile is added for you to get the best results out of the model(RECOMMENDED).
21
+ ### Disclaimer
22
+ - Modelfile is only for guiding the LLM to always respond in structured way without rambling or generating tokens endlessly, the structure of response and personality is all came from true fine-tuning.
23
 
24
  # phi-3.5-AI-Vtuber-json : GGUF
25
 
26
+ This is a fine-tuned large language model based on Phi-3.5 Mini-Instruct, optimized for AI companion applications that require strict, machine-readable JSON output.
27
+
28
+ This was trained to always return responses in a consistent JSON format with response and emotion fields. This makes it easy to integrate with software that parses and uses AI outputs programmatically.
29
+
30
+ 🔗 Project Nova, where i have used this model: https://github.com/Navjot-Singh7/Project-Nova
31
+ ___
32
+ ## Model Overview
33
+ * **Base Model: Phi-3.5 Mini-Instruct**
34
+ * **Fine-Tuned For: AI companion behavior with structured JSON output**
35
+ Output Format:
36
+ ```bash
37
+ {
38
+ "response": "...",
39
+ "emotion": "..."
40
+ }
41
+ ```
42
+ Primary Use Case: AI companion systems and applications where responses must be machine-readable.
43
+ ___
44
+ ## Capabilities
45
+
46
+ - This model has been fine-tuned to:
47
+
48
+ - Generate companion-style text that is appropriate, engaging, and in JSON format.
49
+
50
+ - Always include both:
51
+
52
+ - response: the AI’s text output
53
+
54
+ - emotion: a tag describing the emotional tone of the response
55
+
56
+ Produce outputs that are consistent and reliable for code integration.
57
+ ___
58
+ ## Intended Use
59
+ #### Primary Use Cases
60
+ - AI companion applications
61
+ - Virtual characters or avatars
62
+ - VTuber or assistant personalities
63
+ -Applications that require structured LLM output
64
+ - Emotion-aware conversational systems
65
+ ___
66
+
67
+ ## Training Details
68
+
69
+ **Custom Dataset -**
70
+ I created my own labeled dataset with 10–20 original samples with JSON-style examples.
71
+
72
+ **Synthetic Data Generation -**
73
+ Then I expanded this initial dataset using another language model to create a synthetic training corpus of ~1,800 samples.
74
+
75
+ **Fine-Tuning Environment -**
76
+ Training was performed using Google Colab.
77
+
78
+ **Dataset Composition -**
79
+ The dataset contains structured examples that guide the model to generate JSON output with response and emotion.
80
+ ___
81
+ ## Usage Example
82
+ Below is an example of how the model might respond in your application:
83
+ ```bash
84
+ {
85
+ "response": "Hello! I'm fine thank you... uhm.. did you have a good day?",
86
+ "emotion": "happy"
87
+ }
88
+ ```
89
+ This makes it easy to parse and handle both the semantic content (response) and the emotional context (emotion) in code.
90
+ ___
91
+ ## License
92
 
93
+ This model is licensed under the MIT License.
94
+ You are free to use, modify, and distribute this model for personal or educational purposes.
 
95
 
96
  ## Available Model files:
97
  - `phi-3.5-mini-instruct.Q4_K_M.gguf`
 
99
  ## Ollama
100
  An Ollama Modelfile is included for easy deployment.
101
  This was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth)
102
+ [<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)