Skip to main content

A simple framework to interact with conversational LLMs

Project description

PyPI - Downloads GitHub GitHub issues Discord Twitter Follow

Lobsang

Welcome to Lobsang 🧘‍♂️

Lobsang is a framework to interact with conversational LLMs in the simplest way possible.
It's easy to get started, yet designed to scale up to complex use cases. Enjoy the ride! 🚀

Note: This project is still in early development. Expect breaking changes.

Installation

Requires Python 3.11 or higher.

pip install lobsang

Core Concepts

Lobsang is built around a few core concepts:

  • Chat: The main class is the Chat class. It represents a conversation between a user and a LLM. It is the main entry point to the framework and stores the chat history for a single conversation. After creating a Chat instance, you can interact with it by calling itself with one or more messages:
    from lobsang import Chat
    from lobsang.llms import FakeLLM
    chat = Chat(llm=FakeLLM()) 
    #                 👆 FakeLLM returns dummy responses
    # Call the chat with one message
    chat("Hello!")
    chat("How are you?")
    print("Chat history:")  
    print(chat)
    
    # Call the chat with multiple messages
    res = chat.run(["What is 1+1?", "What is 2+2?"])
    print("Chat Snippet:")
    print(res)
    print("Full chat history:")
    print(chat)
    
    • Directives: Directives are used to guide the LLM to generate a specific response by embedding instructions in a corresponding message. For example, you can use the JSON directive to instruct the LLM to generate a JSON response (see examples/2_directives.ipynb for more details).

Examples

We provide a few examples to get you started. You can find them in the examples folder. The examples use the openai package, make sure to install it before running the examples (pip install openai). You will also need an OpenAI API key, which you can get here: https://platform.openai.com/account/api-keys.

Project details


Download files

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

Source Distribution

lobsang-0.0.5.tar.gz (26.3 kB view details)

Uploaded Source

Built Distribution

lobsang-0.0.5-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file lobsang-0.0.5.tar.gz.

File metadata

  • Download URL: lobsang-0.0.5.tar.gz
  • Upload date:
  • Size: 26.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for lobsang-0.0.5.tar.gz
Algorithm Hash digest
SHA256 41cfd0ae9642a6e8f3ca2f3dfb53c0ee04ed328099629bf55e0a388d7a83eced
MD5 63fac43999cd795b50e8a0f217d0cab4
BLAKE2b-256 73151cf356447fcb83b5b89397294bd9b76ead4e2d67ffa7ffc007f912d23901

See more details on using hashes here.

File details

Details for the file lobsang-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: lobsang-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for lobsang-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 672d94d5ab3a61c0672c108079b2ba13e5fd90ed2d7fbf3dc7c4c8a0bfbabdb8
MD5 72fb83d996baf234b8fc7b98728127b2
BLAKE2b-256 29a4a5e9dae1416e03db9014b600dd1eb22186ba04110f2e90789d13a5765dc9

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