SEUyishu commited on
Commit
e2e8735
·
verified ·
1 Parent(s): 51e7c6b

Update mcp_output/README_MCP.md

Browse files
Files changed (1) hide show
  1. mcp_output/README_MCP.md +146 -20
mcp_output/README_MCP.md CHANGED
@@ -6,19 +6,126 @@
6
 
7
  MatDeepLearn MCP 服务提供以下工具:
8
 
9
- | 工具名称 | 描述 | 支持直接传入文件内容 |
10
- |---------|------|-------------------|
11
- | `check_environment` | 检查环境配置和 GPU 可用性 | - |
12
- | `list_available_models` | 列出所有可用 GNN 模型 | - |
13
- | `get_model_config` | 获取特定模型默认配置 | - |
14
- | `quick_structure_analysis` | **推荐** 快速分析结构文件 | ✅ |
15
- | `analyze_structure` | 分析原子结构文件 | ✅ |
16
- | `process_structure_data` | 将原子结构数据处为图格式 | ✅ |
17
- | `get_dataset_info` | 获取数据集信息 | ✅ |
18
- | `train_model` | 训练 GNN 模型 | - |
19
- | `predict_properties` | 使用训练好的模型预测结构的属性 | - |
20
- | `cross_validation` | 执行 k 折交叉验证 | - |
21
- | `compare_models` | 比较不同 GNN 模型的性能 | - |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
22
 
23
  ## 🌟 远程 MCP 使用指南(在 Cursor 中使用)
24
 
@@ -60,22 +167,41 @@ _cell_angle_gamma 90.0
60
  }
61
  ```
62
 
63
- #### analyze_structure
64
  ```json
65
  {
66
- "file_content": "完整的文件内容字符串",
67
- "file_format": "cif"
68
  }
69
  ```
70
 
71
- #### process_structure_data(处理多个结构)
72
  ```json
73
  {
74
- "structure_contents": {
 
75
  "struct1.cif": "CIF 内容...",
76
  "struct2.cif": "CIF 内容..."
77
- },
78
- "targets_csv": "struct1,1.5\nstruct2,2.3"
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
79
  }
80
  ```
81
 
 
6
 
7
  MatDeepLearn MCP 服务提供以下工具:
8
 
9
+ ### 🔧 环境与模型信息
10
+ | 工具名称 | 描述 |
11
+ |---------|------|
12
+ | `check_environment` | 检查环境配置和 GPU 可用 |
13
+ | `list_available_models` | 列出所有可用GNN 模型 |
14
+ | `get_model_config` | 获取特定模型的默认配置 |
15
+
16
+ ### 📁 会话管(新增)
17
+ | 工具名称 | 描述 |
18
+ |---------|------|
19
+ | `create_session` | 创建工作会话 |
20
+ | `get_session_info` | 获取会话信息 |
21
+ | `list_sessions` | 列出所有会话 |
22
+ | `delete_session` | 删除会话 |
23
+
24
+ ### 📤 数据上传(新增)
25
+ | 工具名称 | 描述 |
26
+ |---------|------|
27
+ | `upload_structure_file` | 上传单个结构文件 |
28
+ | `upload_structure_files_batch` | 批量上传多个结构文件 |
29
+ | `upload_targets` | 上传 targets.csv 目标属性文件 |
30
+ | `upload_binary_file` | 上传二进制文件(如预训练模型) |
31
+
32
+ ### 🔬 结构分析
33
+ | 工具名称 | 描述 |
34
+ |---------|------|
35
+ | `quick_structure_analysis` | **推荐** 快速分析结构文件内容 |
36
+ | `analyze_structure` | 分析原子结构文件 |
37
+
38
+ ### 🏋️ 模型训练(新增)
39
+ | 工具名称 | 描述 |
40
+ |---------|------|
41
+ | `process_session_data` | 处理会话中的结构数据为图格式 |
42
+ | `train_session_model` | 在会话数据上训练 GNN 模型 |
43
+ | `run_cross_validation_session` | 执行 k 折交叉验证 |
44
+
45
+ ### 📊 预测与评估(新增)
46
+ | 工具名称 | 描述 |
47
+ |---------|------|
48
+ | `predict_with_session_model` | 使用训练好的模型进行预测 |
49
+ | `list_session_models` | 列出会话中的所有模型 |
50
+ | `compare_session_models` | 比较多个模型的性能 |
51
+ | `download_model` | 下载训练好的模型(base64 编码) |
52
+
53
+ ### 📁 数据集信息
54
+ | 工具名称 | 描述 |
55
+ |---------|------|
56
+ | `get_dataset_info` | 获取数据集信息 |
57
+ | `process_structure_data` | 处理结构数据为图格式(传统方式) |
58
+
59
+ ---
60
+
61
+ ## 🚀 完整工作流程示例
62
+
63
+ ### 步骤 1: 创建会话
64
+
65
+ ```
66
+ 请创建一个名为 "my_materials" 的新会话
67
+ ```
68
+
69
+ 返回的 `session_id` 将用于后续所有操作。
70
+
71
+ ### 步骤 2: 上传结构文件
72
+
73
+ **单个文件:**
74
+ ```
75
+ 使用 upload_structure_file 上传以下 CIF 文件到会话 session_xxx:
76
+ 文件名:NaCl.cif
77
+ 内容:
78
+ data_NaCl
79
+ _cell_length_a 5.64
80
+ ...
81
+ ```
82
+
83
+ **批量上传:**
84
+ ```
85
+ 使用 upload_structure_files_batch 批量上传结构文件到会话 session_xxx:
86
+ {
87
+ "NaCl.cif": "data_NaCl...",
88
+ "ZnO.cif": "data_ZnO...",
89
+ "TiO2.cif": "data_TiO2..."
90
+ }
91
+ ```
92
+
93
+ ### 步骤 3: 上传目标属性
94
+
95
+ ```
96
+ 使用 upload_targets 上传以下 targets.csv 到会话 session_xxx:
97
+ NaCl,1.5
98
+ ZnO,2.3
99
+ TiO2,3.1
100
+ ```
101
+
102
+ ### 步骤 4: 处理数据
103
+
104
+ ```
105
+ 使用 process_session_data 处理会话 session_xxx 中的数据
106
+ ```
107
+
108
+ ### 步骤 5: 训练模型
109
+
110
+ ```
111
+ 使用 train_session_model 在会话 session_xxx 上训练 CGCNN_demo 模型,训练 100 个 epoch
112
+ ```
113
+
114
+ ### 步骤 6: 评估与预测
115
+
116
+ ```
117
+ 使用 list_session_models 查看会话 session_xxx 中的所有模型
118
+
119
+ 使用 predict_with_session_model 对新结构进行预测
120
+ ```
121
+
122
+ ### 步骤 7: 下载模型
123
+
124
+ ```
125
+ 使用 download_model 下载会话 session_xxx 中的模型 CGCNN_demo_xxx.pth
126
+ ```
127
+
128
+ ---
129
 
130
  ## 🌟 远程 MCP 使用指南(在 Cursor 中使用)
131
 
 
167
  }
168
  ```
169
 
170
+ #### create_session
171
  ```json
172
  {
173
+ "session_name": "my_project" // 可选,会话名称
 
174
  }
175
  ```
176
 
177
+ #### upload_structure_files_batch
178
  ```json
179
  {
180
+ "session_id": "session_xxx",
181
+ "files": {
182
  "struct1.cif": "CIF 内容...",
183
  "struct2.cif": "CIF 内容..."
184
+ }
185
+ }
186
+ ```
187
+
188
+ #### upload_targets
189
+ ```json
190
+ {
191
+ "session_id": "session_xxx",
192
+ "targets_content": "struct1,1.5\nstruct2,2.3",
193
+ "validate": true
194
+ }
195
+ ```
196
+
197
+ #### train_session_model
198
+ ```json
199
+ {
200
+ "session_id": "session_xxx",
201
+ "model_name": "CGCNN_demo",
202
+ "epochs": 100,
203
+ "batch_size": 32,
204
+ "learning_rate": 0.002
205
  }
206
  ```
207