Include system metrics in the API doc (mlflow#10261)

Signed-off-by: chenmoneygithub <[email protected]> Signed-off-by: swathi <[email protected]>
KonakanchiSwathi · Nov 29, 2023 · 5ac2322 · 5ac2322
1 parent 57a2ca7
commit 5ac2322
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/docs/source/python_api/mlflow.system_metrics.rst b/docs/source/python_api/mlflow.system_metrics.rst
@@ -0,0 +1,7 @@
+mlflow.system_metrics
+======================
+
+.. automodule:: mlflow.system_metrics
+    :members:
+    :undoc-members:
+
diff --git a/mlflow/tracking/fluent.py b/mlflow/tracking/fluent.py
@@ -235,7 +235,7 @@ def start_run(
         If a new run is being created, the description is set on the new run.
     :param log_system_metrics: bool, defaults to None. If True, system metrics will be logged
         to MLflow, e.g., cpu/gpu utilization. If None, we will check environment variable
-        `MLFLOW_SYSTEM_METRICS_SAMPLING_INTERVAL` to determine whether to log system metrics.
+        `MLFLOW_ENABLE_SYSTEM_METRICS_LOGGING` to determine whether to log system metrics.
         System metrics logging is an experimental feature in MLflow 2.8 and subject to change.
 
     :return: :py:class:`mlflow.ActiveRun` object that acts as a context manager wrapping the