jungsin3 commited on
Commit
c820850
·
verified ·
1 Parent(s): 46b1aba

Add How to Start (Chrome extension) section and setup guide video

Browse files
Files changed (3) hide show
  1. .gitattributes +1 -0
  2. README.md +37 -0
  3. assets/setup_guide.mp4 +3 -0
.gitattributes CHANGED
@@ -38,3 +38,4 @@ assets/demo.mp4 filter=lfs diff=lfs merge=lfs -text
38
  assets/GUI_agent_dem.mp4 filter=lfs diff=lfs merge=lfs -text
39
  assets/gui_final_demo_dubbed.mp4 filter=lfs diff=lfs merge=lfs -text
40
  assets/gui_final_demo_maksed.mp4 filter=lfs diff=lfs merge=lfs -text
 
 
38
  assets/GUI_agent_dem.mp4 filter=lfs diff=lfs merge=lfs -text
39
  assets/gui_final_demo_dubbed.mp4 filter=lfs diff=lfs merge=lfs -text
40
  assets/gui_final_demo_maksed.mp4 filter=lfs diff=lfs merge=lfs -text
41
+ assets/setup_guide.mp4 filter=lfs diff=lfs merge=lfs -text
README.md CHANGED
@@ -83,6 +83,43 @@ KORMo-Web-4B outperforms open web agents of similar size in both English and Kor
83
  - **Multi-site, multi-tab workflows.** It can search on one site, verify on another and write the result into a third, managing tabs on its own.
84
  - **Open and ready to run.** Apache-2.0 weights, a reference browser harness, the tool schema and the exact inference settings are all included.
85
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
86
  ## Quickstart
87
 
88
  Tested with **vLLM 0.23.0** and **transformers 5.12.1**. The model runs on a single GPU (TP=1).
 
83
  - **Multi-site, multi-tab workflows.** It can search on one site, verify on another and write the result into a third, managing tabs on its own.
84
  - **Open and ready to run.** Apache-2.0 weights, a reference browser harness, the tool schema and the exact inference settings are all included.
85
 
86
+ ## How to Start: Chrome Extension
87
+
88
+ The fastest way to try KORMo-Web is the **[KORMo-Web Chrome extension](https://github.com/MLP-Lab/KORMo-Web-Extension)**: type a request in Chrome's side panel and watch the agent work in your own browser. This video walks through the whole setup, from serving the model to running a task and controlling it from Discord.
89
+
90
+ <video src="https://huggingface.co/KORMo-VL/KORMo-Web-4B/resolve/main/assets/setup_guide.mp4" controls playsinline preload="metadata" width="100%"></video>
91
+
92
+ *Setup guide (about 15 min, Korean narration). Parts that showed account tokens have been blurred.*
93
+
94
+ **1. Serve the model.** Pick one.
95
+
96
+ - **Mac (Apple silicon):** run the 4-bit MLX build with `vllm-mlx`. Simple, but slower.
97
+
98
+ ```bash
99
+ uv venv --python 3.12 && source .venv/bin/activate
100
+ uv pip install vllm-mlx
101
+ vllm-mlx serve KORMo-VL/KORMo-Web-4B-mlx-4bit --port 8010 --mllm
102
+ ```
103
+
104
+ - **GPU server:** serve this model with vLLM. Much faster, and one server can be shared.
105
+
106
+ ```bash
107
+ vllm serve KORMo-VL/KORMo-Web-4B --host 0.0.0.0 --port 8000 \
108
+ --served-model-name KORMo-Web-4B \
109
+ --mm-encoder-tp-mode data --mm-processor-cache-type shm \
110
+ --gdn-prefill-backend triton
111
+ ```
112
+
113
+ Check it with `curl http://localhost:8010/v1/models` (use your server address and port for vLLM).
114
+
115
+ **2. Install the extension.** `git clone https://github.com/MLP-Lab/KORMo-Web-Extension.git`, open `chrome://extensions`, turn on **Developer mode**, click **Load unpacked** and choose the cloned folder. Open the **GUI 에이전트** side panel, type a task and press **실행** (Run).
116
+
117
+ **3. Using a GPU server?** In the panel's **개발자 설정** (Developer settings), set the server URL (ending in `/v1`), the model name (`KORMo-Web-4B`), and `tool_choice` to `none`. The Mac default needs no change.
118
+
119
+ **4. Discord (optional).** Run `node relay/discord-relay.mjs` in the cloned folder and follow the prompts to send tasks to the agent by mentioning a bot in a channel.
120
+
121
+ Full step-by-step instructions (Korean) are in the [extension README](https://github.com/MLP-Lab/KORMo-Web-Extension).
122
+
123
  ## Quickstart
124
 
125
  Tested with **vLLM 0.23.0** and **transformers 5.12.1**. The model runs on a single GPU (TP=1).
assets/setup_guide.mp4 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:e60ff6f4d272b3edc59ec93abf7c5fe0bb72dbba77819820e5fc4c8d8db85633
3
+ size 52314090