## Preliminary
1. 对于每一个类，将数据如下处理, 保存成xlsx或者xls文件  

|       |       |       |       |  
|-------|-------|-------|-------|
| arbitrary value | value | arbitrary value | vlaue |
| arbitrary value | value | arbitrary value | vlaue |

即偶数列为一次循环的数据，奇数列为任意值即可

2. 配置conda环境  
> pass


## Quickly Start
1. 将项目文件夹编辑成**日期+项目名**  
2. 编辑好label名称，label名称命名变成英文或者数字  
>例如：”PDMS“， ”1“ 等, , 如果你的每一个类，下面又多个子特征则可以建立一个文件夹，在创建神经网络类的时候将**isDir**参数改成True即可.  
>详细如下图：  
>2.1. 如果只有一类特征  
> ![image.png](https://qq-pic.oss-cn-nanjing.aliyuncs.com/img/2024-12-28-f7f922-image.png)  
>2.2. 如果有多类特征  
>![image.png](https://qq-pic.oss-cn-nanjing.aliyuncs.com/img/2024-12-28-e6a2bf-image.png)  
3. 将准备好的文件夹移动到**Static**文件夹中（没有就建立），如果没有 **Result** 建立一个**Result**文件夹用来存放结果   

4. 读取数据：  
```python
  # 以MaterialDiv为例
  projet_name = '20241009MaterialDiv'                                           
  label_names = ['Acrlic', 'Ecoflex', 'PDMS', 'PLA', 'Wood']
  # 使用库 divSet 划分训练集和数据集
  data = load_data(projet_name, label_names, isDir=False, fileClass='xlsx')
```

5. 创建神经网络类  
```python
   model = Qmlp(
     X_train=X_train, X_test=X_test, y_train=y_train, y_test= y_test,
     hidden_layers = [128],
     dropout_rate=0
   )
```

6. 训练并获取数据
```python
  pca_2d, pca_3d = model.get_PCA()

  model.fit(300)
  
  cm = model.get_cm()
  epoch_data = model.get_epoch_data()

  save_to_xlsx(project_name=projet_name, file_name="pca_2d", data=pca_2d)
  save_to_xlsx(project_name=projet_name, file_name="pca_3d", data=pca_3d)
  save_to_xlsx(project_name=projet_name, file_name="cm", data=cm )
  save_to_xlsx(project_name=projet_name, file_name="acc_and_loss", data=epoch_data)
```
## Advanced
### loadData 处理数据工具的使用
||参数类型|默认值|参数作用|
|---|---|---|---|
|folder|str|必填项|指定数据存放在Static下的哪个文件夹|
|lableNames| list| 必填项| 指定每一个类的label名称, 既可以用来读取相应的文件，也可以用来给label排序|
|isDir| bool| True| 若是上文Quickly Strat章节2.1情况需要改成False，2.2情况则是True|
|fileClass| str| 'xlsx'| 数据文件的后缀|
> tips: 数据读取是按照一下情况读取的(2.1和2.2是Quickly Start章节的2.1和2.2简称)：
> 2.1情况的第一类数据读取的地址是 ./Static/folder/labelsNames[0].xlsx, 其他类同理
> 2.2情况的第二类数据读取的地址是 ./Static/folder/labelsNames[0]/*.xlsx, 其他同理
### Qmlp 模型使用
> pass