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

Create mlflow run for DSPy compile #14949

Merged
merged 6 commits into from
Mar 12, 2025

Conversation

TomeHirata
Copy link
Collaborator

@TomeHirata TomeHirata commented Mar 11, 2025

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

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

For Databricks, use the following command:

%sh
OPTIONS=$(if pip freeze | grep -q 'git+https://github.com/mlflow/mlflow.git'; then echo '--force-reinstall --no-deps'; fi)
pip install $OPTIONS git+https://github.com/mlflow/mlflow.git@refs/pull/14949/merge#subdirectory=skinny

Related Issues/PRs

N/A

What changes are proposed in this pull request?

This PR introduces new options to DSPy autologging:

  • log_compiles: create a run for each optimization and log program params
  • log_models: log models when an optimizer is called

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.

When mlflow.dspy.autolog is called with log_compiles, a mlflow run is created and program params are logged.

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: Tomu Hirata <tomu.hirata@gmail.com>
@github-actions github-actions bot requested review from B-Step62 and BenWilson2 March 11, 2025 11:00
@github-actions github-actions bot added the area/tracking Tracking service, tracking client APIs, autologging label Mar 11, 2025
@github-actions github-actions bot requested a review from daniellok-db March 11, 2025 11:00
@github-actions github-actions bot added the rn/feature Mention under Features in Changelogs. label Mar 11, 2025
@github-actions github-actions bot requested review from harupy, serena-ruan, WeichenXu123 and xq-yin and removed request for mlflow-automation March 11, 2025 11:00
Copy link

github-actions bot commented Mar 11, 2025

Documentation preview for f9e2270 will be available when this CircleCI job
completes successfully. You may encounter a {"message":"not found"} error when reloading
a page. If so, add /index.html to the URL.

More info

Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
Copy link
Member

@BenWilson2 BenWilson2 left a comment

Choose a reason for hiding this comment

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

Looks good!

@@ -37,6 +53,7 @@ def set_dependencies_schema(self, dependencies_schema: dict[str, Any]):
)
self._dependencies_schema = dependencies_schema

@skip_if_trace_disabled
Copy link
Collaborator

Choose a reason for hiding this comment

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

for me to understand - why do we need a second level of protection? I think we are controlling through autolog()

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We changed the bahavior of autolog so that we include the callback even when log_trace is off. Therefore, we need to add this protection.

Copy link
Collaborator

Choose a reason for hiding this comment

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

gotcha, correct me if I am wrong - my read is you want to allow users to only track compile() call, in which scenario we will only log to mlflow at the Evaluator.__call__ hook?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, the evaluation callback will have additional logging for optimization progression when called within compile

@@ -28,6 +42,8 @@ def __init__(self, dependencies_schema: Optional[dict[str, Any]] = None):
self._dependencies_schema = dependencies_schema
# call_id: (LiveSpan, OTel token)
self._call_id_to_span: dict[str, SpanWithToken] = {}
# used to determine the behavior of the evaluation callback
self._within_compile = False
Copy link
Collaborator

Choose a reason for hiding this comment

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

Seems this is not used in this PR? Could you help me understand the role of this variable? Are we going to use it to determine if evaluate should be put under a nested mlflow run?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, this attribute will be used to determine if the stack is in the compile process or not. We will have some custom logic in the evaluation when it's inside a compile.

Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
@TomeHirata TomeHirata force-pushed the feat/dspy/compile-run branch from 6876a31 to f9e2270 Compare March 12, 2025 04:12
@TomeHirata TomeHirata enabled auto-merge March 12, 2025 04:12
@TomeHirata TomeHirata added this pull request to the merge queue Mar 12, 2025
Merged via the queue into mlflow:master with commit 7a1e4e6 Mar 12, 2025
47 checks passed
@TomeHirata TomeHirata deleted the feat/dspy/compile-run branch March 12, 2025 05:01
BenWilson2 pushed a commit to BenWilson2/mlflow that referenced this pull request Mar 25, 2025
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
BenWilson2 pushed a commit that referenced this pull request Mar 25, 2025
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
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 rn/feature Mention under Features in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants