Skip to main content
`Ctrl`+`K`

# Aim

Aim makes it super easy to visualize and debug LangChain executions. Aim tracks inputs and outputs of LLMs and tools, as well as actions of agents.

With Aim, you can easily debug and examine an individual execution:

Additionally, you have the option to compare multiple executions side by side:

Aim is fully open source, learn more about Aim on GitHub.

Let’s move forward and see how to enable and configure Aim callback.

### Tracking LangChain Executions with Aim

In this notebook we will explore three usage scenarios. To start off, we will install the necessary packages and import certain modules. Subsequently, we will configure two environment variables that can be established either within the Python script or through the terminal.

    !pip install aim
    !pip install langchain
    !pip install openai
    !pip install google-search-results

    import os
    from datetime import datetime

    from langchain.llms import OpenAI
    from langchain.callbacks.base import CallbackManager
    from langchain.callbacks import AimCallbackHandler, StdOutCallbackHandler

Our examples use a GPT model as the LLM, and OpenAI offers an API for this purpose. You can obtain the key from the following link: https://platform.openai.com/account/api-keys .

We will use the SerpApi to retrieve search results from Google. To acquire the SerpApi key, please go to https://serpapi.com/manage-api-key .

    os.environ["OPENAI_API_KEY"] = "..."
    os.environ["SERPAPI_API_KEY"] = "..."

The event methods of `AimCallbackHandler` accept the LangChain module or agent as input and log at least the prompts and generated results, as well as the serialized version of the LangChain module, to the designated Aim run.

    session_group = datetime.now().strftime("%m.%d.%Y_%H.%M.%S")
    aim_callback = AimCallbackHandler(
        repo=".",
        experiment_name="scenario 1: OpenAI LLM",
    )

    manager = CallbackManager([StdOutCallbackHandler(), aim_callback])
    llm = OpenAI(temperature=0, callback_manager=manager, verbose=True)

The `flush_tracker` function is used to record LangChain assets on Aim. By default, the session is reset rather than being terminated outright.

### Scenario 1

In the first scenario, we will use OpenAI LLM.

    # scenario 1 - LLM
    llm_result = llm.generate(["Tell me a joke", "Tell me a poem"] * 3)
    aim_callback.flush_tracker(
        langchain_asset=llm,
        experiment_name="scenario 2: Chain with multiple SubChains on multiple generations",
    )

### Scenario 2

Scenario two involves chaining with multiple SubChains across multiple generations.

    from langchain.prompts import PromptTemplate
    from langchain.chains import LLMChain

    # scenario 2 - Chain
    template = """You are a playwright. Given the title of play, it is your job to write a synopsis for that title.
    Title: {title}
    Playwright: This is a synopsis for the above play:"""
    prompt_template = PromptTemplate(input_variables=["title"], template=template)
    synopsis_chain = LLMChain(llm=llm, prompt=prompt_template, callback_manager=manager)

    test_prompts = [
        {"title": "documentary about good video games that push the boundary of game design"},
        {"title": "the phenomenon behind the remarkable speed of cheetahs"},
        {"title": "the best in class mlops tooling"},
    ]
    synopsis_chain.apply(test_prompts)
    aim_callback.flush_tracker(
        langchain_asset=synopsis_chain, experiment_name="scenario 3: Agent with Tools"
    )

### Scenario 3

The third scenario involves an agent with tools.

    from langchain.agents import initialize_agent, load_tools
    from langchain.agents import AgentType

    # scenario 3 - Agent with Tools
    tools = load_tools(["serpapi", "llm-math"], llm=llm, callback_manager=manager)
    agent = initialize_agent(
        tools,
        llm,
        agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION,
        callback_manager=manager,
        verbose=True,
    )
    agent.run(
        "Who is Leo DiCaprio's girlfriend? What is her current age raised to the 0.43 power?"
    )
    aim_callback.flush_tracker(langchain_asset=agent, reset=False, finish=True)

    > Entering new AgentExecutor chain...
     I need to find out who Leo DiCaprio's girlfriend is and then calculate her age raised to the 0.43 power.
    Action: Search
    Action Input: "Leo DiCaprio girlfriend"
    Observation: Leonardo DiCaprio seemed to prove a long-held theory about his love life right after splitting from girlfriend Camila Morrone just months ...
    Thought: I need to find out Camila Morrone's age
    Action: Search
    Action Input: "Camila Morrone age"
    Observation: 25 years
    Thought: I need to calculate 25 raised to the 0.43 power
    Action: Calculator
    Action Input: 25^0.43
    Observation: Answer: 3.991298452658078

    Thought: I now know the final answer
    Final Answer: Camila Morrone is Leo DiCaprio's girlfriend and her current age raised to the 0.43 power is 3.991298452658078.

    > Finished chain.