base on This project aims to enable language model inference on FPGAs, supporting AI applications in edge devices and environments with limited resources. <div align="center">
# Swan
**A Lightweight Language Model Execution Environment Using FPGA**
English | [日本語](./docs/README_JP.md) | [中文](./docs/README_CN.md)
Swan is an OSS project implemented in C++.
Its goal is to efficiently run language models on general-purpose FPGAs using High-Level Synthesis (HLS).
</div>
<div align="center">
<img src="./images/swan_image.png" width="50%">
</div>
This project aims to enable language model inference on FPGAs, supporting AI applications in edge devices and environments with limited resources.
## Features
- Versatility: Supports common FPGA boards such as the KV260.
- Scalability: The source code is written in C++, making customization and extension easy.
- Lightweight: Considers the size constraints of language models and adopts an efficient architecture.
## Dependencies
To build and run Swan, the following tools and libraries are required:
- CMake
- g++
- HLS tools (e.g., Vivado HLS)
## Clone & Download Weight Files
To clone the Swan repository, run the following command:
```bash
$ git clone
[email protected]:turingmotors/swan.git
$ cd swan
```
Download 15M parameter model from [huggingface.co/karpathy/tinyllamas](https://huggingface.co/karpathy/tinyllamas/tree/main):
```
wget https://huggingface.co/karpathy/tinyllamas/resolve/main/stories15M.bin -O model/stories15M.bin
wget https://raw.githubusercontent.com/leloykun/llama2.cpp/master/tokenizer.bin -O model/tokenizer.bin
```
## Building
### FPGA Environment
See [technical blog](https://zenn.dev/turing_motors/articles/82505880d27d65) for details on building Swan in an FPGA environment.
### CPU Environment
```bash
$ mkdir -p build && cd build
$ cmake ..
$ make && cd ..
```
Once the build is complete, you can run Swan with the following command:
```bash
$ ./build/swan
```
## Command Line Options
Swan supports the following options:
```bash
Usage: ./build/swan [options]
Options:
--weight_path : Weight file path
--vocab_path : Tokenizer file path
--max_seq : Maximum sequence length
--temp : Temperature for sampling
--color : Enable color output
--log : Enable log output
--help, -h : Show this help message
```
## Reference Projects
This project is inspired by [llama2.c](https://github.com/karpathy/llama2.c).
## License
This project is released under the [Apache License 2.0](./LICENSE).
## Contributions
Contributions to Swan are highly welcome. Please submit feedback and improvement suggestions through Issues and Pull Requests.
[Turing Inc.](https://www.turing-motors.com/en) is supporting the development of Swan.
", Assign "at most 3 tags" to the expected json: {"id":"9686","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"