Add feature to set and delete description of a run.

[dogeplusplus]

Signed-off-by: Albert Chung albertswchung@gmail.com

• Addresses [FR] Be able to set the description of a run programmatically #5526
• Adding set_description and delete_description in the fluent API.
• Add optional description parameter to mlflow.start_run().
• Expose set_description and delete_description.
• Update CHANGELOG for 1.24.1
• Update tracking documentation with extra logging function

How is this patch tested?

Test fluent has an additional test to set the description, delete it, and then try to delete it again (throwing an exception). When deleting the description again we get the same error with deleting a non-existent tag.

Does this PR change the documentation?

• No. You can skip the rest of this section.
• 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.
• Yes. Give a description of this change to be included in the release notes for MLflow users.

Support for setting the description of a run with an optional description parameter in mlflow.start_run(). Descriptions can be set and also removed using mlflow.set_description() and mlflow.delete_description() respectively.

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/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
• 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

[BenWilson2]

Hi @dogeplusplus thank you for tackling this FR! Just a few comments to address. Prior to your next push, could you merge the master branch to this branch to ensure that the fix for the circleci tests is incorporated into your branch?
Thanks!

[BenWilson2]

Please remove the fluent API function additions of set_description() and delete_description().
We can limit the scope of this change by adding a description only during the start_run call. If there is a programmatic need to change that tag, utilization of tag manipulation that already exists can be used.

[dogeplusplus]

Thank you for reviewing the PR. I have made the recommended changes:

• Reverted the change log
• Removing set_description and delete_description as well as tests/references to it in documentation
• In start run we append the description to the tags if it exists already, or creates a tags dictionary with just this populated
• If the description key and the MLFLOW_RUN_NOTE in tags are both specified I throw an MlflowException to avoid unexpected behavior
• 4 extra tests for start run:
  • Start run to set description
  • Start run with description and also the key is in tags (throws)
  • Resume run to set description
  • Resume run to set description where also the key is in tags (throws)

Let me know if there are any further suggestions.

EDIT: It seems I'm having errors with importing the black during formatting, linting, and some R tests. Does anyone have ideas on why it might be wrong?

[dogeplusplus]

autoformat

[BenWilson2]

We merged the linter upgrade fix into master last night. If you pull master again into your branch it should work now. Sorry for asking for that again!

[BenWilson2]

Thank you for the contribution and I hope it is the first of many!
LGTM!

[dbczumar]

Nit: Can we use error code INVALID_PARAMETER_VALUE here?

[dogeplusplus]

Sure, I think I've added this now.

[BenWilson2]

Thank you for the submission @dogeplusplus . Let us know when you'd like to make another contribution!