neoxelox / dspy-inspector

DSPy program/pipeline inspector widget for Jupyter/VSCode Notebooks.

dspy-inspector 🔍

DSPy program/pipeline inspector widget for Jupyter/VSCode Notebooks. 🔭

Note: DSPy is going through a big refactor at this moment. Updates in the parsing logic are going to be halted in the meantime.

Dark theme is coming soon™.

Install

👉 pip install dspy-inspector

Usage

from dspy_inspector import inspect

class MultiHopRAG(dspy.Module):
    def __init__(self, passages_per_hop=3, max_hops=2):
        ...

    def forward(self, question):
        ...

inspect(MultiHopRAG)

# Or 👇

program = MultiHopRAG()
inspect(program) # Automatically updates
program("How many storeys are in the castle that David Gregory inherited?")

Check an example in the multi_hop_rag.ipynb notebook.

All example notebooks are cached, no calls to LLMs are needed to run them.

Roadmap

This is a personal project I made to better understand what were my DSPy programs actually doing underneath. This extension is currently in BETA, so, expect bugs. For a roadmap on what things must be fixed or done check all the TODOs inside the source code.

Developing

To setup the virtual developing environment, follow these steps:

1. Install dependencies: poetry install
2. Install tools: poetry run inv tool.install --include "dev*"
3. Create kernel: poetry run python -m ipykernel install --user --name dspy-inspector --display-name "DSPy Inspector"
4. Select dspy-inspector kernel in all notebooks

Run poetry run inv help for further commands and poetry run inv <command> --help for their usage.

Contribute

Feel free to contribute to this project : ) .

License

This project is licensed under the GPL-3.0 License - read the LICENSE file for details.

dspy-inspector's Issues

[BUG]: AttributeError: module 'dspy' has no attribute 'AzureOpenAI'

Impact

Hinder: It obstructs me to do what I want

Description

I am using dspy.AzureOpenAI with dspy-ai-2.4.0 There's a conflict with the specified version in the toml file

dspy-ai = "2.1.10"
Error: AttributeError: module 'dspy' has no attribute 'AzureOpenAI'

Please update the dspy-ai version in the toml file. Thank you.

Steps To Reproduce

In your terminal:

pip install dspy-ai
pip install dspy-inspector

Run Python code:

import dspy

api_key = 'api-key'
base = 'api-base'
engine = 'gpt-4'
version = '2024-02-15-preview'

llm = dspy.AzureOpenAI(model=engine, api_key=api_key, api_base=base, api_version=version, model_type="chat")

dspy.settings.configure(lm=llm)

Additional Information

No response