mlflow/mlflow

[FR] in mlflow viewer, add markdown file artifacts viewer

Open

#10.671 geöffnet am 11. Dez. 2023

Auf GitHub ansehen
 (4 Kommentare) (13 Reaktionen) (1 zugewiesene Person)Python (17.127 Stars) (3.904 Forks)batch import
area/trackingarea/uiuxenhancementhelp wanted

Beschreibung

Willingness to contribute

No I cannot contribute to this feature.

Proposal Summary

When logging a markdown file (.md) as an artifact in a run, add in the mlflow ui viewer a capability to parse the markdown language and show the file in a formatted way instead of the raw markdown text in the file preview pane.

Motivation

What is the use case for this feature?

Nice formatting preview of markdown files logged as artifacts. For instance I log in a folder some data and add to it a readme.md file to explain what the folder contains, and so on.

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/deployments: MLflow Deployments client APIs, server, and third-party Deployments integrations
  • 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/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

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

Contributor Guide

Tech Stack
javascriptreact
Domain
frontend
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
blocked
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
React knowledgeMLflow UI codebase orientationMarkdown parsing library
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
20
Research-Richtung
Investigate the MLflow UI artifact viewer component, located in mlflow/web/js/src. Understand how different file types are rendered in the preview pane. Look for existing markdown support or similar patterns. Consider integrating a markdown library like react markdown. Note that this issue has an assigned developer, so coordinate before starting.