fibonacciai commited on
Commit
5f1c1ce
·
verified ·
1 Parent(s): 7ffa1da

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +121 -3
README.md CHANGED
@@ -1,3 +1,121 @@
1
- ---
2
- license: mit
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ tags:
4
+ - gemma3n
5
+ - GGUF
6
+ - conversational
7
+ - product-specialized-ai
8
+ - unsloth
9
+ - llama-cpp
10
+ - RealRobot
11
+ datasets:
12
+ - ysn-rfd/RealRobot_Shop_Persian_Dataset_ShareGPT_Format
13
+ language:
14
+ - en
15
+ - fa
16
+ base_model:
17
+ - google/gemma-3n-E4B-it
18
+ new_version: fibonacciai/fibonacci-2-9b
19
+ ---
20
+
21
+ # RealRobot_chatbot_llm (GGUF) - The Blueprint for Specialized Product AI
22
+
23
+ This repository contains the highly optimized GGUF (quantized) version of the `RealRobot_chatbot_llm` model, developed by **fibonacciai**.
24
+
25
+ Our model is built on the efficient **Gemma 3n architecture** and is fine-tuned on a proprietary dataset from the RealRobot product catalog. This model serves as the **proof-of-concept** for our core value proposition: the ability to rapidly create accurate, cost-effective, and deployable specialized language models for any business, based on their own product data.
26
+
27
+ ## 📈 Key Advantages and Value Proposition
28
+
29
+ The `RealRobot_chatbot_llm` demonstrates the unique benefits of our specialization strategy:
30
+
31
+ * **Hyper-Specialization & Accuracy:** The model is trained exclusively on product data, eliminating the noise and inaccuracy of general-purpose models. It provides authoritative, relevant answers directly related to the RealRobot product line.
32
+ * **Scalable Business Model:** The entire process—from dataset creation to GGUF deployment—is a repeatable blueprint. **This exact specialized AI solution can be replicated for any company or platform** that wishes to embed a highly accurate, product-aware chatbot.
33
+ * **Cost & Resource Efficiency:** Leveraging the small and optimized Gemma 3n architecture, combined with GGUF quantization, ensures maximum performance and minimal computational cost. This makes on-premise, real-time deployment economically viable for enterprises of all sizes.
34
+ * **Optimal Deployment:** The GGUF format enables seamless integration into embedded systems, mobile applications, and local servers using industry-standard tools like `llama.cpp`.
35
+
36
+ ## 📝 Model & Architecture Details: Gemma 3n
37
+
38
+ The `RealRobot_chatbot_llm` is built upon the cutting-edge **Gemma 3n** architecture, a powerful, open model family from Google, optimized for size and speed.
39
+
40
+ | Feature | Description |
41
+ | :--- | :--- |
42
+ | **Base Architecture** | Google's Gemma 3n (Optimized for size and speed) |
43
+ | **Efficiency Focus** | Designed for accelerated performance on local devices (CPU/Edge) |
44
+ | **Model Size** | Approx. 4 Billion Parameters (Quantized) |
45
+ | **Fine-tuning Base** | `gemma-3n-e2b-it-bnb-4bit` |
46
+
47
+ ## 📊 Training Data: RealRobot Product Catalog
48
+
49
+ This model's high accuracy is a direct result of being fine-tuned on a single-domain, high-quality dataset:
50
+
51
+ * **Dataset Source:** [`fibonacciai/RealRobot-chatbot-v2`](https://huggingface.co/datasets/fibonacciai/RealRobot-chatbot-v2)
52
+ * **Content Focus:** The dataset is composed of conversational data and information derived directly from the **RealRobot website product documentation and support materials**.
53
+ * **Purpose:** This data ensures the chatbot can accurately and effectively answer customer questions about product features, usage, and troubleshooting specific to the RealRobot offerings.
54
+
55
+ ## ⚙️ How to Use (GGUF)
56
+
57
+ This GGUF model can be run using various clients, with `llama.cpp` being the most common.
58
+
59
+ ### 1. Using `llama.cpp` (Terminal)
60
+
61
+ 1. **Clone and build `llama.cpp`:**
62
+ ```bash
63
+ git clone [https://github.com/ggerganov/llama.cpp](https://github.com/ggerganov/llama.cpp)
64
+ cd llama.cpp
65
+ make
66
+ ```
67
+
68
+ 2. **Run the model:**
69
+ Use the `--hf-repo` flag to automatically download the model file. Replace `[YOUR_GGUF_FILENAME.gguf]` with the actual filename (e.g., `RealRobot_chatbot_llm-Q8_0.gguf`).
70
+
71
+ ```bash
72
+ ./main --hf-repo fibonacciai/RealRobot_chatbot_llm \
73
+ --hf-file [YOUR_GGUF_FILENAME.gguf] \
74
+ -n 256 \
75
+ -p "<start_of_turn>user\nWhat are the main features of the RealRobot X1 model?<end_of_turn>\n<start_of_turn>model\n"
76
+ ```
77
+
78
+ ### 2. Using `llama-cpp-python` (Python)
79
+
80
+ 1. **Install the library:**
81
+ ```bash
82
+ pip install llama-cpp-python
83
+ ```
84
+
85
+ 2. **Run in Python:**
86
+ ```python
87
+ from llama_cpp import Llama
88
+
89
+ GGUF_FILE = "[YOUR_GGUF_FILENAME.gguf]"
90
+ REPO_ID = "fibonacciai/RealRobot_chatbot_llm"
91
+
92
+ llm = Llama.from_pretrained(
93
+ repo_id=REPO_ID,
94
+ filename=GGUF_FILE,
95
+ n_ctx=2048,
96
+ chat_format="gemma", # Use the gemma chat format
97
+ verbose=False
98
+ )
99
+
100
+ messages = [
101
+ {"role": "user", "content": "How do I troubleshoot error code X-404 on the platform?"},
102
+ ]
103
+
104
+ response = llm.create_chat_completion(messages)
105
+ print(response['choices'][0]['message']['content'])
106
+ ```
107
+
108
+ ## ⚠️ Limitations and Bias
109
+
110
+ * **Domain Focus:** The model is highly specialized. It excels in answering questions about RealRobot products but will have limited performance on general knowledge outside this domain.
111
+ * **Output Verification:** The model's output should always be verified by human oversight before being used in critical customer support or business processes.
112
+
113
+ ## 📜 License
114
+
115
+ The model is licensed under the **Apache 2.0** license.
116
+
117
+ ## 📞 Contact for Specialized AI Solutions
118
+
119
+ For specialized inquiries, collaboration, or to develop a custom product AI for your business using this scalable blueprint, please contact:
120
121
+ **[www.RealRobot.ir]**