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

chore(llmobs): [MLOB-2093] remove deprecated parameters arg from annotate method #12085

Merged
merged 4 commits into from
Jan 28, 2025

Conversation

ncybul
Copy link
Contributor

@ncybul ncybul commented Jan 24, 2025

Deprecates the parameters arg for the LLMObs annotation method in favor of metadata.

I verified this change by running the following code:

@workflow
def run():
    LLMObs.annotate(
        input_data="hello",
        output_data="bye",
        parameters={"example": True},
    )
    return None

run()

Which produced the following error as expected: TypeError: LLMObs.annotate() got an unexpected keyword argument 'parameters'.

Replacing parameters with metadata resolves the issue:

image

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

Copy link
Contributor

github-actions bot commented Jan 24, 2025

CODEOWNERS have been resolved as:

releasenotes/notes/remove-llmobs-parameters-annotation-97406f9cece3fac4.yaml  @DataDog/apm-python
ddtrace/llmobs/_constants.py                                            @DataDog/ml-observability
ddtrace/llmobs/_llmobs.py                                               @DataDog/ml-observability
tests/llmobs/_utils.py                                                  @DataDog/ml-observability
tests/llmobs/test_llmobs.py                                             @DataDog/ml-observability
tests/llmobs/test_llmobs_decorators.py                                  @DataDog/ml-observability
tests/llmobs/test_llmobs_service.py                                     @DataDog/ml-observability

@datadog-dd-trace-py-rkomorn
Copy link

Datadog Report

Branch report: nicole-cybul/remove-parameter-arg-from-annotate
Commit report: dee2c2d
Test service: dd-trace-py

✅ 0 Failed, 130 Passed, 1468 Skipped, 4m 45.52s Total duration (36m 17.1s time saved)

@pr-commenter
Copy link

pr-commenter bot commented Jan 24, 2025

Benchmarks

Benchmark execution time: 2025-01-28 18:35:17

Comparing candidate commit f67b03e in PR branch nicole-cybul/remove-parameter-arg-from-annotate with baseline commit 48c6547 in branch main.

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

@ncybul ncybul closed this Jan 28, 2025
@ncybul ncybul reopened this Jan 28, 2025
@ncybul ncybul changed the title feat(llmobs)!: remove deprecated parameters arg from annotate method feat(llmobs)!: [MLOB-2093] remove deprecated parameters arg from annotate method Jan 28, 2025
@ncybul ncybul marked this pull request as ready for review January 28, 2025 17:40
@ncybul ncybul requested review from a team as code owners January 28, 2025 17:40
@ncybul ncybul requested review from lievan and nsrip-dd January 28, 2025 17:40
@Yun-Kim Yun-Kim changed the title feat(llmobs)!: [MLOB-2093] remove deprecated parameters arg from annotate method chore(llmobs): [MLOB-2093] remove deprecated parameters arg from annotate method Jan 28, 2025
Copy link
Member

@Kyle-Verhoog Kyle-Verhoog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just remember to change the base branch to 3.x-staging 😄

@ncybul ncybul changed the base branch from main to 3.x-staging January 28, 2025 19:11
@ncybul ncybul merged commit bf15c90 into 3.x-staging Jan 28, 2025
253 checks passed
@ncybul ncybul deleted the nicole-cybul/remove-parameter-arg-from-annotate branch January 28, 2025 19:12
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.

3 participants