Lyon28 commited on
Commit
8bf72d7
·
verified ·
1 Parent(s): 7dddf48

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +69 -21
README.md CHANGED
@@ -5,26 +5,6 @@ colorFrom: green
5
  colorTo: green
6
  sdk: docker
7
  pinned: false
8
- ---
9
-
10
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
11
-
12
- ---
13
- # Endpoint Hugging Face yang Tersedia:
14
- **Base URL: https://lyon28-ai-character-chat.hf.space/inference**
15
- ## Models yang Supported: ##
16
- -*Lyon28/Tinny-Llama*
17
- -*Lyon28/Pythia*
18
- -*Lyon28/Bert-Tinny*
19
- -*Lyon28/Albert-Base-V2*
20
- -*Lyon28/T5-Small*
21
- -*Lyon28/GPT-2*
22
- -*Lyon28/GPT-Neo*
23
- -*Lyon28/Distilbert-Base-Uncased*
24
- -*Lyon28/Distil_GPT-2*
25
- -*Lyon28/GPT-2-Tinny*
26
- -*Lyon28/Electra-Small*
27
-
28
  ---
29
  # Character AI Chat - CPU Optimized Backend
30
 
@@ -71,12 +51,54 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
71
  - **Pythia** - Research-grade model
72
  - **GPT-Neo** - Open-source GPT alternative
73
 
 
 
 
 
 
 
 
 
 
 
 
74
  ### Hardware Requirements
75
  - **CPU**: Multi-core processor (minimum 4 cores recommended)
76
  - **RAM**: 8GB minimum, 16GB recommended
77
  - **Storage**: 10GB free space untuk model cache
78
  - **Platform**: Windows, macOS, Linux
79
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
80
  Aplikasi akan berjalan di: `http://localhost:7860`
81
 
82
  ## 🎮 Cara Penggunaan
@@ -235,6 +257,32 @@ model = "distil-gpt-2" # instead of "gpt-neo"
235
  recommended_models = ["distil-gpt-2", "gpt-2-tinny", "bert-tinny"]
236
  ```
237
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
238
  ### Adding New Features
239
  1. Extend appropriate class (`ConversationMemory`, `CharacterPersonality`, etc.)
240
  2. Add endpoint if needed
@@ -255,7 +303,7 @@ MIT License - Lihat file LICENSE untuk detail lengkap.
255
 
256
  - **Issues**: GitHub Issues
257
  - **Discussions**: GitHub Discussions
258
- - **Email**: [epoystromp.2805@gmail.com]
259
 
260
  ---
261
 
 
5
  colorTo: green
6
  sdk: docker
7
  pinned: false
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  ---
9
  # Character AI Chat - CPU Optimized Backend
10
 
 
51
  - **Pythia** - Research-grade model
52
  - **GPT-Neo** - Open-source GPT alternative
53
 
54
+ ## 📋 Persyaratan Sistem
55
+
56
+ ### Software Requirements
57
+ ```
58
+ Python 3.8+
59
+ FastAPI
60
+ Transformers
61
+ PyTorch (CPU version)
62
+ Uvicorn
63
+ ```
64
+
65
  ### Hardware Requirements
66
  - **CPU**: Multi-core processor (minimum 4 cores recommended)
67
  - **RAM**: 8GB minimum, 16GB recommended
68
  - **Storage**: 10GB free space untuk model cache
69
  - **Platform**: Windows, macOS, Linux
70
 
71
+ ## 🛠️ Instalasi
72
+
73
+ ### 1. Clone Repository
74
+ ```bash
75
+ git clone <repository-url>
76
+ cd character-ai-chat
77
+ ```
78
+
79
+ ### 2. Install Dependencies
80
+ ```bash
81
+ pip install -r requirements.txt
82
+ ```
83
+
84
+ ### 3. Setup Environment
85
+ ```bash
86
+ # Optional: Set cache directory
87
+ export HF_HOME=/path/to/cache
88
+ export TRANSFORMERS_CACHE=/path/to/cache
89
+ ```
90
+
91
+ ### 4. Prepare Assets
92
+ Pastikan file berikut ada di root directory:
93
+ - `index.html` - Frontend interface
94
+ - `avatar.png` - Character avatar (optional)
95
+ - `background.png` - Background image (optional)
96
+
97
+ ### 5. Run Application
98
+ ```bash
99
+ python app.py
100
+ ```
101
+
102
  Aplikasi akan berjalan di: `http://localhost:7860`
103
 
104
  ## 🎮 Cara Penggunaan
 
257
  recommended_models = ["distil-gpt-2", "gpt-2-tinny", "bert-tinny"]
258
  ```
259
 
260
+ ### Debug Mode
261
+ ```bash
262
+ # Run with debug logging
263
+ PYTHONPATH=. python -m uvicorn app:app --reload --log-level debug
264
+ ```
265
+
266
+ ## 🤝 Contributing
267
+
268
+ ### Development Setup
269
+ ```bash
270
+ # Install development dependencies
271
+ pip install -r requirements-dev.txt
272
+
273
+ # Run tests
274
+ python -m pytest tests/
275
+
276
+ # Code formatting
277
+ black app.py
278
+ flake8 app.py
279
+ ```
280
+
281
+ ### Adding New Models
282
+ 1. Tambahkan model config di `MODELS` dictionary
283
+ 2. Test dengan `/verify-models` endpoint
284
+ 3. Update documentation
285
+
286
  ### Adding New Features
287
  1. Extend appropriate class (`ConversationMemory`, `CharacterPersonality`, etc.)
288
  2. Add endpoint if needed
 
303
 
304
  - **Issues**: GitHub Issues
305
  - **Discussions**: GitHub Discussions
306
+ - **Email**: [your-email@domain.com]
307
 
308
  ---
309