Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tinybiggames/lmengine

Local LLM Inference
https://github.com/tinybiggames/lmengine

c cpp indiedev library llamacpp llm-inference pascal win64 windows-10 windows-11

Last synced: 7 days ago
JSON representation

Local LLM Inference

Host: GitHub
URL: https://github.com/tinybiggames/lmengine
Owner: tinyBigGAMES
License: bsd-3-clause
Created: 2024-05-14T20:23:26.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-06-15T17:19:48.000Z (4 months ago)
Last Synced: 2024-09-22T19:02:11.064Z (11 days ago)
Topics: c, cpp, indiedev, library, llamacpp, llm-inference, pascal, win64, windows-10, windows-11
Language: C
Homepage:
Size: 18 MB
Stars: 22
Watchers: 5
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        ![LMEngine](media/LMEngine.jpg)

[![Chat on Discord](https://img.shields.io/discord/754884471324672040.svg?logo=discord)](https://discord.gg/tPWjMwK) [![Twitter Follow](https://img.shields.io/twitter/follow/tinyBigGAMES?style=social)](https://twitter.com/tinyBigGAMES)

# LMEngine

###  Overview

Welcome to LMEngine. We are pleased to introduce you to our versatile and user-friendly library, designed to facilitate local LLM inference across various programming languages. Whether you are a seasoned developer or just beginning your journey, LMEngine offers a straightforward solution to integrate advanced language model capabilities into your applications with ease. 

The library maintains a minimal overhead of approximately 2.5MB. The API is highly flexible, enabling inference execution through the `LME_RunInference` function, which completes the process and returns the results. Users can define callbacks for customization.

LMEngine provides out-of-the-box bindings for Pascal and C/C++, featuring a straightforward procedural API that facilitates the creation of bindings for additional languages.

This library efficiently loads LLMs in [GGUF format](https://huggingface.co/docs/hub/gguf) into CPU or GPU memory, utilizing a [Vulkan backend](https://en.wikipedia.org/wiki/Vulkan) for enhanced processing speed.

###  Installation

- [Download](https://github.com/tinyBigGAMES/LMEngine/archive/refs/heads/main.zip) the LMEngine repo, unzip to a desired location.

- Acquire a GGUF model. All vetted models compatible with LMEngine can be downloaded from our Hugging Face account.

- The library utilizes Vulkan for enhanced performance on supported GPUs. You can perform inference solely on the GPU or distribute the workload between the CPU and GPU to accommodate scenarios with limited VRAM (this split functionality will be available in a future update). Ensure the model size does not exceed the available system resources, considering the requisite memory.

- Consult the `installdir\examples` directory for demonstrations on integrating **LMEngine** with your programming language.

- Include the following DLLs in your project distribution: `LMEngine.dll`. See [VirusTotal Report](bin/LMEngine.dll.VirusTotal.txt) report.

- LMEngine API supports integration across programming languages that accommodate Win64 and Unicode, with out-of-the-box support for Pascal and C/C++.

- Ship-ready DLLs are included in the repository; however, if there is a need to rebuild the `LMEngine.dll`, [RAD Studio 12.1](https://www.embarcadero.com/products/rad-studio/) is required.

- This project is developed using RAD Studio 12.1, on Windows 11, powered by an Intel Core i5-12400F at 2500 MHz with 6 cores (12 logical), equipped with 36GB RAM and an NVIDIA RTX 3060 GPU with 12GB RAM.

- We encourage testing and welcome pull requests.

- If you find this project beneficial, please consider starring the repository, sponsoring, or promoting it. Your support is invaluable and highly appreciated.

###  Examples  

Pascal example:

```Pascal   

uses

  SysUtils,

  LMEngine;

begin

  // init

  LME_InitConfigt('C:/LLM/gguf', -1);

  

  // define model

  LME_DefineModel('phi-3-mini-4k-instruct.Q4_K_M.gguf',

    'phi-3-mini-4k-instruct.Q4_K_M', 4000, '<|{role}|>{content}<|end|>',

    '<|assistant|>');  

  

  // add message

  LME_AddMessage(LME_ROLE_SYSTEM, 'You are a helpful AI assistant');

  LME_AddMessage(LME_ROLE_USER, 'What is AI?');

    

  if not LME_LoadModel('phi-3-mini-4k-instruct.Q4_K_M') then

  begin

    LME_PrintLn('Error: %s', LME_FG_RED, LME_GetError());

    Exit;

  end;    

    

  // do inference

  if LME_RunInference('phi-3-mini-4k-instruct.Q4_K_M', 1024) then

    begin

      // success

    end

  else

    begin

      // error

    end;

  // unload model  

  LME_UnloadModel();

end.

```  

C/CPP Example  

```CPP  

#include 

int main()

{

    // init

    LME_InitConfig(L"C:/LLM/gguf", -1);

    

    // define model

    LME_DefineModel(L"phi-3-mini-4k-instruct.Q4_K_M.gguf",

      L"phi-3-mini-4k-instruct.Q4_K_M", 4000, L"<|{role}|>{content}<|end|>",

      L"<|assistant|>");  

    

    // add message

    LME_AddMessage(LME_ROLE_SYSTEM, L"You are a helpful AI assistant");

    LME_AddMessage(LME_ROLE_USER, L"What is AI?");

    

    if (!LME_LoadModel(L"phi-3-mini-4k-instruct.Q4_K_M"))

    {

        LME_PrintLn(L"Error: %s", LME_FG_RED, LME_GetError());

        return 1;

    }

    

    // do inference

    if (LME_RunInference(L'phi-3-mini-4k-instruct.Q4_K_M', 1024))

    {

        // success

    }

    else

    {

        // error

    }

    

    // unload model  

    LME_UnloadModel();

    return 0;

}

```

###  Media

LMEngine in C/C++

https://github.com/tinyBigGAMES/LMEngine/assets/69952438/28a4fb0e-8c65-4980-81b6-181a2b7df57a

LMEngine in Pascal

https://github.com/tinyBigGAMES/LMEngine/assets/69952438/49fa3147-3fd7-4903-8b4a-cfeb4db08ca9

###  Support

Our development motto: 

- We will not release products that are buggy, incomplete, adding new features over not fixing underlying issues.

- We will strive to fix issues found with our products in a timely manner.

- We will maintain an attitude of quality over quantity for our products.

- We will establish a great rapport with users/customers, with communication, transparency and respect, always encouragingng feedback to help shape the direction of our products.

- We will be decent, fair, remain humble and committed to the craft.

###  Links

- Issues

- Discussions

- Facebook Group

- Discord

- Reddit

- YouTube

- X (Twitter)

- tinyBigGAMES

###  License

LMEngine is a community-driven project created by tinyBigGAMES LLC.

BSD-3-Clause license - Core developers:

- Jarrod Davis

###  Acknowledgments

LMEngine couldn't have been built without the help of wonderful people and great software already available from the community. **Thank you!**

Software

- [llama.cpp](https://github.com/ggerganov/llama.cpp)

- [SQLite](https://github.com/sqlite/sqlite)

- [sqlite-vec](https://github.com/asg017/sqlite-vec)

- [sqlite-lembed](https://github.com/asg017/sqlite-lembed)

People

- John Claw

- Robert Jalarvo

Contributors