Giter Club home page Giter Club logo

koboldcpp's Introduction

koboldcpp (formerly llamacpp-for-kobold)

A self contained distributable from Concedo that exposes llama.cpp function bindings, allowing it to be used via a simulated Kobold API endpoint.

What does it mean? You get llama.cpp with a fancy UI, persistent stories, editing tools, save formats, memory, world info, author's note, characters, scenarios and everything Kobold and Kobold Lite have to offer. In a tiny package around 10 MB in size, excluding model weights.

Preview

Highlights

  • This repo is somehow being flagged by Smartscreen in Microsoft Edge! I have no idea why, and it works fine in Chrome and Firefox. To be clear: Everything in this project is freely auditable and can be fully built from source code, any malware alerts are false positives! If you encounter such warnings, I'd appreciate it if you helped mark it as a false positive/safe to Microsoft.
  • Now has BACKWARDS COMPATIBILITY with ALL 3 versions of GGML LLAMA models, all ALPACA.CPP models, all versions of GPT4ALL.CPP models, and can run GGML older GPT-J.CPP models too. I also use a bunch of tricks to make subsequent prompt processing with shared ancestry much faster than the parent repo does.

Usage

  • Download the latest release here or clone the repo.
  • Windows binaries are provided in the form of koboldcpp.exe, which is a pyinstaller wrapper for koboldcpp.dll and koboldcpp.py. If you feel concerned, you may prefer to rebuild it yourself with the provided makefiles and scripts.
  • Weights are not included, you can use the quantize.exe to generate them from your official weight files (or download them from other places).
  • To run, execute koboldcpp.exe or drag and drop your quantized ggml_model.bin file onto the .exe, and then connect with Kobold or Kobold Lite.
  • By default, you can connect to http://localhost:5001
  • You can also run it using the command line koboldcpp.exe [ggml_model.bin] [port]. For info, please check koboldcpp.exe --help
  • If you are having crashes or issues with OpenBLAS, please try the --noblas flag.

OSX and Linux

  • You will have to compile your binaries from source. A makefile is provided, simply run make
  • If you want you can also link your own install of OpenBLAS manually with make LLAMA_OPENBLAS=1
  • After all binaries are built, you can run the python script with the command koboldcpp.py [ggml_model.bin] [port]

Considerations

  • Don't want to use pybind11 due to dependencies on MSVCC
  • ZERO or MINIMAL changes as possible to parent repo files - do not move their function declarations elsewhere! We want to be able to update the repo and pull any changes automatically.
  • No dynamic memory allocation! Setup structs with FIXED (known) shapes and sizes for ALL output fields. Python will ALWAYS provide the memory, we just write to it.
  • No external libraries or dependencies. That means no Flask, Pybind and whatever. All You Need Is Python.
  • Since v1.0.6, requires libopenblas, the prebuilt windows binaries are included in this repo. If not found, it will fall back to a mode without BLAS.
  • I plan to keep backwards compatibility with ALL past llama.cpp AND alpaca.cpp models. But you are also encouraged to reconvert/update your models if possible for best results.

License

  • The original GGML library and llama.cpp by ggerganov are licensed under the MIT License
  • However, Kobold Lite is licensed under the AGPL v3.0 License
  • The provided python ctypes bindings in koboldcpp.dll are also under the AGPL v3.0 License

Notes

  • Generation delay scales linearly with original prompt length. See this discussion. If OpenBLAS is enabled then prompt ingestion becomes about 2-3x faster. This is automatic on windows, but will require linking on OSX and Linux.
  • I have heard of someone claiming a false AV positive report. The exe is a simple pyinstaller bundle that includes the necessary python scripts and dlls to run. If this still concerns you, you might wish to rebuild everything from source code using the makefile, and you can rebuild the exe yourself with pyinstaller by using make_pyinstaller.bat

koboldcpp's People

Contributors

ggerganov avatar lostruins avatar anzz1 avatar slaren avatar sw avatar prusnak avatar tjohnman avatar blackhole89 avatar green-sky avatar gjmulder avatar herpderptestdeleteme avatar etra0 avatar ronsor avatar mqy avatar eiz avatar jart avatar razelighter777 avatar j-f1 avatar ivanstepanovftw avatar glinscott avatar ameobea avatar thement avatar rabidcopy avatar nusu-github avatar hoangmit avatar siraben avatar bernatvadell avatar bitrake avatar at8u avatar beiller avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.