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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix double callback injection issue with LangChain streaming #12037

Merged
merged 6 commits into from
May 18, 2024

Conversation

dbczumar
Copy link
Collaborator

@dbczumar dbczumar commented May 18, 2024

馃洜 DevTools 馃洜

Open in GitHub Codespaces

Install mlflow from this PR

pip install git+https://github.com/mlflow/mlflow.git@refs/pull/12037/merge

Checkout with GitHub CLI

gh pr checkout 12037

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Fix double callback injection issue with LangChain streaming

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/artifacts: Artifact stores and artifact logging
  • area/build: Build and test infrastructure for MLflow
  • area/deployments: MLflow Deployments client APIs, server, and third-party Deployments integrations
  • area/docs: MLflow documentation pages
  • area/examples: Example code
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/recipes: Recipes, Recipe APIs, Recipe configs, Recipe Templates
  • area/projects: MLproject format, project running backends
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/server-infra: MLflow Tracking server backend
  • area/tracking: Tracking Service, tracking client APIs, autologging

Interface

  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
  • area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
  • area/windows: Windows support

Language

  • language/r: R APIs and clients
  • language/java: Java APIs and clients
  • language/new: Proposals for new client languages

Integrations

  • integrations/azure: Azure and Azure ML integrations
  • integrations/sagemaker: SageMaker integrations
  • integrations/databricks: Databricks integrations

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?
  • Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
    Bug fixes, doc updates and new features usually go into minor releases.
  • Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
    Bug fixes and doc updates usually go into patch releases.
  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)

Signed-off-by: dbczumar <corey.zumar@databricks.com>
@github-actions github-actions bot added area/tracking Tracking service, tracking client APIs, autologging rn/none List under Small Changes in Changelogs. labels May 18, 2024
Copy link

github-actions bot commented May 18, 2024

Documentation preview for d865263 will be available when this CircleCI job
completes successfully.

More info

Signed-off-by: dbczumar <corey.zumar@databricks.com>
Comment on lines +895 to +897
assert (
sum(isinstance(handler, MlflowLangchainTracer) for handler in callbacks.handlers) == 1
)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This was previously 2, which was an error.

Technically, we shouldn't be mutating the list of callbacks that the user provides to the stream() call. In the interest of time, I'm adjusting this test for now and will file a ticket for fixing the erroneous modification of the user's callback list and adjust the test case

Comment on lines +268 to +271
if not _is_new_callback_already_in_original_callbacks(
callback, original_callbacks.handlers
):
original_callbacks.add_handler(callback)
Copy link
Collaborator Author

@dbczumar dbczumar May 18, 2024

Choose a reason for hiding this comment

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

We shouldn't be modifying original_callbacks either. Filed a follow-up ticket to fix that (autologging patch safety tooling doesn't allow a copy of the object to be used; we need to add an exemption for that)

@dbczumar dbczumar changed the title [WIP] Fix double callback injection issue with LangChain streaming Fix double callback injection issue with LangChain streaming May 18, 2024
@dbczumar dbczumar requested a review from serena-ruan May 18, 2024 06:38
Signed-off-by: dbczumar <corey.zumar@databricks.com>
Copy link
Collaborator

@serena-ruan serena-ruan left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for the fix!

Signed-off-by: Corey Zumar <39497902+dbczumar@users.noreply.github.com>
@dbczumar
Copy link
Collaborator Author

@mlflow-automation autoformat

@dbczumar
Copy link
Collaborator Author

Failures are unrelated. Merging.

@dbczumar dbczumar merged commit df0e3f2 into mlflow:master May 18, 2024
41 of 46 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/tracking Tracking service, tracking client APIs, autologging patch-2.12.3 rn/none List under Small Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants