Abid Ali Awan Codex commited on
Commit
0b268cb
·
1 Parent(s): 7cfef5a

Prepare public GitHub release

Browse files

Fix the CUDA Docker build, simplify the project documentation, and add the NoticeCheck demo.

Co-authored-by: Codex <codex@openai.com>

Files changed (3) hide show
  1. Dockerfile +1 -0
  2. README.md +8 -28
  3. docs/app-demo.gif +3 -0
Dockerfile CHANGED
@@ -8,6 +8,7 @@ ENV DEBIAN_FRONTEND=noninteractive \
8
 
9
  RUN apt-get update \
10
  && apt-get install --yes --no-install-recommends \
 
11
  git \
12
  libgl1 \
13
  libglib2.0-0 \
 
8
 
9
  RUN apt-get update \
10
  && apt-get install --yes --no-install-recommends \
11
+ build-essential \
12
  git \
13
  libgl1 \
14
  libglib2.0-0 \
README.md CHANGED
@@ -34,8 +34,13 @@ short_description: Review suspicious Pakistani messages before you act.
34
 
35
  This repository is the local version of the
36
  [Pakistan Notice Helper Hugging Face Space](https://huggingface.co/spaces/build-small-hackathon/pakistan-notice-helper).
37
- It keeps the same notice-checking purpose, but uses a redesigned interface and
38
- uses the Hugging Face ZeroGPU runtime.
 
 
 
 
 
39
 
40
  NoticeCheck is a safety assistant for suspicious Pakistani messages, bills,
41
  bank alerts, challans, courier notices, and screenshots. It returns:
@@ -84,8 +89,7 @@ local NVIDIA GPU. It does not use ZeroGPU or a remote inference API.
84
 
85
  Prerequisites:
86
 
87
- - Docker Engine with Docker Compose 2.30 or newer, or Docker Desktop with the
88
- WSL 2 backend
89
  - a supported NVIDIA GPU and current NVIDIA driver
90
  - NVIDIA Container Toolkit when using Docker Engine on Linux
91
  - enough GPU memory for MiniCPM5-1B and Nemotron-Parse v1.2
@@ -100,13 +104,6 @@ Open <http://localhost:7860>. The first startup takes longer because both model
100
  repositories are downloaded. Downloads are retained in the
101
  `huggingface-cache` Docker volume.
102
 
103
- Verify that PyTorch can access the local GPU:
104
-
105
- ```bash
106
- docker compose run --rm noticecheck python -c \
107
- "import torch; print(torch.cuda.is_available(), torch.cuda.get_device_name(0))"
108
- ```
109
-
110
  Optional environment overrides can be placed in a local `.env` file:
111
 
112
  ```dotenv
@@ -148,23 +145,6 @@ experiments/ Preserved historical model experiments
148
  tests/ Application and trace tests
149
  ```
150
 
151
- ## Run
152
-
153
- For the Hugging Face Space runtime:
154
-
155
- ```bash
156
- python -m pip install -r requirements.txt
157
- python app.py
158
- ```
159
-
160
- ## Testing
161
-
162
- ```bash
163
- python app.py --self-test
164
- python -m unittest
165
- node --check static/app.js
166
- ```
167
-
168
  ## English-Only Interface
169
 
170
  This version intentionally uses an English-only interface and requests English
 
34
 
35
  This repository is the local version of the
36
  [Pakistan Notice Helper Hugging Face Space](https://huggingface.co/spaces/build-small-hackathon/pakistan-notice-helper).
37
+ It keeps the same notice-checking purpose with a redesigned English interface.
38
+ The hosted demo uses Hugging Face ZeroGPU, while Docker Compose runs the models
39
+ on a local NVIDIA GPU.
40
+
41
+ **[Try the live demo](https://huggingface.co/spaces/build-small-hackathon/noticecheck)**
42
+
43
+ ![NoticeCheck demo](docs/app-demo.gif)
44
 
45
  NoticeCheck is a safety assistant for suspicious Pakistani messages, bills,
46
  bank alerts, challans, courier notices, and screenshots. It returns:
 
89
 
90
  Prerequisites:
91
 
92
+ - Docker Engine with Docker Compose 2.30 or newer
 
93
  - a supported NVIDIA GPU and current NVIDIA driver
94
  - NVIDIA Container Toolkit when using Docker Engine on Linux
95
  - enough GPU memory for MiniCPM5-1B and Nemotron-Parse v1.2
 
104
  repositories are downloaded. Downloads are retained in the
105
  `huggingface-cache` Docker volume.
106
 
 
 
 
 
 
 
 
107
  Optional environment overrides can be placed in a local `.env` file:
108
 
109
  ```dotenv
 
145
  tests/ Application and trace tests
146
  ```
147
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
148
  ## English-Only Interface
149
 
150
  This version intentionally uses an English-only interface and requests English
docs/app-demo.gif ADDED

Git LFS Details

  • SHA256: 711d9e62e5d155dd40b67f80778446aad709b45ca59a1c509a4338e56a2818be
  • Pointer size: 132 Bytes
  • Size of remote file: 8.42 MB