Skip to content

Add mlflow.note.content to tags and documentation - #2726

Merged
aarondav merged 5 commits into
mlflow:masterfrom
crflynn:add-note-to-run
Apr 17, 2020
Merged

aarondav merged 5 commits into
mlflow:masterfrom
crflynn:add-note-to-run

Conversation

@crflynn

@crflynn crflynn commented Apr 17, 2020

Copy link
Copy Markdown
Contributor

What changes are proposed in this pull request?

Adds an internal mlflow tag mlflow.note.content to mlflow_tags.py. Updates the System Tags documentation to describe this tag.

How is this patch tested?

There are no tests here, however, the mlflow tag that is used is the same from NoteUtils.js which applies the note to the run with the browser editor.

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.

Adds a system tag constant which is used by the model run Note feature.

What component(s) does this PR affect?

  • UI
  • CLI
  • API
  • REST-API
  • Examples
  • Docs
  • Tracking
  • Projects
  • Artifacts
  • Models
  • Model Registry
  • Scoring
  • Serving
  • R
  • Java
  • Python

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

@aarondav

Copy link
Copy Markdown
Contributor

I'm not sure this use-case warrants entirely new top-level mlflow.set_note / mlflow.delete_note methods. This tag should probably be documented here, so that people know how to overwrite the note per our public documentation (as opposed to reading code). What do you think?

@aarondav aarondav added the needs author feedback Issue is waiting for the author to respond label Apr 17, 2020
@crflynn

crflynn commented Apr 17, 2020

Copy link
Copy Markdown
Contributor Author

I think that alternative is fine and would look something like this:

import mlflow
from mlflow.utils.mlflow_tags import MLFLOW_RUN_NOTE

mlflow.start_run()
# training the model...
mlflow.set_tag(key=MLFLOW_RUN_NOTE, value="this is a note about what we are training")
mlflow.end_run()

The goal here being to be able to clearly set the note for a run without having to use the UI. I'd be happy with either implementation and can make the suggested changes if this alternative is preferable.

@stale stale Bot removed the needs author feedback Issue is waiting for the author to respond label Apr 17, 2020
@aarondav

Copy link
Copy Markdown
Contributor

That looks great to me! So the proposed changes are:

  1. Add this tag to mlflow_tags.py
  2. Update the tracking docs table to include this tag (and mention that the user may overwrite this value, which is special compared to most other system tags).

Also, I noticed that the comment at the top of mlflow_tags is outdated ("See REST API documentation") -- let's update that to point to the System Tags table.

Thanks!

@aarondav aarondav added the needs author feedback Issue is waiting for the author to respond label Apr 17, 2020
@stale stale Bot removed the needs author feedback Issue is waiting for the author to respond label Apr 17, 2020
@crflynn crflynn changed the title Allow explicitly setting or removing Note for a model run Add mlflow.note.content to tags and documentation Apr 17, 2020

@aarondav aarondav left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks great! Checked out the markdown locally and all looks good there.

@aarondav
aarondav merged commit 2300d8e into mlflow:master Apr 17, 2020
@smurching smurching added the rn/none List under Small Changes in Changelogs. label Apr 20, 2020
arjundc-db added a commit that referenced this pull request Apr 20, 2020
* Refactor tests: split out sagemaker, tensorflow, and other model flavors from python large (#2710)

* Use pytest.ini to specify `--color=yes` (#2716)

* Change plotly to use scattergl (#2447)

* Add /health endpoint (#2725)

* Update note about MacOS compatibility (#2392)

* Make MlflowClient serializable (#2723)

Make the Java MlflowClient class implement Serializable so that it can be used in Spark jobs

* Fix autologging of Keras optimizers for TF.Keras 1.X (#2709)

Merged.

* Added model registry to index.rst; concepts.rst; aligned some languag… (#2582)

* Add mlflow.note.content to tags and documentation (#2726)

* Use LibYAML by default to increase performance in FileUtils (#2707)

* FileUtils: Try to use LibYAML by default to increase performance. By default PyYAML is using Python parser, which is significantly slower than its C++ counter-part.

* Fix slack invite link (#2733)

* Fix slack link

* Use rst syntax

* Preparing for release 1.8.0 (#2718)

* Project import generated by Copybara.

GitOrigin-RevId: f290c7d549fbb82a50f8760113d5144bb4a997ff

* Lint fix in ModelView.js

* Removing Tabs

* Fixing imports

* Fixing version numbers in react-dom

* Project import generated by Copybara.

GitOrigin-RevId: 36896445fc4b32d17da255c21f545b527dec92a3

* Style fixes

Co-authored-by: Richard Zang <Zangr@users.noreply.github.com>
Co-authored-by: Sid Murching <sid.murching@databricks.com>

Co-authored-by: Mani Parkhe <mani@databricks.com>
Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com>
Co-authored-by: Michael Lingelbach <m.j.lbach@gmail.com>
Co-authored-by: Flynn <crflynn@users.noreply.github.com>
Co-authored-by: Jeffrey McLarty <jnmclarty@users.noreply.github.com>
Co-authored-by: juntai-zheng <39497939+juntai-zheng@users.noreply.github.com>
Co-authored-by: dmatrix <dmatrix@comcast.net>
Co-authored-by: Vojtech Micka <micka.vojtech@gmail.com>
Co-authored-by: Arjun DCunha <61438563+arjundc-db@users.noreply.github.com>
Co-authored-by: Richard Zang <Zangr@users.noreply.github.com>
avflor pushed a commit to avflor/mlflow that referenced this pull request Aug 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rn/none List under Small Changes in Changelogs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants