Skip to main content

Comet tool for logging and evaluating LLM traces

Project description

Comet Opik logo
Opik
Open-source end-to-end LLM Development Platform

Confidently evaluate, test and monitor LLM applications. 

WebsiteSlack communityTwitterDocumentation

Opik thumbnail

🚀 What is Opik?

Opik is an open-source platform for evaluating, testing and monitoring LLM applications. Built by Comet.


You can use Opik for:

  • Development:

    • Tracing: Track all LLM calls and traces during development and production (Quickstart, Integrations
    • Annotations: Annotate your LLM calls by logging feedback scores using the Python SDK or the UI.
  • Evaluation: Automate the evaluation process of your LLM application:

  • Production Monitoring: Monitor your LLM application in production and easily close the feedback loop by adding error traces to your evaluation datasets.


🛠️ Installation

The easiest way to get started with Opik is by creating a free Comet account at comet.com.

If you'd like to self-host Opik, you create a simple local version of Opik using::

pip install opik-installer

opik-server install

For more information about the different deployment options, please see our deployment guides:

Installation methods Docs link
Local instance All-in-one isntallation
Kubernetes Kubernetes

🏁 Get Started

If you are logging traces to the Cloud Opik platform, you will need to get your API key from the user menu and set it as the OPIK_API_KEY environment variable:

export OPIK_API_KEY=<Your API key>
export OPIK_WORKSPACE=<You workspace, often the same as your username>

If you are using a local Opik instance, you don't need to set the OPIK_API_KEY or OPIK_WORKSPACE environment variable and isntead set the environment variable OPIK_BASE_URL to point to your local Opik instance:

export OPIK_BASE_URL=http://localhost:5173

You are now ready to start logging traces using the Python SDK.

📝 Logging Traces

The easiest way to get started is to use one of our integrations. Opik supports:

Integration Description Documentation Try in Colab
OpenAI Log traces for all OpenAI LLM calls Documentation Open Quickstart In Colab
LangChain Log traces for all LangChain LLM calls Documentation Open Quickstart In Colab
LlamaIndex Log traces for all LlamaIndex LLM calls Documentation Open Quickstart In Colab

[!TIP]
If the framework you are using is not listed above, feel free to open an issue or submit a PR with the integration.

If you are not using any of the frameworks above, you can also using the track function decorator to log traces:

from opik import track

@track
def my_llm_function(user_question: str) -> str:
    # Your LLM code here

    return "Hello"

[!TIP]
The track decorator can be used in conjunction with any of our integrations and can also be used to track nested function calls.

🧑‍⚖️ LLM as a Judge metrics

The Python Opik SDK includes a number of LLM as a judge metrics to help you evaluate your LLM application. Learn more about it in the metrics documentation.

To use them, simply import the relevant metric and use the score function:

from opik.evaluation.metrics import Hallucination

metric = Hallucination()
score = metric.score(
    input="What is the capital of France?",
    output="Paris",
    context=["France is a country in Europe."]
)
print(score)

Opik also includes a number of pre-built heuristic metrics as well as the ability to create your own. Learn more about it in the metrics documentation.

🔍 Evaluating your LLM Application

Opik allows you to evaluate your LLM application during development through Datasets and Experiments.

You can also run evaluations as part of your CI/CD pipeline using our PyTest integration.

🤝 Contributing

There are many ways to contribute to Opik:

To learn more about how to contribute to Opik, please see our contributing guidelines.

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

opik-0.1.12.tar.gz (87.4 kB view details)

Uploaded Source

Built Distribution

opik-0.1.12-py3-none-any.whl (180.8 kB view details)

Uploaded Python 3

File details

Details for the file opik-0.1.12.tar.gz.

File metadata

  • Download URL: opik-0.1.12.tar.gz
  • Upload date:
  • Size: 87.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.6

File hashes

Hashes for opik-0.1.12.tar.gz
Algorithm Hash digest
SHA256 b5631c37820aed123331a3fb9ac9a92a3da040dbe350a3eb993300ffd3178062
MD5 49d02278ddd6a9ba10244162f02fe960
BLAKE2b-256 716c388de492a87675c545b8efe41512d7fe7b71d9de05b2fff940da0516d31a

See more details on using hashes here.

File details

Details for the file opik-0.1.12-py3-none-any.whl.

File metadata

  • Download URL: opik-0.1.12-py3-none-any.whl
  • Upload date:
  • Size: 180.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.6

File hashes

Hashes for opik-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 a30da344cedcb3ff4e1dc0f324a34b60a0930c4a65b6456da8caee79e989bbdd
MD5 89ff9c8aba3ce3ff3fea2829f287700e
BLAKE2b-256 942a878eda19396f1cd55276be0b20d6030d1d64a49e17b667c1dda67fae1ee0

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