README.md

# CPT-LoRA_ST-Vicuna-v1.3-5.5B-PPL-q4f16_1-MLC

This is the [CPT-LoRA_ST-Vicuna-v1.3-5.5B-PPL](https://huggingface.co/nota-ai/cpt-lora_st-vicuna-v1.3-5.5b-ppl) model in MLC format `q4f16_1`.
The model can be used for projects [MLC-LLM](https://github.com/mlc-ai/mlc-llm) and [WebLLM](https://github.com/mlc-ai/web-llm).

## Example Usage

Here are some examples of using this model in MLC LLM.
Before running the examples, please install MLC LLM by following the [installation documentation](https://llm.mlc.ai/docs/install/mlc_llm.html#install-mlc-packages).

### Chat

In command line, run
```bash
mlc_llm chat HF://nota-ai/cpt-lora_st-vicuna-v1.3-5.5b-ppl-q4f16_1-MLC
```

### REST Server

In command line, run
```bash
mlc_llm serve HF://nota-ai/cpt-lora_st-vicuna-v1.3-5.5b-ppl-q4f16_1-MLC
```

### Python API

```python
from mlc_llm import MLCEngine

# Create engine
model = "HF://nota-ai/cpt-lora_st-vicuna-v1.3-5.5b-ppl-q4f16_1-MLC"
engine = MLCEngine(model)

# Run chat completion in OpenAI API.
for response in engine.chat.completions.create(
    messages=[{"role": "user", "content": "What is the meaning of life?"}],
    model=model,
    stream=True,
):
    for choice in response.choices:
        print(choice.delta.content, end="", flush=True)
print("\n")

engine.terminate()
```

### License
- All rights related to this repository and the compressed models are reserved by Nota Inc.
- The intended use is strictly limited to research and non-commercial projects.