[DOC-FIX] Document models:/ URIs explicitly in OSS MLflow docs
See original GitHub issueWillingness 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:
- Created a year ago
- Comments:9
@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
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?