Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(llmobs): support annotating primitive prompt templates #10677

Merged
merged 17 commits into from
Sep 20, 2024

Conversation

lievan
Copy link
Contributor

@lievan lievan commented Sep 16, 2024

Support the ability for users to annotate prompt template data via the annotate function.

Users can pass in two types of objects as a prompt

  • a dictionary that adheres to our Prompt typed dict
  • importing ddtrace.llmobs.utils.Prompt and passing in the Prompt typed dict

Follow up: be able to pass in prompt template data to annotation_context

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

@lievan lievan marked this pull request as ready for review September 16, 2024 21:30
@lievan lievan requested review from a team as code owners September 16, 2024 21:30
@datadog-dd-trace-py-rkomorn
Copy link

datadog-dd-trace-py-rkomorn bot commented Sep 16, 2024

Datadog Report

Branch report: evan.li/prompt-v2
Commit report: 36fe0e1
Test service: dd-trace-py

✅ 0 Failed, 100 Passed, 850 Skipped, 1m 15.6s Total duration (13m 18.84s time saved)

Copy link
Contributor

github-actions bot commented Sep 16, 2024

CODEOWNERS have been resolved as:

releasenotes/notes/support-prompt-annotations-b8e406261197f61a.yaml     @DataDog/apm-python
ddtrace/llmobs/_constants.py                                            @DataDog/ml-observability
ddtrace/llmobs/_llmobs.py                                               @DataDog/ml-observability
ddtrace/llmobs/_trace_processor.py                                      @DataDog/ml-observability
ddtrace/llmobs/_utils.py                                                @DataDog/ml-observability
ddtrace/llmobs/utils.py                                                 @DataDog/ml-observability
tests/llmobs/test_llmobs_service.py                                     @DataDog/ml-observability
tests/llmobs/test_llmobs_trace_processor.py                             @DataDog/ml-observability

@pr-commenter
Copy link

pr-commenter bot commented Sep 16, 2024

Benchmarks

Benchmark execution time: 2024-09-20 12:36:06

Comparing candidate commit 370758e in PR branch evan.li/prompt-v2 with baseline commit 0d44103 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 356 metrics, 48 unstable metrics.

ddtrace/llmobs/_llmobs.py Outdated Show resolved Hide resolved
ddtrace/llmobs/_utils.py Outdated Show resolved Hide resolved
ddtrace/llmobs/_utils.py Outdated Show resolved Hide resolved
tests/llmobs/test_llmobs_service.py Outdated Show resolved Hide resolved
tests/llmobs/test_llmobs_service.py Outdated Show resolved Hide resolved
tests/llmobs/test_llmobs_service.py Outdated Show resolved Hide resolved
tests/llmobs/test_llmobs_service.py Outdated Show resolved Hide resolved
ddtrace/llmobs/_llmobs.py Outdated Show resolved Hide resolved
ddtrace/llmobs/_utils.py Outdated Show resolved Hide resolved
ddtrace/llmobs/_utils.py Outdated Show resolved Hide resolved
@lievan lievan enabled auto-merge (squash) September 19, 2024 20:57
@lievan lievan merged commit 6c8aadd into main Sep 20, 2024
556 of 557 checks passed
@lievan lievan deleted the evan.li/prompt-v2 branch September 20, 2024 13:17
mabdinur pushed a commit that referenced this pull request Sep 25, 2024
Support the ability for users to annotate prompt template data via the
annotate function.

Users can pass in two types of objects as a prompt
- a dictionary that adheres to our `Prompt` typed dict
- importing `ddtrace.llmobs.utils.Prompt` and passing in the `Prompt`
typed dict

Follow up: be able to pass in prompt template data to annotation_context

## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))



## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met 
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

---------

Co-authored-by: lievan <[email protected]>
Co-authored-by: Yun Kim <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants