Update README.md
Browse files
README.md
CHANGED
|
@@ -18,6 +18,99 @@ tags:
|
|
| 18 |
- Cyber
|
| 19 |
- Scurity
|
| 20 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 21 |
## π οΈ Panduan Troubleshooting (Pemecahan Masalah)
|
| 22 |
|
| 23 |
Jika Anda menemui kendala saat menjalankan **HackCat AI Chat**, silakan cek solusi di bawah ini:
|
|
|
|
| 18 |
- Cyber
|
| 19 |
- Scurity
|
| 20 |
---
|
| 21 |
+
|
| 22 |
+
Berikut adalah draf untuk file `README.md` yang disesuaikan dengan kode Python Anda. Saya telah menyusunnya agar terlihat profesional, mudah dibaca, dan informatif bagi siapa saja yang ingin menjalankan program Anda.
|
| 23 |
+
|
| 24 |
+
---
|
| 25 |
+
|
| 26 |
+
# π±βπ» HackCat AI Chat
|
| 27 |
+
|
| 28 |
+
HackCat AI Chat adalah aplikasi chatbot berbasis Command Line Interface (CLI) yang berjalan menggunakan model bahasa lokal (Large Language Model) berekstensi `.gguf`. Proyek ini menggunakan pustaka `gpt4all` dan dirancang untuk berjalan **sepenuhnya secara offline** tanpa memerlukan koneksi internet.
|
| 29 |
+
|
| 30 |
+
## β¨ Fitur Utama
|
| 31 |
+
|
| 32 |
+
* **100% Offline:** Menjaga privasi data Anda karena pemrosesan dilakukan sepenuhnya di perangkat lokal.
|
| 33 |
+
* **Streaming Responses:** Jawaban dari AI ditampilkan kata demi kata secara *real-time*, memberikan pengalaman obrolan yang natural.
|
| 34 |
+
* **Sesi Interaktif:** Mengingat konteks percakapan selama sesi berjalan.
|
| 35 |
+
|
| 36 |
+
---
|
| 37 |
+
|
| 38 |
+
## π οΈ Persyaratan Sistem (Prerequisites)
|
| 39 |
+
|
| 40 |
+
Sebelum menjalankan aplikasi ini, pastikan sistem Anda telah memenuhi persyaratan berikut:
|
| 41 |
+
|
| 42 |
+
1. **Python** versi 3.8 atau lebih baru.
|
| 43 |
+
2. Pustaka Python **GPT4All**.
|
| 44 |
+
3. File model GGUF bernama `Model_Bahasa_Ram 2.gguf`.
|
| 45 |
+
|
| 46 |
+
---
|
| 47 |
+
|
| 48 |
+
## π Cara Instalasi & Persiapan
|
| 49 |
+
|
| 50 |
+
**1. Install Library GPT4All**
|
| 51 |
+
Buka terminal/command prompt Anda dan jalankan perintah berikut:
|
| 52 |
+
|
| 53 |
+
```bash
|
| 54 |
+
pip install gpt4all
|
| 55 |
+
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
**2. Persiapkan File Model**
|
| 59 |
+
Karena aplikasi ini disetel untuk tidak mengunduh model secara otomatis (`allow_download=False`), Anda harus menyediakan file modelnya secara manual:
|
| 60 |
+
|
| 61 |
+
* Unduh atau siapkan file model `Model_Bahasa_Ram 2.gguf`.
|
| 62 |
+
* Buat folder bernama `model` di direktori yang sama dengan file script Python Anda.
|
| 63 |
+
* Pindahkan file `.gguf` tersebut ke dalam folder `model`.
|
| 64 |
+
|
| 65 |
+
**3. Struktur Direktori**
|
| 66 |
+
Pastikan struktur folder Anda terlihat seperti ini:
|
| 67 |
+
|
| 68 |
+
```text
|
| 69 |
+
π¦ Proyek_HackCat/
|
| 70 |
+
β£ π model/
|
| 71 |
+
β β π Model_Bahasa_Ram 2.gguf
|
| 72 |
+
β π main.py (File script Python Anda)
|
| 73 |
+
|
| 74 |
+
```
|
| 75 |
+
|
| 76 |
+
---
|
| 77 |
+
|
| 78 |
+
## π» Cara Menjalankan Aplikasi
|
| 79 |
+
|
| 80 |
+
1. Buka terminal/command prompt.
|
| 81 |
+
2. Arahkan ke direktori proyek Anda.
|
| 82 |
+
3. Jalankan script Python:
|
| 83 |
+
|
| 84 |
+
```bash
|
| 85 |
+
python main.py
|
| 86 |
+
|
| 87 |
+
```
|
| 88 |
+
|
| 89 |
+
*(Ganti `main.py` dengan nama file Python Anda yang sebenarnya).*
|
| 90 |
+
|
| 91 |
+
Setelah berjalan, Anda akan melihat tampilan seperti ini di terminal:
|
| 92 |
+
|
| 93 |
+
```text
|
| 94 |
+
=== HackCat AI Chat ===
|
| 95 |
+
(Ketik 'exit' untuk berhenti)
|
| 96 |
+
|
| 97 |
+
Kamu: Halo, apa kabar?
|
| 98 |
+
AI: Halo! Kabar saya baik. Ada yang bisa saya bantu hari ini?
|
| 99 |
+
|
| 100 |
+
```
|
| 101 |
+
|
| 102 |
+
Ketik **`exit`** kapan saja untuk menghentikan program dan keluar dari sesi obrolan.
|
| 103 |
+
|
| 104 |
+
---
|
| 105 |
+
|
| 106 |
+
## βοΈ Penjelasan Kode Singkat
|
| 107 |
+
|
| 108 |
+
* `model_path="./model/"`: Menentukan lokasi di mana program akan mencari file model.
|
| 109 |
+
* `allow_download=False`: Memaksa program untuk hanya menggunakan model yang sudah ada secara lokal. Jika file tidak ditemukan, program akan memunculkan *error* alih-alih mencoba mengunduhnya dari internet.
|
| 110 |
+
* `streaming=True`: Memungkinkan teks dicetak ke layar sedikit demi sedikit (efek mengetik) alih-alih menunggu seluruh kalimat selesai dibuat oleh AI.
|
| 111 |
+
|
| 112 |
+
---
|
| 113 |
+
|
| 114 |
## π οΈ Panduan Troubleshooting (Pemecahan Masalah)
|
| 115 |
|
| 116 |
Jika Anda menemui kendala saat menjalankan **HackCat AI Chat**, silakan cek solusi di bawah ini:
|