mlflow.环境变量
此模块定义了在 MLflow 中使用的环境变量。
- mlflow.environment_variables.MLFLOW_ALLOW_HTTP_REDIRECTS = 'MLFLOW_ALLOW_HTTP_REDIRECTS'
指定在发出HTTP请求时,MLflow服务器是否允许跟随重定向。如果设置为False,服务器在遇到重定向响应时将抛出异常。(默认值:
True
)
- mlflow.environment_variables.MLFLOW_ARTIFACT_UPLOAD_DOWNLOAD_TIMEOUT = 'MLFLOW_ARTIFACT_UPLOAD_DOWNLOAD_TIMEOUT'
(实验性,可能会更改或移除) 指定上传或下载文件时使用的超时时间(默认:
None
)。如果为 None,则各个制品库将选择默认值。
- mlflow.environment_variables.MLFLOW_ASYNC_LOGGING_BUFFERING_SECONDS = 'MLFLOW_ASYNC_LOGGING_BUFFERING_SECONDS'
指定异步日志记录线程在记录一批日志之前等待的时间长度(以秒为单位)。
- mlflow.environment_variables.MLFLOW_ASYNC_LOGGING_THREADPOOL_SIZE = 'MLFLOW_ASYNC_LOGGING_THREADPOOL_SIZE'
用于异步日志记录的线程池中的工作线程数量,默认为10。
- mlflow.environment_variables.MLFLOW_AUTH_CONFIG_PATH = 'MLFLOW_AUTH_CONFIG_PATH'
指定了MLflow身份验证的配置文件路径。(默认:
None
)
- mlflow.environment_variables.MLFLOW_CONDA_CREATE_ENV_CMD = 'MLFLOW_CONDA_CREATE_ENV_CMD'
指定创建环境时要使用的命令名称。例如,假设我们想使用 mamba (https://github.com/mamba-org/mamba) 而不是 conda 来创建环境。那么: > conda install mamba -n base -c conda-forge 如果未设置,则使用与 conda_path 相同的值(默认:
conda
)
- mlflow.environment_variables.MLFLOW_CONFIGURE_LOGGING = 'MLFLOW_LOGGING_CONFIGURE_LOGGING'
指定是否在导入时让 mlflow 配置日志记录。如果设置为 True,mlflow 将为
mlflow.<module_name>
日志记录器配置日志处理程序和格式化器。(默认:True
)
- mlflow.environment_variables.MLFLOW_DATABRICKS_ENDPOINT_HTTP_RETRY_TIMEOUT = 'MLFLOW_DATABRICKS_ENDPOINT_HTTP_RETRY_TIMEOUT'
指定 Databricks 端点 HTTP 请求重试的超时时间(以秒为单位)。
- mlflow.environment_variables.MLFLOW_DEFAULT_PREDICTION_DEVICE = 'MLFLOW_DEFAULT_PREDICTION_DEVICE'
指定预测函数中使用的设备 - 可以通过将此环境变量设置为
cpu
来覆盖默认行为,即在可用时默认使用 GPU。目前,此变量仅支持 MLflow PyTorch 和 HuggingFace 风格。对于 HuggingFace 风格,请注意设备必须可以解析为整数。
- mlflow.environment_variables.MLFLOW_DEPLOYMENTS_CONFIG = 'MLFLOW_DEPLOYMENTS_CONFIG'
指定 MLflow AI Gateway 的配置文件路径。(默认:
None
)
- mlflow.environment_variables.MLFLOW_DEPLOYMENTS_TARGET = 'MLFLOW_DEPLOYMENTS_TARGET'
(实验性,可能会更改或移除) 指定一个 MLflow AI Gateway 实例的 URI,用于与部署客户端 API 一起使用(默认:
None
)
- mlflow.environment_variables.MLFLOW_DEPLOYMENT_FLAVOR_NAME = 'MLFLOW_DEPLOYMENT_FLAVOR_NAME'
指定评分服务器中提供的风味。(默认
None
)
- mlflow.environment_variables.MLFLOW_DFS_TMP = 'MLFLOW_DFS_TMP'
指定
dfs_tmpdir
参数用于mlflow.spark.save_model
、mlflow.spark.log_model
和mlflow.spark.load_model
。更多信息请参见 https://www.mlflow.org/docs/latest/python_api/mlflow.spark.html#mlflow.spark.save_model。(默认值:/tmp/mlflow
)
- mlflow.environment_variables.MLFLOW_DISABLE_ENV_CREATION = 'MLFLOW_DISABLE_ENV_CREATION'
指定是否禁用为 mlflow models build-docker 创建新的 conda 环境。(默认值:
False
)
- mlflow.environment_variables.MLFLOW_DISABLE_ENV_MANAGER_CONDA_WARNING = 'MLFLOW_DISABLE_ENV_MANAGER_CONDA_WARNING'
指定当指定 –env-manager=conda 时是否打印警告。(默认:
False
)
- mlflow.environment_variables.MLFLOW_DOCKER_OPENJDK_VERSION = 'MLFLOW_DOCKER_OPENJDK_VERSION'
在用于MLflow模型的Docker镜像中安装的OpenJDK版本。(默认:
11
)
- mlflow.environment_variables.MLFLOW_DOWNLOAD_CHUNK_TIMEOUT = 'MLFLOW_DOWNLOAD_CHUNK_TIMEOUT'
指定下载mlflow工件块的超时值。(默认值:
300
)
- mlflow.environment_variables.MLFLOW_ENABLE_ARTIFACTS_PROGRESS_BAR = 'MLFLOW_ENABLE_ARTIFACTS_PROGRESS_BAR'
指定在上传/下载工件时是否显示进度条。(默认:
True
)
- mlflow.environment_variables.MLFLOW_ENABLE_ASYNC_LOGGING = 'MLFLOW_ENABLE_ASYNC_LOGGING'
如果为 True,MLflow 流式日志记录 API,例如 mlflow.log_metric 将以异步方式记录。
- mlflow.environment_variables.MLFLOW_ENABLE_DBFS_FUSE_ARTIFACT_REPO = 'MLFLOW_ENABLE_DBFS_FUSE_ARTIFACT_REPO'
指定是否使用 DBFS FUSE 挂载来在 Databricks 上存储工件(默认:
False
)
- mlflow.environment_variables.MLFLOW_ENABLE_DB_SDK = 'MLFLOW_ENABLE_DB_SDK'
是否启用 Databricks SDK。如果为真,MLflow 使用 databricks-sdk 向 Databricks 端点发送 HTTP 请求,否则 MLflow 使用
requests
库向 Databricks 端点发送 HTTP 请求。请注意,如果您想使用 OAuth 认证,您必须将此环境变量设置为真。(默认:True
)
- mlflow.environment_variables.MLFLOW_ENABLE_PROXY_MULTIPART_UPLOAD = 'MLFLOW_ENABLE_PROXY_MULTIPART_UPLOAD'
指定是否为代理的构件访问使用分段上传。(默认:
False
)
- mlflow.environment_variables.MLFLOW_ENABLE_SYSTEM_METRICS_LOGGING = 'MLFLOW_ENABLE_SYSTEM_METRICS_LOGGING'
指定是否应启用系统指标日志记录。
- mlflow.environment_variables.MLFLOW_ENABLE_UC_FUNCTIONS = 'MLFLOW_ENABLE_UC_FUNCTIONS'
为 MLflow AI 网关启用 Unity Catalog 集成。(默认:
False
)
- mlflow.environment_variables.MLFLOW_ENABLE_UC_VOLUME_FUSE_ARTIFACT_REPO = 'MLFLOW_ENABLE_UC_VOLUME_FUSE_ARTIFACT_REPO'
指定是否使用 UC Volume FUSE 挂载来在 Databricks 上存储工件(默认:
True
)
- mlflow.environment_variables.MLFLOW_ENV_ROOT = 'MLFLOW_ENV_ROOT'
指定创建Python虚拟环境的根目录。(默认:
~/.mlflow/envs
)
- mlflow.environment_variables.MLFLOW_EXPERIMENT_NAME = 'MLFLOW_EXPERIMENT_NAME'
指定创建运行时的默认实验名称。(默认:
None
)
- mlflow.environment_variables.MLFLOW_GATEWAY_CONFIG = 'MLFLOW_GATEWAY_CONFIG'
指定 MLflow AI Gateway 的配置文件路径。(默认:
None
)
- mlflow.environment_variables.MLFLOW_GATEWAY_URI = 'MLFLOW_GATEWAY_URI'
(实验性,可能会更改或移除) 指定一个 MLflow Gateway Server 实例的 URI,用于与 Gateway Client API 一起使用(默认:
None
)
- mlflow.environment_variables.MLFLOW_GCS_DEFAULT_TIMEOUT = 'MLFLOW_GCS_DEFAULT_TIMEOUT'
(已弃用,请使用
MLFLOW_ARTIFACT_UPLOAD_DOWNLOAD_TIMEOUT
) 指定从/向 GCS 下载/上传文件时使用的默认超时时间(默认:None
)。如果为 None,则使用google.cloud.storage.constants._DEFAULT_TIMEOUT
。
- mlflow.environment_variables.MLFLOW_GCS_DOWNLOAD_CHUNK_SIZE = 'MLFLOW_GCS_DOWNLOAD_CHUNK_SIZE'
指定从GCS下载文件时使用的块大小(默认:
None
)。如果为None,块大小将由``google-cloud-storage``包自动确定。
- mlflow.environment_variables.MLFLOW_GCS_UPLOAD_CHUNK_SIZE = 'MLFLOW_GCS_UPLOAD_CHUNK_SIZE'
指定上传文件到GCS时使用的块大小。(默认:
None
)。如果为None,块大小将由``google-cloud-storage``包自动确定。
- mlflow.environment_variables.MLFLOW_HTTP_POOL_CONNECTIONS = 'MLFLOW_HTTP_POOL_CONNECTIONS'
指定在 urllib3 中缓存的连接池数量。此环境变量设置 requests.adapters.HTTPAdapter 构造函数中的 pool_connections 参数。通过调整此变量,用户可以增强 MLflow 发出的 HTTP 请求的并发性。
- mlflow.environment_variables.MLFLOW_HTTP_POOL_MAXSIZE = 'MLFLOW_HTTP_POOL_MAXSIZE'
指定HTTP连接池中保持的最大连接数。此环境变量设置 requests.adapters.HTTPAdapter 构造函数中的 pool_maxsize 参数。通过调整此变量,用户可以增强MLflow发出的HTTP请求的并发性。
- mlflow.environment_variables.MLFLOW_HTTP_REQUEST_BACKOFF_FACTOR = 'MLFLOW_HTTP_REQUEST_BACKOFF_FACTOR'
指定MLflow HTTP请求失败之间的回退增加因子(默认值:
2
)
- mlflow.environment_variables.MLFLOW_HTTP_REQUEST_BACKOFF_JITTER = 'MLFLOW_HTTP_REQUEST_BACKOFF_JITTER'
指定MLflow HTTP请求失败之间的回退抖动(默认值:
1.0
)
- mlflow.environment_variables.MLFLOW_HTTP_REQUEST_MAX_RETRIES = 'MLFLOW_HTTP_REQUEST_MAX_RETRIES'
指定MLflow HTTP请求的最大重试次数(默认:
5
)
- mlflow.environment_variables.MLFLOW_HTTP_REQUEST_TIMEOUT = 'MLFLOW_HTTP_REQUEST_TIMEOUT'
指定MLflow HTTP请求的超时时间(以秒为单位)(默认值:
120
)
- mlflow.environment_variables.MLFLOW_HTTP_RESPECT_RETRY_AFTER_HEADER = 'MLFLOW_HTTP_RESPECT_RETRY_AFTER_HEADER'
指定是否在 MLflow HTTP 请求中,对于定义为 Retry.RETRY_AFTER_STATUS_CODES 的状态代码,遵循 Retry-After 头(默认:
True
)
- mlflow.environment_variables.MLFLOW_HUGGINGFACE_DEVICE_MAP_STRATEGY = 'MLFLOW_HUGGINGFACE_DEVICE_MAP_STRATEGY'
指定 Huggingface 使用 HuggingFace accelerate 的自动设备放置逻辑。这可以设置为所安装的 HuggingFace Accelerate 版本支持的值。
- mlflow.environment_variables.MLFLOW_HUGGINGFACE_MODEL_MAX_SHARD_SIZE = 'MLFLOW_HUGGINGFACE_MODEL_MAX_SHARD_SIZE'
指定在保存模型检查点时使用的 max_shard_size。这可以设置为覆盖默认的 500MB。
- mlflow.environment_variables.MLFLOW_HUGGINGFACE_USE_LOW_CPU_MEM_USAGE = 'MLFLOW_HUGGINGFACE_USE_LOW_CPU_MEM_USAGE'
指定 Huggingface 使用由 HuggingFace 加速驱动的 low_cpu_mem_usage 标志。如果设置为 false,则 low_cpu_mem_usage 标志将被设置为 False。
- mlflow.environment_variables.MLFLOW_INPUT_EXAMPLE_INFERENCE_TIMEOUT = 'MLFLOW_INPUT_EXAMPLE_INFERENCE_TIMEOUT'
指定在记录/保存模型时,使用输入示例进行模型推理的超时时间。MLflow 对模型运行一些推理请求以推断模型签名和 pip 要求。有时预测会挂起很长时间,特别是对于大型模型。此超时限制了进行签名推理的预测允许的时间,并将中止预测,回退到默认的签名和 pip 要求。
- mlflow.environment_variables.MLFLOW_KERBEROS_TICKET_CACHE = 'MLFLOW_KERBEROS_TICKET_CACHE'
指定用于HDFS工件操作的Kerberos票据缓存的位置。(默认:
None
)
- mlflow.environment_variables.MLFLOW_KERBEROS_USER = 'MLFLOW_KERBEROS_USER'
指定用于HDFS工件操作的Kerberos用户。(默认:
None
)
- mlflow.environment_variables.MLFLOW_MULTIPART_DOWNLOAD_CHUNK_SIZE = 'MLFLOW_MULTIPART_DOWNLOAD_CHUNK_SIZE'
指定执行分块下载时使用的块大小(以字节为单位)(默认值:``104_857_600``(100 MB))
- mlflow.environment_variables.MLFLOW_MULTIPART_DOWNLOAD_MINIMUM_FILE_SIZE = 'MLFLOW_MULTIPART_DOWNLOAD_MINIMUM_FILE_SIZE'
指定下载工件时使用多部分下载的最小文件大小(以字节为单位)(默认值:``524_288_000``(500 MB))
- mlflow.environment_variables.MLFLOW_MULTIPART_UPLOAD_CHUNK_SIZE = 'MLFLOW_MULTIPART_UPLOAD_CHUNK_SIZE'
指定在进行分段上传时使用的块大小(以字节为单位)(默认值:``104_857_60``(10 MB))
- mlflow.environment_variables.MLFLOW_MULTIPART_UPLOAD_MINIMUM_FILE_SIZE = 'MLFLOW_MULTIPART_UPLOAD_MINIMUM_FILE_SIZE'
指定在记录工件时使用多部分上传的最小文件大小(以字节为单位)(默认值:``524_288_000``(500 MB))
- mlflow.environment_variables.MLFLOW_OPENAI_SECRET_SCOPE = 'MLFLOW_OPENAI_SECRET_SCOPE'
指定用于存储OpenAI API密钥的Databricks密钥作用域的名称。
- mlflow.environment_variables.MLFLOW_PYARROW_EXTRA_CONF = 'MLFLOW_PYARROW_EXTRA_CONF'
指定用于HDFS工件操作的额外pyarrow配置。(默认:
None
)
- mlflow.environment_variables.MLFLOW_RECIPES_EXECUTION_DIRECTORY = 'MLFLOW_RECIPES_EXECUTION_DIRECTORY'
指定配方的执行目录。(默认:
None
)
- mlflow.environment_variables.MLFLOW_RECIPES_EXECUTION_TARGET_STEP_NAME = 'MLFLOW_RECIPES_EXECUTION_TARGET_STEP_NAME'
指定要为配方执行的目标步骤。(默认:
None
)
- mlflow.environment_variables.MLFLOW_RECIPES_PROFILE = 'MLFLOW_RECIPES_PROFILE'
指定用于配方的配置文件。(默认:
None
)
- mlflow.environment_variables.MLFLOW_REGISTRY_DIR = 'MLFLOW_REGISTRY_DIR'
指定注册表 FileStore 的默认根目录。(默认值:
None
)
- mlflow.environment_variables.MLFLOW_REQUIREMENTS_INFERENCE_RAISE_ERRORS = 'MLFLOW_REQUIREMENTS_INFERENCE_RAISE_ERRORS'
是否对模型的依赖推断中无法解析的需求推断发出警告(默认)或引发异常(可选)。如果设置为 True,当需求推断或捕获导入模块的过程中遇到任何错误时,将引发异常。
- mlflow.environment_variables.MLFLOW_REQUIREMENTS_INFERENCE_TIMEOUT = 'MLFLOW_REQUIREMENTS_INFERENCE_TIMEOUT'
指定 MLflow 模型依赖推断操作的
timeout_seconds
。(默认值:120
)
- mlflow.environment_variables.MLFLOW_S3_ENDPOINT_URL = 'MLFLOW_S3_ENDPOINT_URL'
指定用于S3工件操作的S3端点URL。(默认值:
None
)
- mlflow.environment_variables.MLFLOW_S3_IGNORE_TLS = 'MLFLOW_S3_IGNORE_TLS'
指定是否跳过S3工件操作的TLS证书验证。(默认:
False
)
- mlflow.environment_variables.MLFLOW_S3_UPLOAD_EXTRA_ARGS = 'MLFLOW_S3_UPLOAD_EXTRA_ARGS'
指定S3工件上传的额外参数。(默认值:
None
)
- mlflow.environment_variables.MLFLOW_SCORING_SERVER_REQUEST_TIMEOUT = 'MLFLOW_SCORING_SERVER_REQUEST_TIMEOUT'
指定 MLflow 模型评分服务器请求超时时间,单位为秒(默认值:
60
)
- mlflow.environment_variables.MLFLOW_SQLALCHEMYSTORE_ECHO = 'MLFLOW_SQLALCHEMYSTORE_ECHO'
指定在 SQLAlchemy 跟踪存储中用于
sqlalchemy.create_engine
的echo
参数。更多信息请参见 https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.echo 。(默认值:False
)
- mlflow.environment_variables.MLFLOW_SQLALCHEMYSTORE_MAX_OVERFLOW = 'MLFLOW_SQLALCHEMYSTORE_MAX_OVERFLOW'
指定在 SQLAlchemy 跟踪存储中用于
sqlalchemy.create_engine
的max_overflow
参数。更多信息请参见 https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.max_overflow 。(默认值:None
)
- mlflow.environment_variables.MLFLOW_SQLALCHEMYSTORE_POOLCLASS = 'MLFLOW_SQLALCHEMYSTORE_POOLCLASS'
指定在 SQLAlchemy 跟踪存储中用于
sqlalchemy.create_engine
的poolclass
参数。更多信息请参见 https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.poolclass。(默认:None
)
- mlflow.environment_variables.MLFLOW_SQLALCHEMYSTORE_POOL_RECYCLE = 'MLFLOW_SQLALCHEMYSTORE_POOL_RECYCLE'
指定用于
sqlalchemy.create_engine
的pool_recycle
参数,该参数用于 SQLAlchemy 跟踪存储。更多信息请参见 https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.pool_recycle。(默认值:None
)
- mlflow.environment_variables.MLFLOW_SQLALCHEMYSTORE_POOL_SIZE = 'MLFLOW_SQLALCHEMYSTORE_POOL_SIZE'
指定在 SQLAlchemy 跟踪存储中用于
sqlalchemy.create_engine
的pool_size
参数。更多信息请参见 https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine.params.pool_size 。(默认值:None
)
- mlflow.environment_variables.MLFLOW_SYSTEM_METRICS_NODE_ID = 'MLFLOW_SYSTEM_METRICS_NODE_ID'
指定系统指标日志记录的节点ID。这在多节点(分布式训练)设置中非常有用。
- mlflow.environment_variables.MLFLOW_SYSTEM_METRICS_SAMPLES_BEFORE_LOGGING = 'MLFLOW_SYSTEM_METRICS_SAMPLES_BEFORE_LOGGING'
指定记录系统指标前的样本数量。
- mlflow.environment_variables.MLFLOW_SYSTEM_METRICS_SAMPLING_INTERVAL = 'MLFLOW_SYSTEM_METRICS_SAMPLING_INTERVAL'
指定系统指标日志记录的采样间隔。
- mlflow.environment_variables.MLFLOW_TRACKING_AUTH = 'MLFLOW_TRACKING_AUTH'
指定用于签署 MLflow HTTP 请求的认证提供者(默认:
None
)。设置后,它将覆盖“Authorization”HTTP 头。
- mlflow.environment_variables.MLFLOW_TRACKING_AWS_SIGV4 = 'MLFLOW_TRACKING_AWS_SIGV4'
指定MLflow HTTP请求是否应使用AWS签名V4进行签名。它将覆盖(默认:
False
)。设置后,它将覆盖“Authorization”HTTP头。更多信息请参见https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html。
- mlflow.environment_variables.MLFLOW_TRACKING_CLIENT_CERT_PATH = 'MLFLOW_TRACKING_CLIENT_CERT_PATH'
在
requests.request
函数中设置cert
参数,参见 https://requests.readthedocs.io/en/master/api/ (默认值:None
)
- mlflow.environment_variables.MLFLOW_TRACKING_DIR = 'MLFLOW_TRACKING_DIR'
指定用于跟踪 FileStore 的默认根目录。(默认值:
None
)
- mlflow.environment_variables.MLFLOW_TRACKING_INSECURE_TLS = 'MLFLOW_TRACKING_INSECURE_TLS'
指定是否在
requests.request
函数中验证 TLS 连接,参见 https://requests.readthedocs.io/en/master/api/ (默认:False
)。
- mlflow.environment_variables.MLFLOW_TRACKING_PASSWORD = 'MLFLOW_TRACKING_PASSWORD'
指定用于与跟踪服务器进行身份验证的密码。(默认:
None
)
- mlflow.environment_variables.MLFLOW_TRACKING_SERVER_CERT_PATH = 'MLFLOW_TRACKING_SERVER_CERT_PATH'
在
requests.request
函数中设置verify
参数,参见 https://requests.readthedocs.io/en/master/api/ (默认值:None
)
- mlflow.environment_variables.MLFLOW_TRACKING_TOKEN = 'MLFLOW_TRACKING_TOKEN'
指定并在HTTP请求上设置基本/承载认证时优先。(默认:
None
)
- mlflow.environment_variables.MLFLOW_TRACKING_USERNAME = 'MLFLOW_TRACKING_USERNAME'
指定用于与跟踪服务器进行身份验证的用户名。(默认:
None
)
- mlflow.environment_variables.MLFLOW_TRUNCATE_LONG_VALUES = 'MLFLOW_TRUNCATE_LONG_VALUES'
如果设置为 True,以下实体将被截断到其最大长度:- 参数值 - 标签值 如果设置为 False,如果实体长度超过最大长度,将引发异常。(默认:
True
)
- mlflow.environment_variables.MLFLOW_UC_OSS_TOKEN = 'MLFLOW_UC_OSS_TOKEN'
指定并优先设置 HTTP 请求的 UC OSS 基本/承载认证。(默认:
None
)