Update README.md
Browse files
README.md
CHANGED
|
@@ -20,7 +20,7 @@ pipeline_tag: text-generation
|
|
| 20 |
|
| 21 |
A locally-run emotional intelligence AI model designed to provide empathetic, emotionally-aware responses with natural conversation flow.
|
| 22 |
|
| 23 |
-
##
|
| 24 |
|
| 25 |
- **Emotional Intelligence**: Designed to provide empathetic, understanding responses
|
| 26 |
- **Local Operation**: Runs completely locally without external dependencies
|
|
@@ -29,7 +29,7 @@ A locally-run emotional intelligence AI model designed to provide empathetic, em
|
|
| 29 |
- **Easy Integration**: Simple API for quick integration
|
| 30 |
- **Flexible Configuration**: Customizable generation parameters
|
| 31 |
|
| 32 |
-
##
|
| 33 |
|
| 34 |
### Prerequisites
|
| 35 |
|
|
@@ -60,7 +60,7 @@ To use the actual Llama 3.2 3B model:
|
|
| 60 |
- `microsoft/DialoGPT-small` (faster, smaller)
|
| 61 |
- `HuggingFaceTB/SmolLM3-3B` (3B parameter model)
|
| 62 |
|
| 63 |
-
##
|
| 64 |
|
| 65 |
### Basic Usage
|
| 66 |
|
|
@@ -99,7 +99,7 @@ response = model.chat("How are you feeling today?")
|
|
| 99 |
print(response)
|
| 100 |
```
|
| 101 |
|
| 102 |
-
##
|
| 103 |
|
| 104 |
```python
|
| 105 |
# Example 1: Anxiety Support
|
|
@@ -119,7 +119,7 @@ response = model.generate_response("I'm confused about what I want to do with my
|
|
| 119 |
# Output: "That's a really common and natural feeling, especially when we're at crossroads..."
|
| 120 |
```
|
| 121 |
|
| 122 |
-
##
|
| 123 |
|
| 124 |
### Model Parameters
|
| 125 |
|
|
@@ -138,7 +138,7 @@ response = model.generate_response("I'm confused about what I want to do with my
|
|
| 138 |
- `max_new_tokens`: Maximum new tokens to generate (default: 256)
|
| 139 |
- `repetition_penalty`: Penalty for repetition (default: 1.1)
|
| 140 |
|
| 141 |
-
##
|
| 142 |
|
| 143 |
### Model Specifications
|
| 144 |
|
|
@@ -154,7 +154,7 @@ response = model.generate_response("I'm confused about what I want to do with my
|
|
| 154 |
- **8-bit Quantization**: ~500MB VRAM
|
| 155 |
- **4-bit Quantization**: ~250MB VRAM (recommended)
|
| 156 |
|
| 157 |
-
##
|
| 158 |
|
| 159 |
### Custom Generation Parameters
|
| 160 |
|
|
@@ -207,7 +207,7 @@ The model is fine-tuned on emotional intelligence scenarios:
|
|
| 207 |
- Gratitude and appreciation
|
| 208 |
- Overwhelm and responsibility management
|
| 209 |
|
| 210 |
-
##
|
| 211 |
|
| 212 |
Brello EI 0 is built on advanced language model architecture with the following key components:
|
| 213 |
|
|
@@ -234,15 +234,15 @@ Brello EI 0 is built on advanced language model architecture with the following
|
|
| 234 |
- Emotional validation and understanding
|
| 235 |
- Positive reinforcement and encouragement
|
| 236 |
|
| 237 |
-
##
|
| 238 |
|
| 239 |
This model is part of the Epic Systems AI initiative. For questions or contributions, please contact the development team.
|
| 240 |
|
| 241 |
-
##
|
| 242 |
|
| 243 |
This project is licensed under the MIT License - see the LICENSE file for details.
|
| 244 |
|
| 245 |
-
##
|
| 246 |
|
| 247 |
- **Epic Systems** for the vision and support
|
| 248 |
- **Rehan Temkar** for engineering and development
|
|
|
|
| 20 |
|
| 21 |
A locally-run emotional intelligence AI model designed to provide empathetic, emotionally-aware responses with natural conversation flow.
|
| 22 |
|
| 23 |
+
## Features
|
| 24 |
|
| 25 |
- **Emotional Intelligence**: Designed to provide empathetic, understanding responses
|
| 26 |
- **Local Operation**: Runs completely locally without external dependencies
|
|
|
|
| 29 |
- **Easy Integration**: Simple API for quick integration
|
| 30 |
- **Flexible Configuration**: Customizable generation parameters
|
| 31 |
|
| 32 |
+
## Installation
|
| 33 |
|
| 34 |
### Prerequisites
|
| 35 |
|
|
|
|
| 60 |
- `microsoft/DialoGPT-small` (faster, smaller)
|
| 61 |
- `HuggingFaceTB/SmolLM3-3B` (3B parameter model)
|
| 62 |
|
| 63 |
+
## Quick Start
|
| 64 |
|
| 65 |
### Basic Usage
|
| 66 |
|
|
|
|
| 99 |
print(response)
|
| 100 |
```
|
| 101 |
|
| 102 |
+
## Example Conversations
|
| 103 |
|
| 104 |
```python
|
| 105 |
# Example 1: Anxiety Support
|
|
|
|
| 119 |
# Output: "That's a really common and natural feeling, especially when we're at crossroads..."
|
| 120 |
```
|
| 121 |
|
| 122 |
+
## Configuration
|
| 123 |
|
| 124 |
### Model Parameters
|
| 125 |
|
|
|
|
| 138 |
- `max_new_tokens`: Maximum new tokens to generate (default: 256)
|
| 139 |
- `repetition_penalty`: Penalty for repetition (default: 1.1)
|
| 140 |
|
| 141 |
+
## Performance
|
| 142 |
|
| 143 |
### Model Specifications
|
| 144 |
|
|
|
|
| 154 |
- **8-bit Quantization**: ~500MB VRAM
|
| 155 |
- **4-bit Quantization**: ~250MB VRAM (recommended)
|
| 156 |
|
| 157 |
+
## Advanced Usage
|
| 158 |
|
| 159 |
### Custom Generation Parameters
|
| 160 |
|
|
|
|
| 207 |
- Gratitude and appreciation
|
| 208 |
- Overwhelm and responsibility management
|
| 209 |
|
| 210 |
+
## Architecture
|
| 211 |
|
| 212 |
Brello EI 0 is built on advanced language model architecture with the following key components:
|
| 213 |
|
|
|
|
| 234 |
- Emotional validation and understanding
|
| 235 |
- Positive reinforcement and encouragement
|
| 236 |
|
| 237 |
+
## Contributing
|
| 238 |
|
| 239 |
This model is part of the Epic Systems AI initiative. For questions or contributions, please contact the development team.
|
| 240 |
|
| 241 |
+
## License
|
| 242 |
|
| 243 |
This project is licensed under the MIT License - see the LICENSE file for details.
|
| 244 |
|
| 245 |
+
## Acknowledgments
|
| 246 |
|
| 247 |
- **Epic Systems** for the vision and support
|
| 248 |
- **Rehan Temkar** for engineering and development
|