Skip to content

Commit

Permalink
Adding docs for batch logging to tracking.rst (mlflow#1631)
Browse files Browse the repository at this point in the history
  • Loading branch information
apurva-koti committed Jul 18, 2019
1 parent e750100 commit 722e897
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
6 changes: 3 additions & 3 deletions mlflow/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,6 @@
run = projects.run


__all__ = ["ActiveRun", "log_param", "log_metric", "set_tag", "log_artifacts", "log_artifact",
"active_run", "start_run", "end_run", "search_runs", "get_artifact_uri",
"set_tracking_uri", "create_experiment", "set_experiment", "run"]
__all__ = ["ActiveRun", "log_param", "log_params", "log_metric", "log_metrics", "set_tag", "set_tags",
"log_artifacts", "log_artifact", "active_run", "start_run", "end_run", "search_runs",
"get_artifact_uri", "set_tracking_uri", "create_experiment", "set_experiment", "run"]
3 changes: 3 additions & 0 deletions mlflow/tracking/fluent.py
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@ def log_metric(key, value, step=None):
def log_metrics(metrics, step=None):
"""
Log multiple metrics for the current run, starting a run if no runs are active.
:param metrics: Dictionary of metric_name: String -> value: Float. Note that some special values
such as +/- Infinity may be replaced by other values depending on the store.
For example, sql based store may replace +/- Inf with max / min float values.
Expand All @@ -231,6 +232,7 @@ def log_metrics(metrics, step=None):
def log_params(params):
"""
Log a batch of params for the current run, starting a run if no runs are active.
:param params: Dictionary of param_name: String -> value: (String, but will be string-ified if
not)
:returns: None
Expand All @@ -243,6 +245,7 @@ def log_params(params):
def set_tags(tags):
"""
Log a batch of tags for the current run, starting a run if no runs are active.
:param tags: Dictionary of tag_name: String -> value: (String, but will be string-ified if
not)
:returns: None
Expand Down

0 comments on commit 722e897

Please sign in to comment.