question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[DOC-FIX] Document models:/ URIs explicitly in OSS MLflow docs

See original GitHub issue

Willingness to contribute

No. I cannot contribute a documentation fix at this time.

URL(s) with the issue

https://mlflow.org/docs/latest/tracking.html#artifact-stores

Description of proposal (what needs changing)

I wanted to link to what an “MLflow model URI” could be in a design doc, and searched for it in MLflow docs. It looks like we don’t actually describe supported model URIs except in CLI docs which say

Required URI to the model. A local path, a 'runs:/' URI, or a remote storage URI (e.g., an 's3://' URI). For more information about supported remote URIs for model artifacts, see https://mlflow.org/docs/latest/tracking.html#artifact-stores

However the linked artifacts doc page doesn’t say anything about models:/ URIs. Currently, it looks like we document models:/ URIs in the model registry page: https://mlflow.org/docs/latest/model-registry.html#fetching-an-mlflow-model-from-the-model-registry.

To address this, one idea is to document model registry models:/ artifact storage and runs:/ artifact storage in https://mlflow.org/docs/latest/tracking.html#artifact-stores. We could also add a more explicit section documenting models:/ URIs in the model registry doc page and link to it from the tracking page

Issue Analytics

  • State:open
  • Created a year ago
  • Comments:9

github_iconTop GitHub Comments

1reaction
dbczumarcommented, Aug 16, 2022

@Nikhil-Mudgal I agree, the second solution is better. The following section of the contributing guide should help: https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.rst#writing-docs

0reactions
Nikhil-Mudgalcommented, Aug 16, 2022

Thanks @dbczumar. As per the OP’s request where he has proposed 2 solutions to the issue. Carrying out the 2nd one will surely be better as we will be giving providing an explicit section for models:/ URI in the model registry doc page itself and a link to it from Model Tracking page too. Should i go ahead with that? And can you please provide me link on how to setup the required environment for documentation, it will be great as a headstart?

Read more comments on GitHub >

github_iconTop Results From Across the Web

MLflow Models — MLflow 2.0.1 documentation
Each MLflow Model is a directory containing arbitrary files, together with an ... module defines functions for creating python_function models explicitly.
Read more >
MLflow 2.0.1 documentation
Managing and deploying models from a variety of ML libraries to a variety of model serving and inference platforms (MLflow Models). Providing a...
Read more >
MLflow Tracking — MLflow 2.0.1 documentation
The Tracking Server responds with an artifact store URI location. The MLflow client creates an instance of a LocalArtifactRepository and saves artifacts to...
Read more >
mlflow.models - Documentation
A model evaluation artifact containing an artifact uri and content. property content. The content of the artifact (representation varies).
Read more >
Concepts — MLflow 2.0.1 documentation
The Machine Learning Workflow. Machine learning requires experimenting with a wide range of datasets, data preparation steps, and algorithms to build a model...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found