Skip to content

Commit

Permalink
Clarify docs around using the MLflow CLI with a tracking server (mlfl…
Browse files Browse the repository at this point in the history
  • Loading branch information
smurching authored and aarondav committed Sep 19, 2018
1 parent 030d8f4 commit b332ef6
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 7 deletions.
7 changes: 6 additions & 1 deletion mlflow/azureml/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,12 @@

@click.group("azureml")
def commands():
"""Serve models on Azure ML."""
"""
Serve models on Azure ML.
To serve a model associated with a run on a tracking server, set the MLFLOW_TRACKING_URI
environment variable to the URL of the desired server.
"""
pass


Expand Down
5 changes: 4 additions & 1 deletion mlflow/experiments.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@

@click.group("experiments")
def commands():
"""Manage experiments."""
"""
Manage experiments. To manage experiments associated with a tracking server, set the
MLFLOW_TRACKING_URI environment variable to the URL of the desired server.
"""
pass


Expand Down
7 changes: 6 additions & 1 deletion mlflow/pyfunc/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,12 @@ def _rerun_in_conda(conda_env_path):

@click.group("pyfunc")
def commands():
"""Serve Python models locally."""
"""
Serve Python models locally.
To serve a model associated with a run on a tracking server, set the MLFLOW_TRACKING_URI
environment variable to the URL of the desired server.
"""
pass


Expand Down
7 changes: 6 additions & 1 deletion mlflow/rfunc/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@

@click.group("rfunc")
def commands():
"""Serve R models locally."""
"""
Serve R models locally.
To serve a model associated with a run on a tracking server, set the MLFLOW_TRACKING_URI
environment variable to the URL of the desired server.
"""
pass


Expand Down
7 changes: 6 additions & 1 deletion mlflow/sagemaker/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,12 @@

@click.group("sagemaker")
def commands():
"""Serve models on SageMaker."""
"""
Serve models on SageMaker.
To serve a model associated with a run on a tracking server, set the MLFLOW_TRACKING_URI
environment variable to the URL of the desired server.
"""
pass


Expand Down
7 changes: 6 additions & 1 deletion mlflow/sklearn.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,12 @@ def load_model(path, run_id=None):

@click.group("sklearn")
def commands():
"""Serve scikit-learn models."""
"""
Serve scikit-learn models locally.
To serve a model associated with a run on a tracking server, set the MLFLOW_TRACKING_URI
environment variable to the URL of the desired server.
"""
pass


Expand Down
7 changes: 6 additions & 1 deletion mlflow/store/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,12 @@

@click.group("artifacts")
def commands():
"""Upload, list, and download artifacts from an MLflow artifact repository."""
"""
Upload, list, and download artifacts from an MLflow artifact repository.
To manage artifacts for a run associated with a tracking server, set the MLFLOW_TRACKING_URI
environment variable to the URL of the desired server.
"""
pass


Expand Down

0 comments on commit b332ef6

Please sign in to comment.