MLflow 身份验证 Python API

mlflow.server.auth.client

class mlflow.server.auth.client.AuthServiceClient[source]

基类： object

启用了默认基本身份验证插件的 MLflow Tracking Server 的客户端。建议使用 mlflow.server.get_app_client() 来实例化此类。详情请参见 https://mlflow.org/docs/latest/auth.html。

create_experiment_permission(experiment_id: str, username: str, permission: str)[source]

为用户在实验上创建权限。

Parameters

  • experiment_id – 实验的 ID。

  • username – 用户名。

  • permission – 要授予的权限。必须是 “READ”, “EDIT”, “MANAGE” 和 “NO_PERMISSIONS” 之一。

Raises

mlflow.exceptions.RestException – 如果用户不存在，或者针对该实验与用户的组合权限已存在，或者权限无效。不要求 experiment_id 为已存在的实验。

Returns

一个单独的 mlflow.server.auth.entities.ExperimentPermission 对象。

Example 
export MLFLOW_TRACKING_USERNAME=admin
export MLFLOW_TRACKING_PASSWORD=password

from mlflow.server.auth.client import AuthServiceClient

client = AuthServiceClient("tracking_uri")
client.create_user("newuser", "newpassword")
ep = client.create_experiment_permission("myexperiment", "newuser", "READ")

print(f"experiment_id: {ep.experiment_id}")
print(f"user_id: {ep.user_id}")
print(f"permission: {ep.permission}")
Output 
experiment_id: myexperiment
user_id: 3
permission: READ
create_registered_model_permission(name: str, username: str, permission: str)[source]

为用户在已注册模型上创建权限。

Parameters

  • name – 已注册模型的名称。

  • username – 用户名。

  • permission – 授予的权限。必须为“READ”、“EDIT”、“MANAGE”和“NO_PERMISSIONS”之一。

Raises

mlflow.exceptions.RestException – 如果用户不存在， 或者该已注册模型与用户的权限已存在， 或者权限无效。 不要求 name 为已存在的已注册模型。

Returns

单个 mlflow.server.auth.entities.RegisteredModelPermission 对象。

create_user(username: str, password: str)[source]

创建一个新用户。

Parameters

  • username – 用户名。

  • password – 用户的密码。不能为空字符串。

Raises

mlflow.exceptions.RestException – 如果用户名已被占用。

Returns

一个单独的 mlflow.server.auth.entities.User 对象。

Example 
from mlflow.server.auth.client import AuthServiceClient

client = AuthServiceClient("tracking_uri")
user = client.create_user("newuser", "newpassword")
print(f"user_id: {user.id}")
print(f"username: {user.username}")
print(f"password_hash: {user.password_hash}")
print(f"is_admin: {user.is_admin}")
Output 
user_id: 3
username: newuser
password_hash: REDACTED
is_admin: False
delete_experiment_permission(experiment_id: str, username: str)[source]

删除用户对现有实验的权限。

Parameters

  • experiment_id – 实验的 id。

  • username – 用户名。

Raises

mlflow.exceptions.RestException – 如果用户不存在，或者此实验与用户组合没有权限，或者该权限无效。请注意，即使该权限已被删除，默认权限仍会生效。

Example 
export MLFLOW_TRACKING_USERNAME=admin
export MLFLOW_TRACKING_PASSWORD=password

from mlflow.server.auth.client import AuthServiceClient

client = AuthServiceClient("tracking_uri")
client.create_user("newuser", "newpassword")
client.create_experiment_permission("myexperiment", "newuser", "READ")
client.delete_experiment_permission("myexperiment", "newuser")
delete_registered_model_permission(name: str, username: str)[source]

删除用户对已注册模型的现有权限。

Parameters

  • name – 已注册模型的名称。

  • username – 用户名。

Raises

mlflow.exceptions.RestException – 如果用户不存在，或者该已注册模型与用户配对不存在权限，或者权限无效。请注意，即使该权限已被删除，默认权限仍然会生效。

Example 
export MLFLOW_TRACKING_USERNAME=admin
export MLFLOW_TRACKING_PASSWORD=password

from mlflow.server.auth.client import AuthServiceClient

client = AuthServiceClient("tracking_uri")
client.create_user("newuser", "newpassword")
client.create_registered_model_permission("myregisteredmodel", "newuser", "READ")
client.delete_registered_model_permission("myregisteredmodel", "newuser")
delete_user(username: str)[source]

删除特定用户。

Parameters

username – 用户名。

Raises

mlflow.exceptions.RestException – 如果用户不存在

Example 
export MLFLOW_TRACKING_USERNAME=admin
export MLFLOW_TRACKING_PASSWORD=password

from mlflow.server.auth.client import AuthServiceClient

client = AuthServiceClient("tracking_uri")
client.create_user("newuser", "newpassword")

client.delete_user("newuser")
get_experiment_permission(experiment_id: str, username: str)[source]

为用户获取实验权限。

Parameters

  • experiment_id – 实验的 ID。

  • username – 用户名。

Raises

mlflow.exceptions.RestException – 如果用户不存在，或者该实验与用户的组合没有权限。请注意，即使没有权限，默认权限仍然有效。

Returns

单个 mlflow.server.auth.entities.ExperimentPermission 对象。

Example 
export MLFLOW_TRACKING_USERNAME=admin
export MLFLOW_TRACKING_PASSWORD=password

from mlflow.server.auth.client import AuthServiceClient

client = AuthServiceClient("tracking_uri")
client.create_user("newuser", "newpassword")
client.create_experiment_permission("myexperiment", "newuser", "READ")
ep = client.get_experiment_permission("myexperiment", "newuser")
print(f"experiment_id: {ep.experiment_id}")
print(f"user_id: {ep.user_id}")
print(f"permission: {ep.permission}")
Output 
experiment_id: myexperiment
user_id: 3
permission: READ
get_registered_model_permission(name: str, username: str)[source]

为用户获取已注册模型的权限。

Parameters

  • name – 已注册模型的名称。

  • username – 用户名。

Raises

mlflow.exceptions.RestException – 如果该用户不存在，或对于该已注册模型与用户的组合不存在权限。请注意，即使不存在权限，默认权限仍然会生效。

Returns

单个 mlflow.server.auth.entities.RegisteredModelPermission 对象。

Example 
export MLFLOW_TRACKING_USERNAME=admin
export MLFLOW_TRACKING_PASSWORD=password

from mlflow.server.auth.client import AuthServiceClient

client = AuthServiceClient("tracking_uri")
client.create_user("newuser", "newpassword")
client.create_registered_model_permission("myregisteredmodel", "newuser", "READ")
rmp = client.get_registered_model_permission("myregisteredmodel", "newuser")

print(f"name: {rmp.name}")
print(f"user_id: {rmp.user_id}")
print(f"permission: {rmp.permission}")
Output 
name: myregisteredmodel
user_id: 3
permission: READ
get_user(username: str)[source]

获取具有特定用户名的用户。

Parameters

username – 用户名。

Raises

mlflow.exceptions.RestException – 如果用户不存在

Returns

一个单独的 mlflow.server.auth.entities.User 对象。

Example 
export MLFLOW_TRACKING_USERNAME=admin
export MLFLOW_TRACKING_PASSWORD=password

from mlflow.server.auth.client import AuthServiceClient

client = AuthServiceClient("tracking_uri")
client.create_user("newuser", "newpassword")
user = client.get_user("newuser")

print(f"user_id: {user.id}")
print(f"username: {user.username}")
print(f"password_hash: {user.password_hash}")
print(f"is_admin: {user.is_admin}")
Output 
user_id: 3
username: newuser
password_hash: REDACTED
is_admin: False
update_experiment_permission(experiment_id: str, username: str, permission: str)[source]

为用户更新现有的实验权限。

Parameters

  • experiment_id – 实验的 id。

  • username – 用户名。

  • permission – 要授予的新权限。必须是“READ”、“EDIT”、“MANAGE”和“NO_PERMISSIONS”之一。

Raises

mlflow.exceptions.RestException – 如果用户不存在，或者该实验与该用户的配对没有权限，或者权限无效

Example 
export MLFLOW_TRACKING_USERNAME=admin
export MLFLOW_TRACKING_PASSWORD=password

from mlflow.server.auth.client import AuthServiceClient

client = AuthServiceClient("tracking_uri")
client.create_user("newuser", "newpassword")
client.create_experiment_permission("myexperiment", "newuser", "READ")
client.update_experiment_permission("myexperiment", "newuser", "EDIT")
update_registered_model_permission(name: str, username: str, permission: str)[source]

为用户更新现有的已注册模型权限。

Parameters

  • name – 已注册模型的名称。

  • username – 用户名。

  • permission – 要授予的新权限。必须是 “READ”、 “EDIT”、 “MANAGE” 和 “NO_PERMISSIONS” 之一。

Raises

mlflow.exceptions.RestException – 如果用户不存在，或该注册模型与用户的配对不存在权限，或该权限无效。

Example 
export MLFLOW_TRACKING_USERNAME=admin
export MLFLOW_TRACKING_PASSWORD=password

from mlflow.server.auth.client import AuthServiceClient

client = AuthServiceClient("tracking_uri")
client.create_user("newuser", "newpassword")
client.create_registered_model_permission("myregisteredmodel", "newuser", "READ")
client.update_registered_model_permission("myregisteredmodel", "newuser", "EDIT")
update_user_admin(username: str, is_admin: bool)[source]

更新特定用户的管理员状态。

Parameters

  • username – 用户名。

  • is_admin – 新的管理员状态。

Raises

mlflow.exceptions.RestException – 如果用户不存在

Example 
export MLFLOW_TRACKING_USERNAME=admin
export MLFLOW_TRACKING_PASSWORD=password

from mlflow.server.auth.client import AuthServiceClient

client = AuthServiceClient("tracking_uri")
client.create_user("newuser", "newpassword")

client.update_user_admin("newuser", True)
update_user_password(username: str, password: str)[source]

更新特定用户的密码。

Parameters

  • username – 用户名。

  • password – 新密码。

Raises

mlflow.exceptions.RestException – 如果用户不存在

Example 
export MLFLOW_TRACKING_USERNAME=admin
export MLFLOW_TRACKING_PASSWORD=password

from mlflow.server.auth.client import AuthServiceClient

client = AuthServiceClient("tracking_uri")
client.create_user("newuser", "newpassword")

client.update_user_password("newuser", "anotherpassword")

mlflow.server.auth.entities

class mlflow.server.auth.entities.ExperimentPermission(experiment_id, user_id, permission)[source]

基类： object

property experiment_id
classmethod from_json(dictionary)[source]
property permission
to_json()[source]
property user_id
class mlflow.server.auth.entities.RegisteredModelPermission(name, user_id, permission)[source]

基类： object

classmethod from_json(dictionary)[source]
property name
property permission
to_json()[source]
property user_id
class mlflow.server.auth.entities.User(id_, username, password_hash, is_admin, experiment_permissions=None, registered_model_permissions=None)[source]

基类： object

property experiment_permissions
classmethod from_json(dictionary)[source]
property id
property is_admin
property password_hash
property registered_model_permissions
to_json()[source]
property username