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

Add a page for search_traces #14033

Merged
merged 5 commits into from
Dec 11, 2024
Merged

Conversation

TomeHirata
Copy link
Collaborator

@TomeHirata TomeHirata commented Dec 10, 2024

Related Issues/PRs

N/A

What changes are proposed in this pull request?

This PR create a new page for the usage of the mlflow.search_traces and MlflowClient.search_traces API.

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)

@TomeHirata TomeHirata requested a review from B-Step62 December 10, 2024 06:49
Copy link

github-actions bot commented Dec 10, 2024

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

More info

@TomeHirata TomeHirata marked this pull request as ready for review December 10, 2024 07:06
@TomeHirata TomeHirata changed the title add a page for search traces Add a page for search_traces Dec 10, 2024
@github-actions github-actions bot added rn/none List under Small Changes in Changelogs. rn/documentation Mention under Documentation Changes in Changelogs. and removed rn/none List under Small Changes in Changelogs. labels Dec 10, 2024
Signed-off-by: TomuHirata <[email protected]>
docs/source/llms/tracing/index.rst Show resolved Hide resolved
docs/source/llms/tracing/search-traces.rst Show resolved Hide resolved
docs/source/llms/tracing/search-traces.rst Outdated Show resolved Hide resolved
client = MlflowClient()

client.search_traces(experiment_ids=[morning_experiment.experiment_id])
# Returns Trace #1
Copy link
Collaborator

Choose a reason for hiding this comment

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

Instead of "Trace #1", can we actually show the screenshot (or equivalent ascii) for the retuned object of each API? This might be a bit confusing because it looks like they return the same object.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sure, I guess putting screenshots every time is probably noisy, let me add some ascii to make it different.

docs/source/llms/tracing/search-traces.rst Outdated Show resolved Hide resolved
docs/source/llms/tracing/search-traces.rst Show resolved Hide resolved
docs/source/llms/tracing/search-traces.rst Outdated Show resolved Hide resolved
request_id ... morning_greeting.inputs morning_greeting.outputs
0 053adf2f5f5e4ad68d432e06e254c8a4 ... {'name': 'Tom'} 'Good morning Tom.'

Lastly, you can convert the pandas DataFrame to the MLflow LLM evaluation dataset format and evaluate your language model.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thank you for adding this example!

docs/source/llms/tracing/search-traces.rst Outdated Show resolved Hide resolved
docs/source/llms/tracing/search-traces.rst Outdated Show resolved Hide resolved
@TomeHirata
Copy link
Collaborator Author

@B-Step62 Thank you for the review. I've addressed your comments, can you take another look?

Copy link
Collaborator

@B-Step62 B-Step62 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 addition!

docs/source/llms/tracing/search-traces.rst Outdated Show resolved Hide resolved
docs/source/llms/tracing/search-traces.rst Outdated Show resolved Hide resolved
docs/source/llms/tracing/search-traces.rst Outdated Show resolved Hide resolved
Signed-off-by: TomuHirata <[email protected]>
@TomeHirata TomeHirata enabled auto-merge December 11, 2024 08:51
@TomeHirata TomeHirata added this pull request to the merge queue Dec 11, 2024
Merged via the queue into mlflow:master with commit ef7129b Dec 11, 2024
42 checks passed
@TomeHirata TomeHirata deleted the doc/search-traces branch December 11, 2024 09:40
@B-Step62 B-Step62 mentioned this pull request Dec 12, 2024
39 tasks
karthikkurella pushed a commit to karthikkurella/mlflow that referenced this pull request Jan 30, 2025
Signed-off-by: TomuHirata <[email protected]>
Signed-off-by: k99kurella <[email protected]>
karthikkurella pushed a commit to karthikkurella/mlflow that referenced this pull request Jan 30, 2025
Signed-off-by: TomuHirata <[email protected]>
Signed-off-by: k99kurella <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn/documentation Mention under Documentation Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants