Skip to content

Latest commit

 

History

History
38 lines (30 loc) · 3.71 KB

README.md

File metadata and controls

38 lines (30 loc) · 3.71 KB
Raw

PerroPastor

With all of these latin american wild animals running around (Llamas, Alpacas, Guanacos, Vicuñas) we need a good Perro Pastor ("sheep dog") to get them running! Perro Pastor is a Unity package written with just a few files of C# and compute shaders to run Llama based models on any Unity compatible platform on the gpu! I built this package primarily as an exercise to understand the execution of LLM inference at a deeper level, but I think that it has the potential to be useful to game developers who want to run low latency small LLMs in their games without relying on server infrastructure.

I also intend this repo to be a good opportunity to learn how LLMs work. Although compute shaders aren't the most readable form of source code, I have included lots of detailed comments in the C# code which should help demystify what is going on.

Discord: https://discord.gg/5dXwHjHN

Twitter: @saganite

Getting Started

  • Clone the repo.
  • Install Unity. Project is using Unity 2021.3.22f1 but any 2021 LTS or newer version will probably work.
  • Open the SampleProject. (From Unity Hub: Open -> Add Project From Disk -> Browse to SampleProject folder)
  • A "Perro" menu should appear in Unity, choose "Download Sample Model" to download the model and tokenizer files to StreamingAssets/Models. This is just a toy model to tell stories.
  • Open the "Sample Scene"
  • Run the scene!
  • The sample scene is setup to run two other models. Use the menu Perro -> Open Model Folder to see your models folder and then download the models from the links below:
  • Toggle the various Llama objects on/off to choose which model to run. A script will automatically make sure that only one is enabled if you try to run with multiples.

Known Issues

  • The Quadro M4000 (and very likely other Quadro cards) don't work.

Thank you Andrej Karpathy!!!

This project was inspired by Andrej Karpathy's excellent llama2.c project, and owes a huge dept to Andrej and all of his work he has done over the years to support LLM literacy. I find it so much easier to learn how something REALLY works when it is written in a simple language with no dependencies, rather than trying to peer through all the abstractions of higher level libraries like PyTorch. You will see that lots of the naming and overall code flow still owes a great deal to llama2.c, although things have already started to diverge quite a bit, and will diverge a lot more in the next few weeks as I make things a bit more conducive to real-time game execution.

If you are new to LLMs, I HIGHLY recommend his LLM Zero to Hero series on youtube, and especially the Building ChatGPT from Scratch video. If you already know c and aren't very familiar with compute shaders, you may find it easier to read through his llama2.c project first.

TODO

  • Support a few more ggml quantization formats (q4_1 and q5_m/s are the highest priority).
  • LOTS of easy optimizations in the existing kernels.
  • Add topk filtering.
  • Fuse compute kernels to reduce draw calls and intermediate memory usage.
  • Add support for Sentis when they support 8 bit quantization.
  • Implement asyncrhonous model loading to reduce memory usage during startup.
  • Add support for pipelined execution of multiple instances of the same model.
  • Add support for LoRA weights at inference time to enable multiple variations on one base model at runtime.