bugfix: Update documentation to fix KeyError in demo code in quickstart

[wllgrnt]

🛠 DevTools 🛠

Install mlflow from this PR

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

Checkout with GitHub CLI

gh pr checkout 10540

Related Issues/PRs

Resolve #10539

What changes are proposed in this pull request?

Updates the documentation so that the demo code here doesn't throw a KeyError when run.

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.

This one-liner change updates the hyperopt usage example code in the quickstart documentaion so that the correct variable is referenced when logging the best tensorflow model.

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
• area/gateway: AI Gateway service, Gateway client APIs, third-party Gateway integrations
• 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

[github-actions]

@wllgrnt Thank you for the contribution! Could you fix the following issue(s)?

⚠ DCO check

The DCO check failed. Please sign off your commit(s) by following the instructions here. See https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#sign-your-work for more details.

[github-actions]

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

More info

• Ignore this comment if this PR does not change the documentation.
• It takes a few minutes for the preview to be available.
• The preview is updated when a new commit is pushed to this PR.
• This comment was created by https://github.com/mlflow/mlflow/actions/runs/7049691955.

[B-Step62]

@wllgrnt LGTM! Thank you so much for catching this issue and proactively making the fix! Will merge once all CI tests passed.

[B-Step62]

fyi: it seems some jobs were stuck, closed and re-opend to trigger them

[B-Step62]

@wllgrnt Very weird but some jobs are still not executing. Could you run followings to force triggering them again? While it seems to be an intermittent issue in Github, I can investigate if that happens again. Thanks!

$ git commit -sm --amend --no-edit   
$ git push origin HEAD -f

[chenmoneygithub]

Thanks for the PR!

[wllgrnt]

@wllgrnt Very weird but some jobs are still not executing. Could you run followings to force triggering them again? While it seems to be an intermittent issue in Github, I can investigate if that happens again. Thanks!

$ git commit -sm --amend --no-edit   
$ git push origin HEAD -f

The force-push above doesn't seem to have triggered the jobs, let me know if there's something else I should try

[B-Step62]

@wllgrnt Thanks for trying it out, that's very weird it didn't work. It seems the same issue happens for some other PRs so I will investigate further. Meanwhile, we overrode the checks and pushed as there shouldn't be a big concern for this PR. Thank you so much for your contribution!!