doc: Update README

T0217 · Oct 1, 2024 · e6946ca · e6946ca
1 parent 80e4d9a
commit e6946ca
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -87,7 +87,7 @@ sequential.visualize_html(output_path)
 
 `SDQCPy` supports various methods, the implementation of these methods are using [`ydata-synthetic`](https://github.com/ydataai/ydata-synthetic) and [`SDV`](https://github.com/sdv-dev/SDV).
 
->   [!Tip]
+>   [!TIP]
 >
 >   ***We only display simple code here, and the parameters of each model can be further modified as needed.***
 
@@ -101,10 +101,10 @@ sequential.visualize_html(output_path)
     ydata_synth = YDataSynthesizer(data=raw_data)
     synthetic_data = ydata_synth.generate()
     ```
-    
-    >   [!WARNING]
-    >
-    >   ***In the latest version, [`ydata-synthetic`](https://github.com/ydataai/ydata-synthetic) has switched to using [ydata-sdk](https://github.com/ydataai/ydata-sdk). However, since synthetic data is only a supplementary feature of this library, it has not been updated yet.***
+
+>   [!IMPORTANT]
+>
+>   ***In the latest version, [`ydata-synthetic`](https://github.com/ydataai/ydata-synthetic) has switched to using [ydata-sdk](https://github.com/ydataai/ydata-sdk). However, since synthetic data is only a supplementary feature of this library, it has not been updated yet.***    
 
 - **SDV Synthesizer**
 
@@ -119,6 +119,7 @@ sequential.visualize_html(output_path)
 
 ## Workflow
 `SDQCPy` use the process shown below to perform the quality check and analysis:
+
 ```mermaid
 ---
 title Main Idea

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -83,7 +83,7 @@ sequential.visualize_html(output_path)
 
 `SDQCPy` 提供了多种生成合成数据的方法，这些方法的实现使用[`ydata-synthetic`](https://github.com/ydataai/ydata-synthetic) 和 [`SDV`](https://github.com/sdv-dev/SDV)。
 
-> [!Tip]
+> [!TIP]
 >
 >   ***本库仅展示简单代码，每个模型的参数可以根据您的需求进行进一步修改。***
 
@@ -98,9 +98,9 @@ sequential.visualize_html(output_path)
     synthetic_data = ydata_synth.generate()
     ```
 
-    >   [!WARNING]
-    >
-    >   ***在最新版本中，[`ydata-synthetic`](https://github.com/ydataai/ydata-synthetic) 已经切换到使用 [ydata-sdk](https://github.com/ydataai/ydata-sdk)。然而，由于合成数据只是本库的补充功能，因此尚未更新。***
+>   [!IMPORTANT]
+>
+>   ***在最新版本中，[`ydata-synthetic`](https://github.com/ydataai/ydata-synthetic) 已经切换到使用 [ydata-sdk](https://github.com/ydataai/ydata-sdk)。然而，由于合成数据只是本库的补充功能，因此尚未更新。***
 
 - **SDV Synthesizer**