[FR] Support Github Markdown flavor in the description fields

darenr commented 1 year ago

Willingness to contribute

Yes. I can contribute this feature independently.

Proposal Summary

Commonmark is significantly less expressive than the github markdown flavor. My feature request is to switch out commonmark for github markdow so get color syntax highlighting of code blocks, svg support (express pipelines visually) etc.

Motivation

Improve description capabilities to be more expressive

Good descriptions with illustrations gives data scientists the ability to "comment" their experiment runs more expressively

Good descriptions with illustrations gives data scientists the ability to "comment" their experiment runs more expressively

The current description field for experiments and models is rendered with a less expressive library that doesn't support the github flavor of markdown that for many has become the format they are used to

Details

No response

What component(s) does this bug affect?

[ ] 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
[X] area/models: MLmodel format, model serialization/deserialization, flavors
[ ] area/recipes: Recipes, Recipe APIs, Recipe configs, Recipe Templates
[X] 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

What interface(s) does this bug affect?

[ ] 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

What language(s) does this bug affect?

[ ] language/r: R APIs and clients
[ ] language/java: Java APIs and clients
[ ] language/new: Proposals for new client languages

What integration(s) does this bug affect?

[ ] integrations/azure: Azure and Azure ML integrations
[ ] integrations/sagemaker: SageMaker integrations
[ ] integrations/databricks: Databricks integrations

WeichenXu123 commented 1 year ago

Would you paste some example snapshot to show the difference between them ? And how much performance difference between them ? And what's the major gramma differences between them ?

dbczumar commented 1 year ago

@sunishsheth2009 can you take a look at this request?

dbczumar commented 1 year ago

@darenr as @sunishsheth2009 pointed out, MLflow already appears to use GitHub markdown: https://github.com/mlflow/mlflow/blob/a54ca23bb4fbd4fdcd7f895c84969cedc4b2f523/mlflow/server/js/src/common/utils/MarkdownUtils.js#L6. Are there missing features?

darenr commented 1 year ago

that's embarassing! I appreciate you letting me know.

I'd tried using

 def foo() -> str:
   return "bar"

to see if color syntax highlighting works (as above) in an experiment description and didn't see the highlighting. I'd also tried an svg path which also didn't seem to work (to embed an image without an external source)


<svg height="210" width="400">
  <path d="M150 0 L75 200 L225 200 Z" />
</svg>

the main one was to embedd yaml with color syntax highlighting

dbczumar commented 1 year ago

Got it, perhaps the JS plugin needs to be updated @sunishsheth2009 ?

sunishsheth2009 commented 1 year ago

That is possible. We are on version 1.9.1 of showdown and there is a newer version: 2.1.0. Maybe upgrading to the newer version would solve that. But since it is a major version upgrade, we need to figure out the upgrading path and see if there are any breaking changes.

dbczumar commented 1 year ago

Thanks @sunishsheth2009 .

@darenr Would you be willing to try upgrading showdown to see if the latest version works with the MLflow UI and, if so, file an upgrade PR? We would really appreciate your contribution :D

mlflow-automation commented 1 year ago

@BenWilson2 @dbczumar @harupy @WeichenXu123 Please assign a maintainer and start triaging this issue.

mlflow / mlflow