send_request.ipynb 9.24 KB
Newer Older
Chayenne's avatar
Chayenne committed
1
2
3
4
5
6
{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
7
    "# Quick Start: Sending Requests\n",
Chayenne's avatar
Chayenne committed
8
9
10
11
    "This notebook provides a quick-start guide to use SGLang in chat completions after installation.\n",
    "\n",
    "- For Vision Language Models, see [OpenAI APIs - Vision](../backend/openai_api_vision.ipynb).\n",
    "- For Embedding Models, see [OpenAI APIs - Embedding](../backend/openai_api_embeddings.ipynb) and [Encode (embedding model)](../backend/native_api.html#Encode-(embedding-model)).\n",
12
    "- For Reward Models, see [Classify (reward model)](../backend/native_api.html#Classify-(reward-model))."
Chayenne's avatar
Chayenne committed
13
14
15
16
17
18
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
Chayenne's avatar
Chayenne committed
19
20
    "## Launch A Server\n",
    "\n",
Chayenne's avatar
Chayenne committed
21
22
23
24
25
26
27
    "This code block is equivalent to executing \n",
    "\n",
    "```bash\n",
    "python -m sglang.launch_server --model-path meta-llama/Meta-Llama-3.1-8B-Instruct \\\n",
    "--port 30000 --host 0.0.0.0\n",
    "```\n",
    "\n",
Chayenne's avatar
Chayenne committed
28
    "in your terminal and wait for the server to be ready. Once the server is running, you can send test requests using curl or requests. The server implements the [OpenAI-compatible APIs](https://platform.openai.com/docs/api-reference/chat)."
Chayenne's avatar
Chayenne committed
29
30
31
32
   ]
  },
  {
   "cell_type": "code",
Chayenne's avatar
Chayenne committed
33
   "execution_count": null,
Chayenne's avatar
Chayenne committed
34
35
   "metadata": {
    "execution": {
36
37
38
39
     "iopub.execute_input": "2024-11-05T05:11:10.680191Z",
     "iopub.status.busy": "2024-11-05T05:11:10.679710Z",
     "iopub.status.idle": "2024-11-05T05:11:39.882385Z",
     "shell.execute_reply": "2024-11-05T05:11:39.881827Z"
Chayenne's avatar
Chayenne committed
40
41
    }
   },
Chayenne's avatar
Chayenne committed
42
   "outputs": [],
Chayenne's avatar
Chayenne committed
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
   "source": [
    "from sglang.utils import (\n",
    "    execute_shell_command,\n",
    "    wait_for_server,\n",
    "    terminate_process,\n",
    "    print_highlight,\n",
    ")\n",
    "\n",
    "server_process = execute_shell_command(\n",
    "\"\"\"\n",
    "python -m sglang.launch_server --model-path meta-llama/Meta-Llama-3.1-8B-Instruct \\\n",
    "--port 30000 --host 0.0.0.0\n",
    "\"\"\"\n",
    ")\n",
    "\n",
    "wait_for_server(\"http://localhost:30000\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
Chayenne's avatar
Chayenne committed
65
66
67
68
69
70
    "## Using cURL\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
71
72
73
74
75
76
77
78
   "metadata": {
    "execution": {
     "iopub.execute_input": "2024-11-05T05:11:39.883923Z",
     "iopub.status.busy": "2024-11-05T05:11:39.883721Z",
     "iopub.status.idle": "2024-11-05T05:11:40.124980Z",
     "shell.execute_reply": "2024-11-05T05:11:40.124557Z"
    }
   },
Chayenne's avatar
Chayenne committed
79
80
81
   "outputs": [],
   "source": [
    "import subprocess, json\n",
Chayenne's avatar
Chayenne committed
82
    "\n",
Chayenne's avatar
Chayenne committed
83
84
    "curl_command = \"\"\"\n",
    "curl -s http://localhost:30000/v1/chat/completions \\\n",
Lianmin Zheng's avatar
Lianmin Zheng committed
85
    "  -d '{\"model\": \"meta-llama/Meta-Llama-3.1-8B-Instruct\", \"messages\": [{\"role\": \"user\", \"content\": \"What is the capital of France?\"}]}'\n",
Chayenne's avatar
Chayenne committed
86
87
88
89
90
91
92
93
94
95
    "\"\"\"\n",
    "\n",
    "response = json.loads(subprocess.check_output(curl_command, shell=True))\n",
    "print_highlight(response)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
Chayenne's avatar
Chayenne committed
96
    "## Using Python Requests"
Chayenne's avatar
Chayenne committed
97
98
99
100
   ]
  },
  {
   "cell_type": "code",
Chayenne's avatar
Chayenne committed
101
   "execution_count": null,
Chayenne's avatar
Chayenne committed
102
103
   "metadata": {
    "execution": {
104
105
106
107
     "iopub.execute_input": "2024-11-05T05:11:40.126564Z",
     "iopub.status.busy": "2024-11-05T05:11:40.126369Z",
     "iopub.status.idle": "2024-11-05T05:11:40.324316Z",
     "shell.execute_reply": "2024-11-05T05:11:40.323693Z"
Chayenne's avatar
Chayenne committed
108
109
    }
   },
Chayenne's avatar
Chayenne committed
110
   "outputs": [],
Chayenne's avatar
Chayenne committed
111
   "source": [
Chayenne's avatar
Chayenne committed
112
    "import requests\n",
113
    "\n",
Chayenne's avatar
Chayenne committed
114
115
116
    "url = \"http://localhost:30000/v1/chat/completions\"\n",
    "\n",
    "data = {\n",
117
118
    "    \"model\": \"meta-llama/Meta-Llama-3.1-8B-Instruct\",\n",
    "    \"messages\": [\n",
Lianmin Zheng's avatar
Lianmin Zheng committed
119
    "        {\"role\": \"user\", \"content\": \"What is the capital of France?\"}\n",
120
    "    ]\n",
Chayenne's avatar
Chayenne committed
121
    "}\n",
122
    "\n",
Chayenne's avatar
Chayenne committed
123
124
    "response = requests.post(url, json=data)\n",
    "print_highlight(response.json())"
Chayenne's avatar
Chayenne committed
125
126
127
128
129
130
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
Lianmin Zheng's avatar
Lianmin Zheng committed
131
    "## Using OpenAI Python Client"
Chayenne's avatar
Chayenne committed
132
133
134
135
   ]
  },
  {
   "cell_type": "code",
Chayenne's avatar
Chayenne committed
136
   "execution_count": null,
Chayenne's avatar
Chayenne committed
137
138
   "metadata": {
    "execution": {
139
140
141
142
     "iopub.execute_input": "2024-11-05T05:11:40.327043Z",
     "iopub.status.busy": "2024-11-05T05:11:40.326759Z",
     "iopub.status.idle": "2024-11-05T05:11:41.687336Z",
     "shell.execute_reply": "2024-11-05T05:11:41.686855Z"
Chayenne's avatar
Chayenne committed
143
144
    }
   },
Chayenne's avatar
Chayenne committed
145
   "outputs": [],
Chayenne's avatar
Chayenne committed
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
   "source": [
    "import openai\n",
    "\n",
    "client = openai.Client(base_url=\"http://127.0.0.1:30000/v1\", api_key=\"None\")\n",
    "\n",
    "response = client.chat.completions.create(\n",
    "    model=\"meta-llama/Meta-Llama-3.1-8B-Instruct\",\n",
    "    messages=[\n",
    "        {\"role\": \"user\", \"content\": \"List 3 countries and their capitals.\"},\n",
    "    ],\n",
    "    temperature=0,\n",
    "    max_tokens=64,\n",
    ")\n",
    "print_highlight(response)"
   ]
  },
Lianmin Zheng's avatar
Lianmin Zheng committed
162
163
164
165
166
167
168
169
170
171
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Streaming"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
172
173
174
175
176
177
178
179
   "metadata": {
    "execution": {
     "iopub.execute_input": "2024-11-05T05:11:41.688676Z",
     "iopub.status.busy": "2024-11-05T05:11:41.688527Z",
     "iopub.status.idle": "2024-11-05T05:11:42.717140Z",
     "shell.execute_reply": "2024-11-05T05:11:42.716452Z"
    }
   },
Lianmin Zheng's avatar
Lianmin Zheng committed
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
   "outputs": [],
   "source": [
    "import openai\n",
    "\n",
    "client = openai.Client(base_url=\"http://127.0.0.1:30000/v1\", api_key=\"None\")\n",
    "\n",
    "# Use stream=True for streaming responses\n",
    "response = client.chat.completions.create(\n",
    "    model=\"meta-llama/Meta-Llama-3.1-8B-Instruct\",\n",
    "    messages=[\n",
    "        {\"role\": \"user\", \"content\": \"List 3 countries and their capitals.\"},\n",
    "    ],\n",
    "    temperature=0,\n",
    "    max_tokens=64,\n",
    "    stream=True,\n",
    ")\n",
    "\n",
    "# Handle the streaming output\n",
    "for chunk in response:\n",
    "    if chunk.choices[0].delta.content:\n",
    "        print(chunk.choices[0].delta.content, end='', flush=True)"
   ]
  },
203
204
205
206
207
208
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Using Native Generation APIs\n",
    "\n",
Chayenne's avatar
Chayenne committed
209
    "You can also use the native `/generate` endpoint with requests, which provides more flexiblity. An API reference is available at [Sampling Parameters](https://sgl-project.github.io/references/sampling_params.html)."
210
211
212
213
   ]
  },
  {
   "cell_type": "code",
Chayenne's avatar
Chayenne committed
214
   "execution_count": null,
215
216
217
218
219
220
221
222
   "metadata": {
    "execution": {
     "iopub.execute_input": "2024-11-05T05:11:42.720467Z",
     "iopub.status.busy": "2024-11-05T05:11:42.720182Z",
     "iopub.status.idle": "2024-11-05T05:11:43.480765Z",
     "shell.execute_reply": "2024-11-05T05:11:43.480143Z"
    }
   },
Chayenne's avatar
Chayenne committed
223
   "outputs": [],
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
   "source": [
    "import requests\n",
    "\n",
    "response = requests.post(\n",
    "    \"http://localhost:30000/generate\",\n",
    "    json={\n",
    "        \"text\": \"The capital of France is\",\n",
    "        \"sampling_params\": {\n",
    "            \"temperature\": 0,\n",
    "            \"max_new_tokens\": 32,\n",
    "        },\n",
    "    },\n",
    ")\n",
    "\n",
    "print_highlight(response.json())"
   ]
  },
Lianmin Zheng's avatar
Lianmin Zheng committed
241
242
243
244
245
246
247
248
249
250
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Streaming"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
251
252
253
254
255
256
257
258
   "metadata": {
    "execution": {
     "iopub.execute_input": "2024-11-05T05:11:43.483575Z",
     "iopub.status.busy": "2024-11-05T05:11:43.483295Z",
     "iopub.status.idle": "2024-11-05T05:11:44.242950Z",
     "shell.execute_reply": "2024-11-05T05:11:44.242248Z"
    }
   },
Lianmin Zheng's avatar
Lianmin Zheng committed
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
   "outputs": [],
   "source": [
    "import requests, json\n",
    "\n",
    "response = requests.post(\n",
    "    \"http://localhost:30000/generate\",\n",
    "    json={\n",
    "        \"text\": \"The capital of France is\",\n",
    "        \"sampling_params\": {\n",
    "            \"temperature\": 0,\n",
    "            \"max_new_tokens\": 32,\n",
    "        },\n",
    "        \"stream\": True,\n",
    "    },\n",
    "    stream=True,\n",
    ")\n",
    "\n",
    "prev = 0\n",
    "for chunk in response.iter_lines(decode_unicode=False):\n",
    "    chunk = chunk.decode(\"utf-8\")\n",
    "    if chunk and chunk.startswith(\"data:\"):\n",
    "        if chunk == \"data: [DONE]\":\n",
    "            break\n",
    "        data = json.loads(chunk[5:].strip(\"\\n\"))\n",
    "        output = data[\"text\"]\n",
    "        print(output[prev:], end=\"\", flush=True)\n",
    "        prev = len(output)"
   ]
  },
Chayenne's avatar
Chayenne committed
288
289
  {
   "cell_type": "code",
Chayenne's avatar
Chayenne committed
290
   "execution_count": 8,
Chayenne's avatar
Chayenne committed
291
292
   "metadata": {
    "execution": {
293
294
295
296
     "iopub.execute_input": "2024-11-05T05:11:44.245660Z",
     "iopub.status.busy": "2024-11-05T05:11:44.245373Z",
     "iopub.status.idle": "2024-11-05T05:11:45.591682Z",
     "shell.execute_reply": "2024-11-05T05:11:45.591184Z"
Chayenne's avatar
Chayenne committed
297
298
299
300
301
302
303
304
305
306
307
308
309
    }
   },
   "outputs": [],
   "source": [
    "terminate_process(server_process)"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
Chayenne's avatar
Chayenne committed
310
311
312
313
314
315
316
317
318
319
320
321
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.7"
Chayenne's avatar
Chayenne committed
322
323
324
325
326
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}