Improve language tag
Browse filesHi! As the model is multilingual, this is a PR to add other languages than English to the language tag to improve the referencing. Note that 29 languages are announced in the README, but only 13 are explicitly listed. I was therefore only able to add these 13 languages.
README.md
CHANGED
|
@@ -1,195 +1,207 @@
|
|
| 1 |
-
---
|
| 2 |
-
language:
|
| 3 |
-
-
|
| 4 |
-
|
| 5 |
-
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
- **
|
| 28 |
-
- **
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
|
| 59 |
-
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
|
| 66 |
-
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
|
| 70 |
-
|
| 71 |
-
|
| 72 |
-
|
| 73 |
-
|
| 74 |
-
|
| 75 |
-
|
| 76 |
-
|
| 77 |
-
|
| 78 |
-
|
| 79 |
-
|
| 80 |
-
|
| 81 |
-
|
| 82 |
-
|
| 83 |
-
|
| 84 |
-
|
| 85 |
-
|
| 86 |
-
|
| 87 |
-
|
| 88 |
-
|
| 89 |
-
|
| 90 |
-
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
|
| 94 |
-
|
| 95 |
-
|
| 96 |
-
|
| 97 |
-
|
| 98 |
-
|
| 99 |
-
|
| 100 |
-
|
| 101 |
-
|
| 102 |
-
|
| 103 |
-
|
| 104 |
-
|
| 105 |
-
|
| 106 |
-
|
| 107 |
-
|
| 108 |
-
|
| 109 |
-
|
| 110 |
-
|
| 111 |
-
|
| 112 |
-
|
| 113 |
-
|
| 114 |
-
|
| 115 |
-
|
| 116 |
-
|
| 117 |
-
|
| 118 |
-
|
| 119 |
-
|
| 120 |
-
|
| 121 |
-
|
| 122 |
-
|
| 123 |
-
|
| 124 |
-
|
| 125 |
-
|
| 126 |
-
|
| 127 |
-
|
| 128 |
-
|
| 129 |
-
|
| 130 |
-
- **
|
| 131 |
-
|
| 132 |
-
|
| 133 |
-
|
| 134 |
-
|
| 135 |
-
|
| 136 |
-
|
| 137 |
-
|
| 138 |
-
|
| 139 |
-
|
| 140 |
-
|
| 141 |
-
|
| 142 |
-
|
| 143 |
-
-
|
| 144 |
-
-
|
| 145 |
-
|
| 146 |
-
|
| 147 |
-
|
| 148 |
-
β
|
| 149 |
-
|
| 150 |
-
|
| 151 |
-
---
|
| 152 |
-
|
| 153 |
-
##
|
| 154 |
-
|
| 155 |
-
- **
|
| 156 |
-
-
|
| 157 |
-
|
| 158 |
-
|
| 159 |
-
|
| 160 |
-
|
| 161 |
-
|
| 162 |
-
|
| 163 |
-
|
| 164 |
-
|
| 165 |
-
|
| 166 |
-
|
| 167 |
-
|
| 168 |
-
|
| 169 |
-
|
| 170 |
-
|
| 171 |
-
|
| 172 |
-
|
| 173 |
-
|
| 174 |
-
|
| 175 |
-
|
| 176 |
-
|
| 177 |
-
|
| 178 |
-
|
| 179 |
-
|
| 180 |
-
|
| 181 |
-
|
| 182 |
-
|
| 183 |
-
|
| 184 |
-
```
|
| 185 |
-
|
| 186 |
-
|
| 187 |
-
|
| 188 |
-
|
| 189 |
-
|
| 190 |
-
|
| 191 |
-
|
| 192 |
-
|
| 193 |
-
|
| 194 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 195 |
```
|
|
|
|
| 1 |
+
---
|
| 2 |
+
language:
|
| 3 |
+
- zho
|
| 4 |
+
- eng
|
| 5 |
+
- fra
|
| 6 |
+
- spa
|
| 7 |
+
- por
|
| 8 |
+
- deu
|
| 9 |
+
- ita
|
| 10 |
+
- rus
|
| 11 |
+
- jpn
|
| 12 |
+
- kor
|
| 13 |
+
- vie
|
| 14 |
+
- tha
|
| 15 |
+
- ara
|
| 16 |
+
base_model:
|
| 17 |
+
- Qwen/Qwen2.5-3B
|
| 18 |
+
new_version: Qwen/Qwen2.5-3B
|
| 19 |
+
library_name: sentence-transformers
|
| 20 |
+
---
|
| 21 |
+
# π₯ Dating & Relationship Advisor GGUF π₯
|
| 22 |
+
|
| 23 |
+
## π Model Summary
|
| 24 |
+
This model is a **casual, informal AI assistant** designed to provide **dating and relationship advice** in a fun, unfiltered, and humorous way. It uses **slang, jokes, emojis, and a conversational tone**, making it feel like you're chatting with a friend rather than a traditional AI.
|
| 25 |
+
|
| 26 |
+
The model has been **fine-tuned** using a combination of:
|
| 27 |
+
- **Crowdsourced dating advice (Reddit FAISS)** π
|
| 28 |
+
- **Expert relationship guides & books (PDF FAISS)** π
|
| 29 |
+
|
| 30 |
+
It supports **two main deployment methods**:
|
| 31 |
+
1. **Google Drive Method** β Loading the model from Google Drive.
|
| 32 |
+
2. **Hugging Face Method** β Downloading & using the model from Hugging Face Hub.
|
| 33 |
+
|
| 34 |
+
---
|
| 35 |
+
|
| 36 |
+
## π Model Details
|
| 37 |
+
- **Model Type:** GGUF-based LLaMA model
|
| 38 |
+
- **Developed by:** [Your Name / Organization]
|
| 39 |
+
- **Language:** English
|
| 40 |
+
- **License:** Apache 2.0 (or your choice)
|
| 41 |
+
- **Base Model:** LLaMA (Meta)
|
| 42 |
+
- **Training Data:** Relationship advice forums, dating guides, and expert PDFs
|
| 43 |
+
- **Inference Framework:** `llama-cpp-python`
|
| 44 |
+
|
| 45 |
+
---
|
| 46 |
+
|
| 47 |
+
## π How to Use the Model
|
| 48 |
+
### **1οΈβ£ Method 1: Load from Google Drive**
|
| 49 |
+
#### **Step 1: Install Dependencies**
|
| 50 |
+
```bash
|
| 51 |
+
pip install llama-cpp-python
|
| 52 |
+
```
|
| 53 |
+
#### **Step 2: Mount Google Drive & Load Model**
|
| 54 |
+
```python
|
| 55 |
+
from llama_cpp import Llama
|
| 56 |
+
import random
|
| 57 |
+
|
| 58 |
+
# Google Drive path
|
| 59 |
+
model_path = "/content/drive/MyDrive/Dating_LLM_GGUF/damn.gguf"
|
| 60 |
+
|
| 61 |
+
# Load the model
|
| 62 |
+
llm = Llama(
|
| 63 |
+
model_path=model_path,
|
| 64 |
+
n_gpu_layers=40,
|
| 65 |
+
n_ctx=2048,
|
| 66 |
+
system_message="You are an unfiltered, informal AI assistant. Use slang, humor, and emojis!"
|
| 67 |
+
)
|
| 68 |
+
|
| 69 |
+
# Function to modify user input
|
| 70 |
+
def make_emotional(user_input):
|
| 71 |
+
salutation = random.choice(["Yo dude! π", "Hey buddy! π", "Listen up, my friend β€οΈ"])
|
| 72 |
+
suffix = " Give me some real, no-BS advice with emojis! ππ₯π"
|
| 73 |
+
return f"{salutation} {user_input} {suffix}"
|
| 74 |
+
|
| 75 |
+
# Run inference
|
| 76 |
+
user_input = "My partner doesn't like my friends. What should I do?"
|
| 77 |
+
emotional_prompt = make_emotional(user_input)
|
| 78 |
+
output = llm(emotional_prompt, max_tokens=200)
|
| 79 |
+
|
| 80 |
+
# Print the output
|
| 81 |
+
print(output["choices"][0]["text"])
|
| 82 |
+
```
|
| 83 |
+
|
| 84 |
+
---
|
| 85 |
+
|
| 86 |
+
### **2οΈβ£ Method 2: Load from Hugging Face**
|
| 87 |
+
#### **Step 1: Install Dependencies**
|
| 88 |
+
```bash
|
| 89 |
+
pip install llama-cpp-python huggingface_hub
|
| 90 |
+
```
|
| 91 |
+
#### **Step 2: Download Model from Hugging Face**
|
| 92 |
+
```python
|
| 93 |
+
from llama_cpp import Llama
|
| 94 |
+
from huggingface_hub import hf_hub_download
|
| 95 |
+
|
| 96 |
+
# Download model from Hugging Face Hub
|
| 97 |
+
model_path = hf_hub_download(
|
| 98 |
+
repo_id="your-username/your-gguf-model",
|
| 99 |
+
filename="your_model.gguf",
|
| 100 |
+
cache_dir="./models"
|
| 101 |
+
)
|
| 102 |
+
|
| 103 |
+
# Load the model
|
| 104 |
+
llm = Llama(
|
| 105 |
+
model_path=model_path,
|
| 106 |
+
n_gpu_layers=40,
|
| 107 |
+
n_ctx=2048,
|
| 108 |
+
system_message="You are an unfiltered, informal AI assistant. Use slang, humor, and emojis!"
|
| 109 |
+
)
|
| 110 |
+
|
| 111 |
+
# Run inference
|
| 112 |
+
user_input = "My girlfriend is always busy and doesn't text me much. What should I do?"
|
| 113 |
+
response = llm(user_input, max_tokens=200)
|
| 114 |
+
print(response["choices"][0]["text"])
|
| 115 |
+
```
|
| 116 |
+
|
| 117 |
+
---
|
| 118 |
+
|
| 119 |
+
## πΎ Training Details
|
| 120 |
+
### **π Training Data**
|
| 121 |
+
This model was trained on a diverse dataset, including:
|
| 122 |
+
β
**Reddit FAISS** β Extracts **real-world** dating discussions from **Reddit posts**.
|
| 123 |
+
β
**PDF FAISS** β Retrieves relationship **expert opinions & guides** from books.
|
| 124 |
+
|
| 125 |
+
The **dual FAISS retrieval system** ensures that the model provides a mix of **crowdsourced wisdom** and **expert advice**.
|
| 126 |
+
|
| 127 |
+
### **βοΈ Training Process**
|
| 128 |
+
- **Preprocessing:** Cleaned, tokenized, and formatted text.
|
| 129 |
+
- **Fine-Tuning:** Used **FP16 mixed precision** for efficiency.
|
| 130 |
+
- **Model Architecture:** GGUF version of LLaMA.
|
| 131 |
+
|
| 132 |
+
---
|
| 133 |
+
|
| 134 |
+
## π Evaluation & Performance
|
| 135 |
+
### **ποΈ Testing Data**
|
| 136 |
+
The model was tested on **real-life dating scenarios**, such as:
|
| 137 |
+
- **"My partner doesnβt want to move in together. What should I do?"**
|
| 138 |
+
- **"Is it normal to argue every day in a relationship?"**
|
| 139 |
+
- **"My crush left me on read π What now?"**
|
| 140 |
+
|
| 141 |
+
### **π Metrics**
|
| 142 |
+
- **Engagement Score** β Is the response conversational & engaging?
|
| 143 |
+
- **Coherence** β Does the response make sense?
|
| 144 |
+
- **Slang & Humor** β Does it feel natural?
|
| 145 |
+
|
| 146 |
+
### **π Results**
|
| 147 |
+
β
**90% of users found the responses engaging** π
|
| 148 |
+
β
**Feels like texting a real friend!**
|
| 149 |
+
β
**Sometimes overuses emojis ππ₯**
|
| 150 |
+
|
| 151 |
+
---
|
| 152 |
+
|
| 153 |
+
## π‘ Model Limitations & Risks
|
| 154 |
+
### **β οΈ Bias & Limitations**
|
| 155 |
+
- This model **reflects human biases** found in dating advice.
|
| 156 |
+
- It may **overgeneralize** relationships & emotions.
|
| 157 |
+
- **Not suitable for mental health or therapy**.
|
| 158 |
+
|
| 159 |
+
### **π Recommendations**
|
| 160 |
+
β
Use it for **fun, light-hearted guidance**.
|
| 161 |
+
β Don't rely on it for **serious relationship decisions**.
|
| 162 |
+
|
| 163 |
+
---
|
| 164 |
+
|
| 165 |
+
## π Environmental Impact
|
| 166 |
+
- **Hardware:** NVIDIA A100 GPUs
|
| 167 |
+
- **Training Time:** ~24 hours
|
| 168 |
+
- **Carbon Emission Estimate:** **5 kg CO2**
|
| 169 |
+
|
| 170 |
+
---
|
| 171 |
+
|
| 172 |
+
## π License & Citation
|
| 173 |
+
### **π License**
|
| 174 |
+
π Apache 2.0 (or your chosen license).
|
| 175 |
+
|
| 176 |
+
### **π Citation**
|
| 177 |
+
```bibtex
|
| 178 |
+
@misc{yourname2025datingadvisor,
|
| 179 |
+
title={Dating & Relationship Advisor AI},
|
| 180 |
+
author={Your Name},
|
| 181 |
+
year={2025},
|
| 182 |
+
publisher={Hugging Face}
|
| 183 |
+
}
|
| 184 |
+
```
|
| 185 |
+
|
| 186 |
+
---
|
| 187 |
+
|
| 188 |
+
## π’ Uploading to Hugging Face
|
| 189 |
+
### **Step 1οΈβ£: Install Hugging Face CLI**
|
| 190 |
+
```bash
|
| 191 |
+
pip install huggingface_hub
|
| 192 |
+
```
|
| 193 |
+
### **Step 2οΈβ£: Log in**
|
| 194 |
+
```bash
|
| 195 |
+
huggingface-cli login
|
| 196 |
+
```
|
| 197 |
+
|
| 198 |
+
### **Step 3οΈβ£: Create a Model Repo**
|
| 199 |
+
- Go to [Hugging Face Models](https://huggingface.co/models) β Click **"New Model"**
|
| 200 |
+
- **Model ID:** `your-username/your-gguf-model`
|
| 201 |
+
- **License:** Apache 2.0
|
| 202 |
+
- **Tags:** `llama`, `gguf`, `dating`, `relationships`, `llama.cpp`
|
| 203 |
+
|
| 204 |
+
### **Step 4οΈβ£: Upload GGUF Model**
|
| 205 |
+
```bash
|
| 206 |
+
huggingface-cli upload your-username/your-gguf-model your_model.gguf
|
| 207 |
```
|