mlflow.config

mlflow.config.disable_system_metrics_logging()[源代码]

备注

实验性功能:此功能可能在未来的版本中无警告地更改或移除。

全局禁用系统指标日志记录。

调用此函数将全局禁用系统指标日志记录,但用户仍可以通过 mlflow.start_run(log_system_metrics=True) 选择为单个运行启用系统指标日志记录。

mlflow.config.enable_async_logging(enable=True)[源代码]

全局启用或禁用异步日志记录。

参数:

enable – bool,如果为 True,启用异步日志记录。如果为 False,禁用异步日志记录。

示例
import mlflow

mlflow.config.enable_async_logging(True)

with mlflow.start_run():
    mlflow.log_param("a", 1)  # This will be logged asynchronously

mlflow.config.enable_async_logging(False)
with mlflow.start_run():
    mlflow.log_param("a", 1)  # This will be logged synchronously
mlflow.config.enable_system_metrics_logging()[源代码]

备注

实验性功能:此功能可能在未来的版本中无警告地更改或移除。

全局启用系统指标日志记录。

调用此函数将全局启用系统指标日志记录,但用户仍可以通过 mlflow.start_run(log_system_metrics=False) 选择退出单次运行的系统指标日志记录。

mlflow.config.get_registry_uri() str[源代码]

获取当前的注册表URI。如果没有指定,则默认为跟踪URI。

返回:

注册表URI。

# Get the current model registry uri
mr_uri = mlflow.get_registry_uri()
print(f"Current model registry uri: {mr_uri}")

# Get the current tracking uri
tracking_uri = mlflow.get_tracking_uri()
print(f"Current tracking uri: {tracking_uri}")

# They should be the same
assert mr_uri == tracking_uri
Current model registry uri: file:///.../mlruns
Current tracking uri: file:///.../mlruns
mlflow.config.get_tracking_uri() str[源代码]

获取当前的跟踪URI。这可能与当前活动运行的跟踪URI不对应,因为可以通过 set_tracking_uri 更新跟踪URI。

返回:

跟踪URI。

import mlflow

# Get the current tracking uri
tracking_uri = mlflow.get_tracking_uri()
print(f"Current tracking uri: {tracking_uri}")
Current tracking uri: file:///.../mlruns
mlflow.config.is_tracking_uri_set()[源代码]

如果已设置跟踪URI,则返回True,否则返回False。

mlflow.config.set_registry_uri(uri: str) None[源代码]

设置注册服务器URI。如果你有一个不同于跟踪服务器的注册服务器,这个方法特别有用。

参数:

uri – 一个空字符串,或以 file:/ 为前缀的本地文件路径。数据存储在提供的文件中(如果为空,则为 ./mlruns)。一个HTTP URI,如 https://my-tracking-server:5000http://my-oss-uc-server:8080。一个Databricks工作区,提供为字符串 “databricks”,或者,使用Databricks CLI 配置文件,”databricks://<profileName>”。

示例
import mflow

# Set model registry uri, fetch the set uri, and compare
# it with the tracking uri. They should be different
mlflow.set_registry_uri("sqlite:////tmp/registry.db")
mr_uri = mlflow.get_registry_uri()
print(f"Current registry uri: {mr_uri}")
tracking_uri = mlflow.get_tracking_uri()
print(f"Current tracking uri: {tracking_uri}")

# They should be different
assert tracking_uri != mr_uri
输出
Current registry uri: sqlite:////tmp/registry.db
Current tracking uri: file:///.../mlruns
mlflow.config.set_system_metrics_node_id(node_id)[源代码]

备注

实验性功能:此功能可能在未来的版本中无警告地更改或移除。

设置系统指标节点ID。

node_id 是收集指标的机器的标识符。这在多节点(分布式训练)设置中非常有用。

mlflow.config.set_system_metrics_samples_before_logging(samples)[源代码]

备注

实验性功能:此功能可能在未来的版本中无警告地更改或移除。

设置在记录系统指标之前的样本数量。

每次收集了 samples 个样本后,系统指标将被记录到 mlflow。默认情况下 samples=1

mlflow.config.set_system_metrics_sampling_interval(interval)[源代码]

备注

实验性功能:此功能可能在未来的版本中无警告地更改或移除。

设置系统指标采样间隔。

interval 秒,系统指标将被收集。默认情况下 interval=10

mlflow.config.set_tracking_uri(uri: str | Path) None[源代码]

设置跟踪服务器URI。这不会影响当前活动的运行(如果存在),但对后续运行有效。

参数:

uri

  • 一个空字符串,或以 file:/ 为前缀的本地文件路径。数据存储在提供的文件中(如果为空,则为 ./mlruns)。

  • 一个类似 https://my-tracking-server:5000 的 HTTP URI。

  • 一个 Databricks 工作区,以字符串 “databricks” 提供,或者,使用 Databricks CLI 配置文件,”databricks://<profileName>”。

  • 一个 pathlib.Path 实例

示例
import mlflow

mlflow.set_tracking_uri("file:///tmp/my_tracking")
tracking_uri = mlflow.get_tracking_uri()
print(f"Current tracking uri: {tracking_uri}")
输出
Current tracking uri: file:///tmp/my_tracking