Add usage

README.md

@@ -1,3 +1,38 @@
 ---
 license: apache-2.0
 ---
+
+## Usage
+
+We use FastChat and vllm worker to host the model. Run these following commands in seperate terminals, such as `tmux`.
+
+```shell
+LOGDIR="" python3 -m fastchat.serve.openai_api_server \
+    --host 0.0.0.0 --port 8080 \
+    --controller-address http://localhost:21000
+
+LOGDIR="" python3 -m fastchat.serve.controller \
+    --host 0.0.0.0 --port 21000
+
+LOGDIR="" RAY_LOG_TO_STDERR=1 \
+    python3 -m fastchat.serve.vllm_worker \
+    --model-path ./VirtualCompiler \
+    --num-gpus 8 \
+    --controller http://localhost:21000 \
+    --max-num-batched-tokens 40960 \
+    --disable-log-requests \
+    --host 0.0.0.0 --port 22000 \
+    --worker-address http://localhost:22000 \
+    --model-names "VirtualCompiler"
+```
+
+Then with the model hosted, use `do_request.py` to make request to the model.
+
+```shell
+~/C/VirtualCompiler (main)> python3 do_request.py
+test rdx, rdx
+setz al
+movzx eax, al
+neg eax
+retn
+```

do_request.py

@@ -0,0 +1,55 @@
+import requests
+import random
+
+CL = ['clang-11', 'clang-12', 'clang-9', 'gcc-11', 'gcc-7', 'gcc-9']
+OP = ['O0', 'O1', 'O2', 'O3', 'Os']
+ST = ['stripped', 'unstripped']
+
+
+def process(source_code):
+    compiler = random.choice(CL)
+    optimizer = random.choice(OP)
+    strip_type = random.choice(ST)
+    prompt = f'Please compile this source code using {compiler} with optimization level {optimizer} into assembly code.'
+    if strip_type == 'stripped':
+        prompt += ' Strip the assembly code.'
+    else:
+        prompt += ' No strip the assembly code.'
+    query_prompt = "<s>system\n" + prompt + \
+        "</s>\n<s>user\n" + source_code + "</s>\n<s>assistant\n"
+    return query_prompt, compiler, optimizer, strip_type
+
+
+def do_request(src):
+    url = "http://localhost:8080/v1/completions"
+
+    query_prompt, _, _, _ = process(src)
+
+    model_name = "VirtualCompiler"
+
+    ret = requests.post(url, json={
+        "prompt": query_prompt,
+        "max_tokens": 4096,
+        "temperature": 0.3,
+        "stop": ["</s>"],
+        "model": model_name,
+        "echo": False,
+        "logprobs": True,
+    })
+
+    return ret.json()
+
+
+src = '''static int
+layout_append(struct layout_cell *lc, char *buf, size_t len)
+{
+    if (len == 0)
+        return (-1);
+
+    return (0);
+}
+'''
+
+ret = do_request(src)
+
+print(ret['choices'][0]['text'])