Skip to main content

Ping pong is a management library for LLM applied applications.

Project description

PingPong

PingPong is a simple library to manage pings(prompt) and pongs(response). The main purpose of this library is to manage histories and contexts in LLM applied applications such as ChatGPT.

The basic motivations behind this project are:

  • Abstract prompt and response so that any UIs and Prompt formats can be adopted
    • There are a number of instruction-following finetuned language models, but they are fine-tuned with differently crafted datasets. For instance, the Alpaca dataset works when ### Instruction:, ### Response:, and ### Input: are given while StackLLaMA works when Question: and Answer: are given even though the underlying pre-trained LLM is the same LLaMA.
    • There are a number of UIs built to interact with language model such as Chatbot. Even with a single example of Chatbot, one could use Gradio while other could use JavaScript based tools, and they represents prompt histories in different data structure.
  • Abstract context management strategies to apply any number of context managements
    • There could be a number of strategies to effectively handle context due to the limit of the number of input tokens in language model(usually 4096). It is also possible to mix different strategies.

Installation

$ pip install bingbong

Example usage

from pingpong import PingPong
from pingpong.gradio import GradioAlpacaChatPPManager
from pingpong.context import CtxAutoSummaryStrategy
from pingpong.context import CtxLastWindowStrategy
from pingpong.context import CtxSearchWindowStrategy

ppmanager = GradioAlpacaChatPPManager()
strategies = [
    CtxAutoSummaryStrategy(2),
    CtxLastWindowStrategy(1),
    CtxSearchWindowStrategy(1)
]

for i in range(3):
    ppmanager.add_pingpong(PingPong(f"ping-{i}", f"pong-{i}"))

    for strategy in strategies:
        if isinstance(strategy, CtxAutoSummaryStrategy):
            sum_req, to_sum_prompt = strategy(ppmanager)

            if sum_req is True:
                # enough prompts are accumulated
                ...
        elif isinstance(strategy, CtxLastWindowStrategy):
            last_convs = strategy(ppmanager)

            # I am only interested in the last 1 conversations
            ...
        elif isinstance(strategy, CtxSearchWindowStrategy):
            for cur_win in strategy(ppmanager):
                # looking the entire conversation through
                # a sliding window, size of 1
                # find out relevant history to the recent conversation
                ...

Todos

  • Add a working example with Gradio application
  • Make the documentation more Beginner friendly

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

bingbong-0.4.3-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file bingbong-0.4.3-py3-none-any.whl.

File metadata

  • Download URL: bingbong-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for bingbong-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9a62de34cffff49f744b87adb40416d185af1740d72fd086ce1d56557178de88
MD5 c3981899105267fb2d01c33a6423da11
BLAKE2b-256 4135326a3aa0e075ddf9c14278d9d582edb47235a591d0aa72cdbdcf5ab38b1c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page