maitrang04 commited on
Commit
8928fb7
·
verified ·
1 Parent(s): bfdd10a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +114 -137
README.md CHANGED
@@ -1,137 +1,114 @@
1
- # PINE-AI MVP - Hướng dẫn chạy
2
-
3
- ## 1. Mục đích
4
-
5
- PINE-AI là một hệ thống AI hỗ trợ logic sales, có khả năng xử lý dữ liệu khách hàng và gói cước, đồng thời demo bằng giao diện web.
6
-
7
- Hướng dẫn này giúp Ban giám khảo **chạy MVP PINE-AI trên Windows** bằng Docker mà không cần cài Python hay cấu hình môi trường phức tạp.
8
-
9
- ---
10
-
11
- ## 2. Yêu cầu
12
-
13
- - Windows 10/11 với **PowerShell**
14
- - **Docker Desktop** đã cài và đang chạy (bao gồm Docker Compose)
15
- - Kết nối Internet để Docker pull image build container
16
-
17
- ---
18
-
19
- ## 3. Cấu trúc thư mục
20
-
21
- PINE-AI-main/
22
- ├─ backend/
23
- └─ ai/
24
- ├─ data/ # chứa CSV & JSON mẫu
25
- ├─ requirements.txt # các package Python
26
- └─ ... # code backend
27
- ├─ frontend/ # code frontend
28
- docker/
29
- │ ├─ Dockerfile
30
- │ ├─ docker-compose.yml
31
- ├─ start.ps1 # script PowerShell chạy MVP
32
- │ └─ .env # biến môi trường
33
- └─ README.md
34
-
35
- yaml
36
- Copy code
37
-
38
- ---
39
-
40
- ## 4. Setup môi trường
41
-
42
- ### 4.1 Tạo file `.env`
43
-
44
- Trong thư mục `docker`, tạo file `.env` với nội dung:
45
-
46
- ```dotenv
47
- # Google API key
48
- GOOGLE_API_KEY=your_api_key_here
49
-
50
- # In real-time logs
51
- PYTHONUNBUFFERED=1
52
-
53
- 4.2 Cài Docker Compose & Docker Desktop
54
- Docker Desktop mới đã bao gồm Docker Compose v2, nên không cần cài thêm.
55
-
56
- Đảm bảo Docker Desktop đang chạy trước khi build container.
57
-
58
- 5. Cách chạy MVP
59
- 5.1 Chạy bằng script PowerShell (recommended)
60
- Mở PowerShell, vào thư mục docker:
61
-
62
- powershell
63
- Copy code
64
- cd C:\Users\Admin\Downloads\PINE-AI-main\docker
65
- Nếu PowerShell báo Execution Policy:
66
-
67
- powershell
68
- Copy code
69
- Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
70
- Chạy script:
71
-
72
- powershell
73
- Copy code
74
- .\start.ps1
75
- Script sẽ:
76
-
77
- Build image Docker
78
-
79
- Start container
80
-
81
- Chờ server startup
82
-
83
- Mở trình duyệt tới http://localhost:8000
84
-
85
- 5.2 Chạy trực tiếp bằng Docker Compose (nếu muốn xem log chi tiết)
86
- powershell
87
- Copy code
88
- docker-compose up --build
89
- Output sẽ hiện toàn bộ quá trình build và start container.
90
-
91
- Nếu cần dừng container:
92
-
93
- powershell
94
- Copy code
95
- docker-compose down
96
- 6. Kiểm tra container
97
- Xem container đang chạy:
98
-
99
- powershell
100
- Copy code
101
- docker ps
102
- Xem log realtime:
103
-
104
- powershell
105
- Copy code
106
- docker logs -f pine-ai
107
- 7. Truy cập web app
108
- Mở trình duyệt và vào:
109
-
110
- arduino
111
- Copy code
112
- http://localhost:8000
113
- Giao diện web app sẽ hiển thị các chức năng của MVP.
114
-
115
- Hệ thống đã load CSV và JSON mẫu, sẵn sàng demo.
116
-
117
- 8. Notes
118
- Nếu gặp lỗi thiếu package, đảm bảo backend/ai/requirements.txt có đầy đủ:
119
-
120
- text
121
- Copy code
122
- fastapi>=0.95.0
123
- uvicorn[standard]>=0.22.0
124
- python-multipart>=0.0.6
125
- python-dotenv>=1.0.0
126
- google-genai>=0.0.1
127
- websockets>=11.0
128
- requests>=2.31.0
129
- aiofiles>=23.1.0
130
- httpx>=0.24.0
131
- pandas>=2.0.0
132
- .env phải nằm trong thư mục docker, không nằm ngoài.
133
-
134
- 9. Liên hệ
135
- Mọi vấn đề liên quan tới chạy MVP có thể trao đổi trực tiếp với nhóm phát triển.
136
-
137
- Chúc Ban giám khảo trải nghiệm MVP PINE-AI thành công!
 
1
+ PINE-AI MVP Hugging Face Space (Docker)
2
+ 1. Giới thiệu
3
+
4
+ PINE-AI là hệ thống AI hỗ trợ logic sales, xử lý dữ liệu khách hàng & gói cước, demo thông qua giao diện web.
5
+
6
+ Repository này được cấu hình để chạy trực tiếp trên Hugging Face Spaces (Docker)
7
+ 👉 Ban giám khảo không cần cài Python, không cần Docker, chỉ cần mở link Space.
8
+
9
+ 2. Công nghệ sử dụng
10
+
11
+ Backend: Python, FastAPI
12
+
13
+ Frontend: Web UI (serve trực tiếp từ backend)
14
+
15
+ AI / LLM: Google GenAI + VNPT AI (qua API key)
16
+
17
+ Deployment: Hugging Face Spaces – Docker runtime
18
+
19
+ 3. Cấu trúc thư mục
20
+ .
21
+ ├── Dockerfile # Dockerfile cho Hugging Face (bắt buộc ở ROOT)
22
+ ├─ backend/
23
+ └─ ai/
24
+ ├─ data/ # CSV / JSON mẫu
25
+ ├─ requirements.txt
26
+ └─ main.py # FastAPI entrypoint
27
+ ├─ frontend/ # Frontend source
28
+ README.md
29
+
30
+
31
+ ⚠️ Lưu ý:
32
+
33
+ Hugging Face chỉ đọc Dockerfile ở ROOT
34
+
35
+ Không sử dụng docker-compose, start.ps1, hoặc .env trong Space
36
+
37
+ 4. Environment Variables & Secrets
38
+
39
+ Toàn bộ API key và biến môi trường KHÔNG được commit vào repo,
40
+ được cấu hình trong Hugging Face:
41
+
42
+ Settings Variables and secrets
43
+
44
+ 4.1 Variables (không nhạy cảm)
45
+ Name Value
46
+ PYTHONUNBUFFERED 1
47
+ PRECOMPUTE_DATA_DIR /app/backend/precomputation/data
48
+ 4.2 Secrets (API keys)
49
+ Name Mô tả
50
+ GOOGLE_API_KEY Google GenAI API key
51
+ VNPT_AI_API_KEY VNPT AI API key
52
+ VNPT_AI_ENDPOINT Endpoint VNPT AI (nếu có)
53
+
54
+ ⚠️ Secrets không hiển thị trong code logs.
55
+
56
+ 5. Cách Space hoạt động
57
+
58
+ Khi Space được build:
59
+
60
+ Hugging Face đọc Dockerfile
61
+
62
+ Build image
63
+
64
+ Inject Variables & Secrets
65
+
66
+ Chạy backend FastAPI
67
+
68
+ Public web app qua URL Space
69
+
70
+ Không cần thao tác thủ công.
71
+
72
+ 6. Truy cập demo
73
+
74
+ Sau khi Space ở trạng thái Running, mở trực tiếp link Space:
75
+
76
+ 👉 Web UI sẽ hiển thị ngay
77
+
78
+ Hệ thống đã:
79
+
80
+ Load dữ liệu mẫu
81
+
82
+ Sẵn sàng demo logic AI & sales flow
83
+
84
+ 7. Troubleshooting
85
+ Space không chạy / Config error
86
+
87
+ Kiểm tra:
88
+
89
+ Dockerfile nằm ROOT không
90
+
91
+ backend/ai tồn tại đúng đường dẫn không
92
+
93
+ Không có log
94
+
95
+ Đợi 1–2 phút sau khi Restart Space
96
+
97
+ Nếu vẫn trống → thường là Dockerfile không được detect
98
+
99
+ 8. Ghi chú cho Ban giám khảo
100
+
101
+ Đây là MVP demo
102
+
103
+ Tập trung vào:
104
+
105
+ Kiến trúc AI Agent
106
+
107
+ Flow xử dữ liệu & tư vấn sales
108
+
109
+ Khả năng mở rộng & tích hợp thực tế
110
+
111
+ 9. Liên hệ
112
+
113
+ Mọi câu hỏi liên quan đến hệ thống PINE-AI
114
+ vui lòng liên hệ trực tiếp nhóm phát triển.