integration mlflow

Author: Zeyi-Lin

.vitepress/en.ts

@@ -177,6 +177,7 @@ function sidebarIntegration(): DefaultTheme.SidebarItem[] {
       { text: 'Keras', link: 'integration-keras' },
       { text: 'LightGBM', link: 'integration-lightgbm'},
       { text: 'LLaMA Factory', link: 'integration-llama-factory'},
+      { text: 'MLFlow', link: 'integration-mlflow'},
       { text: 'MMEngine', link: 'integration-mmengine' },
       { text: 'MMPretrain', link: 'integration-mmpretrain' },
       { text: 'MMDetection', link: 'integration-mmdetection' },

.vitepress/zh.ts

@@ -193,6 +193,7 @@ function sidebarIntegration(): DefaultTheme.SidebarItem[] {
       { text: 'Keras', link: 'integration-keras' },
       { text: 'LightGBM', link: 'integration-lightgbm'},
       { text: 'LLaMA Factory', link: 'integration-llama-factory'},
+      { text: 'MLFlow', link: 'integration-mlflow'},
       { text: 'MMEngine', link: 'integration-mmengine' },
       { text: 'MMPretrain', link: 'integration-mmpretrain' },
       { text: 'MMDetection', link: 'integration-mmdetection' },

en/guide_cloud/integration/integration-mlflow.md

@@ -0,0 +1,72 @@
+# MLFlow
+
+[MLFlow](https://github.com/mlflow/mlflow) is an open-source machine learning lifecycle management platform created and maintained by Databricks. It aims to assist data scientists and machine learning engineers in managing the entire lifecycle of machine learning projects more efficiently, including experiment tracking, model management, model deployment, and collaboration. MLflow is designed to be modular and can integrate with any machine learning library, framework, or tool.
+
+![mlflow](./mlflow/logo.png)
+
+:::warning Synchronization Tutorials for Other Tools
+
+• [TensorBoard](/zh/guide_cloud/integration/integration-tensorboard.md)
+• [Weights & Biases](/zh/guide_cloud/integration/integration-wandb.md)
+:::
+
+**You can convert projects from MLflow to SwanLab:**
+
+::: info
+The current version only supports the conversion of scalar charts.
+:::
+
+[[toc]]
+
+## 1. Preparation
+
+**Required: MLflow Service URL**
+
+First, note down the **URL** of the MLflow service, such as `http://127.0.0.1:5000`.
+
+> If the MLflow service is not yet started, you need to start it using the `mlflow ui` command and note down the URL.
+
+**Optional: Experiment ID**
+
+If you only want to convert a specific experiment, note down the experiment ID as shown in the image below.
+
+![](./mlflow/ui-1.png)
+
+## 2. Method 1: Command Line Conversion
+
+Conversion Command:
+
+```bash
+swanlab convert -t mlflow --mlflow-url <MLFLOW_URL> --mlflow-exp <MLFLOW_EXPERIMENT_ID>
+```
+
+Supported parameters:
+
+• `-t`: Conversion type, options include wandb, tensorboard, and mlflow.
+• `-p`: SwanLab project name.
+• `-w`: SwanLab workspace name.
+• `--cloud`: (bool) Whether the upload mode is "cloud", default is True.
+• `-l`: Log directory path.
+• `--mlflow-url`: URL of the MLflow service.
+• `--mlflow-exp`: MLflow experiment ID.
+
+If `--mlflow-exp` is not specified, all experiments under the specified project will be converted; if specified, only the designated experiment group will be converted.
+
+## 3. Method 2: Conversion Within Code
+
+```python
+from swanlab.converter import MLFLowConverter
+
+mlflow_converter = MLFLowConverter(project="mlflow_converter")
+# mlflow_exp is optional
+mlflow_converter.run(tracking_uri="http://127.0.0.1:5000", experiment="1")
+```
+
+The effect is consistent with command line conversion.
+
+Parameters supported by `MLFLowConverter`:
+
+• `project`: SwanLab project name.
+• `workspace`: SwanLab workspace name.
+• `cloud`: (bool) Whether the upload mode is "cloud", default is True.
+• `logdir`: ID of the wandb Run (a specific experiment under the project).

en/guide_cloud/integration/mlflow/logo.png

@@ -0,0 +1,73 @@
+# MLFlow
+
+[MLFlow](https://github.com/mlflow/mlflow) 是一个开源的机器学习生命周期管理平台，由 Databricks 创建并维护。它旨在帮助数据科学家和机器学习工程师更高效地管理机器学习项目的整个生命周期，包括实验跟踪、模型管理、模型部署和协作。MLflow 的设计是模块化的，可以与任何机器学习库、框架或工具集成。
+
+![mlflow](./mlflow/logo.png)
+
+:::warning 其他工具的同步教程
+
+- [TensorBoard](/zh/guide_cloud/integration/integration-tensorboard.md)
+- [Weights & Biases](/zh/guide_cloud/integration/integration-wandb.md)
+:::
+
+**你可以用将MLflow上的项目转换到SwanLab：**
+
+::: info
+在当前版本暂仅支持转换标量图表。
+:::
+
+[[toc]]
+
+
+## 1. 准备工作
+
+**（必须）mlflow服务的url链接**
+
+首先，需要记下mlflow服务的**url链接**，如`http://127.0.0.1:5000`。
+
+> 如果还没有启动mlflow服务，那么需要使用`mlflow ui`命令启动服务，并记下url链接。
+
+**（可选）实验ID**
+
+如果你只想转换其中的一组实验，那么在下图所示的地方，记下该实验ID。
+
+![](./mlflow/ui-1.png)
+
+## 2. 方式一：命令行转换
+
+转换命令行：
+
+```bash
+swanlab convert -t mlflow --mlflow-url <MLFLOW_URL> --mlflow-exp <MLFLOW_EXPERIMENT_ID>
+```
+
+支持的参数如下：
+
+- `-t`: 转换类型，可选wandb、tensorboard和mlflow。
+- `-p`: SwanLab项目名。
+- `-w`: SwanLab工作空间名。
+- `--cloud`: (bool) 是否上传模式为"cloud"，默认为True
+- `-l`: logdir路径。
+- `--mlflow-url`: mlflow服务的url链接。
+- `--mlflow-exp`: mlflow实验ID。
+
+如果不填写`--mlflow-exp`，则会将指定项目下的全部实验进行转换；如果填写，则只转换指定的实验组。
+
+## 3. 方式二：代码内转换
+
+```python
+from swanlab.converter import MLFLowConverter
+
+mlflow_converter = MLFLowConverter(project="mlflow_converter")
+# mlflow_exp可选
+mlflow_converter.run(tracking_uri="http://127.0.0.1:5000", experiment="1")
+```
+
+效果与命令行转换一致。
+
+`MLFLowConverter`支持的参数：
+
+- `project`: SwanLab项目名。
+- `workspace`: SwanLab工作空间名。
+- `cloud`: (bool) 是否上传模式为"cloud"，默认为True。
+- `logdir`: wandb Run（项目下的某一个实验）的id。

en/guide_cloud/integration/mlflow/ui-1.png

@@ -7,6 +7,7 @@
 :::warning 其他工具的同步教程
 
 - [Wandb](/zh/guide_cloud/integration/integration-wandb.md)
+- [MLFlow](/zh/guide_cloud/integration/integration-mlflow.md)
 :::
 
 **你可以用两种方式将使用Tensorboard跟踪的项目同步到SwanLab：**
@@ -129,6 +130,15 @@ for epoch in range(2, epochs):
 swanlab convert -t tensorboard --tb_logdir [TFEVENT_LOGDIR]
 ```
 
+支持的参数如下：
+
+- `-t`: 转换类型，可选wandb、tensorboard和mlflow。
+- `-p`: SwanLab项目名。
+- `-w`: SwanLab工作空间名。
+- `--cloud`: (bool) 是否上传模式为"cloud"，默认为True
+- `-l`: logdir路径。
+- `--tb_logdir`: Tensorboard日志文件路径。
+
 这里的`[TFEVENT_LOGDIR]`是指你先前用Tensorboard记录实验时，生成的日志文件路径。
 
 SwanLab Converter将会自动检测文件路径及其子目录下的`tfevent`文件（默认子目录深度为3），并为每个`tfevent`文件创建一个SwanLab实验。

zh/guide_cloud/integration/integration-mlflow.md

@@ -7,6 +7,7 @@ Weights & Biases (Wandb) 是一个用于机器学习和深度学习项目的实
 :::warning 其他工具的同步教程
 
 - [TensorBoard](/zh/guide_cloud/integration/integration-tensorboard.md)
+- [MLFlow](/zh/guide_cloud/integration/integration-mlflow.md)
 :::
 
 **你可以用两种方式将Wandb上的项目同步到SwanLab：**
@@ -108,6 +109,10 @@ swanlab convert -t wandb --wb-project [WANDB_PROJECT_NAME] --wb-entity [WANDB_EN
 支持的参数如下：
 
 - `-t`: 转换类型，可选wandb与tensorboard。
+- `-p`: SwanLab项目名。
+- `-w`: SwanLab工作空间名。
+- `--cloud`: (bool) 是否上传模式为"cloud"，默认为True
+- `-l`: logdir路径。
 - `--wb-project`：待转换的wandb项目名。
 - `--wb-entity`：wandb项目所在的空间名。
 - `--wb-runid`: wandb Run（项目下的某一个实验）的id。
@@ -123,4 +128,12 @@ wb_converter = WandbConverter()
 # wb_runid可选
 wb_converter.run(wb_project="WANDB_PROJECT_NAME", wb_entity="WANDB_USERNAME")
 ```
-效果与命令行转换一致。
+
+效果与命令行转换一致。
+
+`WandbConverter`支持的参数：
+
+- `project`: SwanLab项目名。
+- `workspace`: SwanLab工作空间名。
+- `cloud`: (bool) 是否上传模式为"cloud"，默认为True。
+- `logdir`: wandb Run（项目下的某一个实验）的id。