Skip to main content

LLMTracer: A tool to trace the execution of a program that uses LLMs and visualize the results.

Project description

LLMTracer

Twitter Follow pypi python Build Status codecov License

A simple (opinionated) library to trace calls to an LLM model (and more) with some batteries included:

  • simple @trace_calls decorator;
  • FlameCharts;
  • Pynecone web app (local) to stream the output to a web browser at runtime and/or explore saved JSON files
  • JSON output;
  • interactive SVG output;
  • WandB integration (public example here);

The big difference to just using WandB is that the app supports live-streaming while WandB waits for the full calls to finish before making them available. Useful for the impatient among us.

Motivation

WandB only supports showing finished traces but I wanted to be able to view them in real-time (at finer granularity).

Further, I want to make it easier to explore nested and complex calls and display properties of the calls.

Installation

Node.JS

To be able to run the web app, first, make sure you have Node.js installed. You can use conda to install Node.js as follows:

conda install -c conda-forge nodejs

Or, to install a specific version of Node.js (this one worked for me on my MacBook---so this will not work on Linux):

conda install -c conda-forge nodejs=18.15.0=h26a3f6d_0

LLMTracer & race Viewer

Once Node.js is installed, you can install LLMTracer using pip (if you have nodejs available in your base environment):

pip install llmtracer

To run the trace viewer which can load both saved JSON traces and live-streamed traces, run:

llmtraceviewer

Usage:

A simple example:

from time import sleep

import wandb

from llmtracer import (
    JsonFileWriter,
    TraceViewerIntegration,
    trace_calls,
    wandb_tracer,
)
from llmtracer.handlers.svg_writer import SvgFileWriter


@trace_calls(capture_args=True, capture_return=True)
def add_values(a: int, b: int):
    # sleep 1 second
    sleep(1)

    return a + b


@trace_calls(capture_args=True, capture_return=True)
def fibonacci(n: int):
    if n <= 1:
        return 1
    return add_values(fibonacci(n - 1), fibonacci(n - 2))


wandb.init(project="llmtracer", name="simple_example")

event_handlers = [
    JsonFileWriter("simple_example.json"),
    SvgFileWriter("simple_example.svg"),
    TraceViewerIntegration(),
]

with wandb_tracer(
    "main", stack_frame_context=0, event_handlers=event_handlers
) as trace_builder:
    print(fibonacci(10))

Screenshots

Example

https://github.com/BlackHC/llmtracer/assets/729312/c77faa7d-a831-496c-b791-8822577391e5

WandB Example

SVG Example

JSON Example

Documentation

Contributing

Bug fixes, feature requests, and pull requests are welcome! If you have any questions or suggestions, please open an issue on GitHub.

License

LLMTracer is licensed under AGPL3.0. If you require a commercial license for any part of the project, please contact the author.

Credits

This package was created using PyneCone with Cookiecutter and the waynerv/cookiecutter-pypackage project template.

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

llmtracer-2.0.0.tar.gz (91.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

llmtracer-2.0.0-py3-none-any.whl (76.0 kB view details)

Uploaded Python 3

File details

Details for the file llmtracer-2.0.0.tar.gz.

File metadata

  • Download URL: llmtracer-2.0.0.tar.gz
  • Upload date:
  • Size: 91.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.4 Darwin/23.1.0

File hashes

Hashes for llmtracer-2.0.0.tar.gz
Algorithm Hash digest
SHA256 cf7ec4c73634d5f294175540d0862fbba6023678f11f48f555d434181e04d669
MD5 bc75af9c2a4eee02fcfd2c9be06ae49e
BLAKE2b-256 83e8b9740114104a5436b02508e4e28995523321ff061be87b1f30845e6d7cd7

See more details on using hashes here.

File details

Details for the file llmtracer-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: llmtracer-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 76.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.4 Darwin/23.1.0

File hashes

Hashes for llmtracer-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e78b7f9034c09dccf7d6b43c549f76ca6af2d2373c562b889994d98fe2783a1b
MD5 22546c9b6f1c6d9fa2dfcf84bd8d3024
BLAKE2b-256 218e986c5b223c25ebc5a62fb819cdd6d568302aa9228a08f30d55118db628b5

See more details on using hashes here.

Supported by

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