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

Implement issue-5507 - add search_runs_by_name #5564

Merged
merged 5 commits into from
Apr 4, 2022

Conversation

r3stl355
Copy link
Contributor

@r3stl355 r3stl355 commented Mar 30, 2022

Signed-off-by: Nikolay Ulmasov ulmasov@hotmail.com

What changes are proposed in this pull request?

Implement a function that searches for runs given the experiment name

How is this patch tested?

Added 2 dedicated tests

Does this PR change the documentation?

  • No. You can skip the rest of this section.
  • [ x] Yes. Make sure the changed pages / sections render correctly by following the steps below.
  1. Check the status of the ci/circleci: build_doc check. If it's successful, proceed to the
    next step, otherwise fix it.
  2. Click Details on the right to open the job page of CircleCI.
  3. Click the Artifacts tab.
  4. Click docs/build/html/index.html.
  5. Find the changed pages / sections and make sure they render correctly.

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • [ x] Yes. Give a description of this change to be included in the release notes for MLflow users.
    Using newly added experiment_names in mlflow.search_runs allows searching for runs with a single call instead of callingmlflow.get_experiment_by_name followed by a call to mlflow.search_runs

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/docs: MLflow documentation pages
  • area/examples: Example code
  • [x ] area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • 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/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • 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
  • [ x] 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

Signed-off-by: Nikolay Ulmasov <ulmasov@hotmail.com>
@github-actions github-actions bot added area/artifacts Artifact stores and artifact logging area/model-registry Model registry, model registry APIs, and the fluent client calls for model registry rn/feature Mention under Features in Changelogs. labels Mar 30, 2022
mlflow/tracking/fluent.py Outdated Show resolved Hide resolved
refactor tests

update docs

Signed-off-by: Nikolay Ulmasov <ulmasov@hotmail.com>
@github-actions github-actions bot removed area/artifacts Artifact stores and artifact logging rn/feature Mention under Features in Changelogs. labels Apr 1, 2022
@r3stl355
Copy link
Contributor Author

r3stl355 commented Apr 1, 2022

Is there a way to re-run the job? ci/circleci: build_doc job failed but I don't see what's wrong there. Same happened on my mac - it failed on first run but was OK on the subsequent few runs with or without additional changes

@BenWilson2
Copy link
Member

The doc string failed to resolve with Sphinx:

/home/circleci/project/mlflow/init.py:docstring of mlflow.tracking.fluent.search_runs:3: WARNING: Inline literal start-string without end-string.
/home/circleci/project/mlflow/init.py:docstring of mlflow.tracking.fluent.search_runs:21: WARNING: Inline literal start-string without end-string.

You can troubleshoot locally by navigating to the docs directory and run:

make clean
make rsthtml SPHINXOPTS="-W --keep-going -n -T" 

Although the -T handle won't help you much for debugging since the parsing error is a native rst parse failure (top level error). Typically this is due to not having a blank line surrounding code blocks OR due to a :ref: that isn't declared correctly.

Signed-off-by: Nikolay Ulmasov <ulmasov@hotmail.com>
@github-actions github-actions bot added the rn/feature Mention under Features in Changelogs. label Apr 1, 2022
Signed-off-by: Nikolay Ulmasov <ulmasov@hotmail.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.

Thanks for the changes! LGTM!

Copy link
Collaborator

@dbczumar dbczumar left a comment

Choose a reason for hiding this comment

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

LGTM with one tiny docs comment. Thanks a bunch, @r3stl355 !

Signed-off-by: Nikolay Ulmasov <ulmasov@hotmail.com>
@r3stl355
Copy link
Contributor Author

r3stl355 commented Apr 2, 2022

all the changes implemented, ready to merge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/model-registry Model registry, model registry APIs, and the fluent client calls for model registry rn/feature Mention under Features in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants