Add mlflow.note.content to tags and documentation - #2726
Conversation
|
I'm not sure this use-case warrants entirely new top-level |
|
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. |
|
That looks great to me! So the proposed changes are:
Also, I noticed that the comment at the top of Thanks! |
aarondav
left a comment
There was a problem hiding this comment.
Looks great! Checked out the markdown locally and all looks good there.
* 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>
What changes are proposed in this pull request?
Adds an internal mlflow tag
mlflow.note.contenttomlflow_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?
Adds a system tag constant which is used by the model run Note feature.
What component(s) does this PR affect?
How should the PR be classified in the release notes? Choose one:
rn/breaking-change- The PR will be mentioned in the "Breaking Changes" sectionrn/none- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionrn/feature- A new user-facing feature worth mentioning in the release notesrn/bug-fix- A user-facing bug fix worth mentioning in the release notesrn/documentation- A user-facing documentation change worth mentioning in the release notes