S-Dreamer commited on
Commit
b3aaf9d
·
verified ·
1 Parent(s): 5f7a1ab

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +135 -2
README.md CHANGED
@@ -4,7 +4,7 @@ emoji: 💬
4
  colorFrom: yellow
5
  colorTo: purple
6
  sdk: gradio
7
- sdk_version: 5.42.0
8
  app_file: app.py
9
  pinned: false
10
  hf_oauth: true
@@ -13,4 +13,137 @@ hf_oauth_scopes:
13
  license: mit
14
  ---
15
 
16
- An example chatbot using [Gradio](https://gradio.app), [`huggingface_hub`](https://huggingface.co/docs/huggingface_hub/v0.22.2/en/index), and the [Hugging Face Inference API](https://huggingface.co/docs/api-inference/index).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
  colorFrom: yellow
5
  colorTo: purple
6
  sdk: gradio
7
+ sdk_version: 6.0.0
8
  app_file: app.py
9
  pinned: false
10
  hf_oauth: true
 
13
  license: mit
14
  ---
15
 
16
+ # APJ Threat Intelligence System
17
+ Mobile-First, Multilingual Cybercrime Intelligence Platform
18
+
19
+ ## Overview
20
+ This project delivers a full-stack threat-intelligence console focused on
21
+ Asia-Pacific & Japan (APJ) cybercrime ecosystems. The system ingests
22
+ Mandarin/Cantonese underground-market chatter, interprets idioms and cultural
23
+ nuances, classifies threats using transformer models, and presents insights to
24
+ analysts through a mobile-first Gradio interface.
25
+
26
+ The design is modular, allowing you to use:
27
+ - Local Transformers models (HuggingFace)
28
+ - External LLM APIs
29
+ - Custom datasets
30
+ - A growing slang / idiom lexicon
31
+ - Marketplace monitoring pipelines
32
+
33
+ This repository is optimized for **GitHub** and **HuggingFace Spaces**.
34
+
35
+ ---
36
+
37
+ ## ✨ Features
38
+
39
+ ### 🔍 Intelligence Layer
40
+ - Threat classification (Transformers)
41
+ - Vendor graph modeling
42
+ - Marketplace and trend analysis
43
+ - Slang & idiom identification
44
+
45
+ ### 🌏 Multilingual Processing
46
+ - Mandarin + Cantonese dialect detection
47
+ - Literal + functional translation
48
+ - Cultural interpretation for cybercrime slang
49
+
50
+ ### 📱 Mobile-First UI
51
+ Built with Gradio 4.x:
52
+ - Single-column layout
53
+ - Mode switcher (Threat Intel / Translation / Marketplace Watch / Analyst Tools)
54
+ - File upload for logs, screenshots, raw text
55
+ - Downloadable chat transcripts
56
+ - Clean UX optimized for mobile operators
57
+
58
+ ### 🔧 Built With
59
+ - `transformers`
60
+ - `datasets`
61
+ - `gradio`
62
+ - Python 3.10+
63
+
64
+ ---
65
+
66
+ ## 🧩 Repository Structure
67
+
68
+ .
69
+ ├── app.py # Main Gradio app
70
+ ├── prompt_engine.py # Centralized prompt construction
71
+ ├── model_inference.py # Transformers-based inference wrapper
72
+ ├── datasets_loader.py # HuggingFace datasets loader utilities
73
+ ├── slang_lexicon.json # Evolving idiom/slang dictionary
74
+ ├── PROJECT_SPEC.md # Architectural overview
75
+ ├── HUGGINGFACE.md # HF Spaces deployment instructions
76
+ ├── GITHUB_SETUP.md # Repo usage & development guide
77
+ ├── requirements.txt
78
+ └── README.md
79
+
80
+ ---
81
+
82
+ ## 🚀 Running Locally
83
+
84
+ ### 1. Clone the repo
85
+ ```bash
86
+ git clone https://github.com/<yourname>/apj-threat-intel
87
+ cd apj-threat-intel
88
+
89
+ 2. Install requirements
90
+
91
+ pip install -r requirements.txt
92
+
93
+ 3. Launch the app
94
+
95
+ python app.py
96
+
97
+ The interface opens automatically in your browser.
98
+
99
+
100
+
101
+ 🧠 Model Integration
102
+
103
+ You can plug your own HuggingFace model into model_inference.py:
104
+
105
+ ThreatModel(model_path="your-model-name")
106
+
107
+ Or use an API-driven LLM via prompt_engine.py.
108
+
109
+
110
+
111
+ 🌐 Deploy on HuggingFace Spaces
112
+
113
+ See HUGGINGFACE.md in this repo for step-by-step instructions.
114
+
115
+
116
+
117
+ 📄 Docs
118
+ • Project Spec
119
+ • HF Spaces Setup
120
+ • GitHub Setup Guide
121
+
122
+
123
+
124
+ 📜 License
125
+
126
+ MIT (You may swap this with your preferred license.)
127
+
128
+
129
+
130
+ 🤝 Contributing
131
+
132
+ Pull requests and issue reports are welcome.
133
+
134
+
135
+
136
+ 🧭 Roadmap
137
+ • Vendor identity resolution model
138
+ • Marketplace scraping connectors
139
+ • Cantonese pretrained language model fine-tuning
140
+ • In-browser graph explorer
141
+ • Real-time alerting engine
142
+
143
+
144
+
145
+ ✉️ Contact
146
+
147
+ For questions, enhancements, or collaboration, open an issue.
148
+
149
+ ---