# 自定义算法

Octopus平台支持上传自定义算法，您可通过上传算法文件，在线完成训练任务，并生成模型用于自动标注。自定义算法必须使用训练服务支持的训练框架PyTorch和Tensorflow，支持的Python版本为3.6，训练框架及Python版本将持续扩充。

# 添加自定义算法

在添加算法页面，您需要填写算法基本信息，AI引擎，以及算法参数三部分的内容。

# 操作步骤

单击“训练服务>算法管理>创建训练算法”。
填写算法基本信息，算法名称以及算法概要描述信息。
- 算法名称：包含中英文、数字、“_”“-”，不得超过64个字符；
- 算法描述：简要描述算法，不包含“@#$%^&*<>/”，不得超过255个字符。
选择AI引擎和样本类型。
- AI引擎
  
  支持的引擎框架为Tensorflow和PyTorch，支持的Python版本为3.6。
- 样本类型
  
  当前支持图片、3D点云。
注意： 自定义算法创建后，不能再修改“AI引擎”和“样本类型”，请认真填写。
配置算法参数。

需要指定算法的上传方式、Boot文件启动路径，填写启动命令参数以及参数值。
- 算法文件
  
  支持本地上传算法文件和从OBS导入算法文件两种方式。本地上传算法文件，您需要将算法文件压缩成一个“.zip”包后上传，且压缩包小于5M。压缩包内容可参考算法文件说明；通过OBS上传的算法文件不能超过500M，文件上传到OBS方式请参考如何上传文件到OBS桶？
  说明： 算法文件压缩步骤：
  1. 进入到项目工程的根目录。
  2. 使用zip方式打包根目录下所有的文件及文件夹。
  - windows系统：选中当前目录下所有的文件及文件夹，以zip形式打包
  - Linux系统：zip -r xx.zip ./
  1. 上传压缩包。
- Boot文件路径
  
  选择算法文件中的启动文件路径，文件路径为在算法文件中的相对路径，一般为根目录下“xxx.py”。启动文件编写详细说明请参考启动文件基本要求。
- 参数列表
  
  可以自定义boot文件的启动参数，需要在算法中定义。如下启动文件和参数列表，仅供参考：
  
  说明： 字符支持输入英文、数字、下划线以及“.”;
- 参数命令
  
  参数命令为运行启动脚本的shell命令，由配置的“Boot文件路径”和“参数列表中参数及参数值”组成，填写后会自动生成如下命令：
```
Main.py  --total_epoches=3 --img_size=[1333,800]  --batch_size=1 --optimizer_name=SGD
```
单击“创建”，页面显示“创建成功”提示，并在训练算法页面显示您新建的算法信息，则添加算法成功。

# 修改自定义算法

在算法管理页面，在需要修改的用户自定义算法后，单击“编辑”。
在编辑算法页面，修改算法信息。

支持修改的信息如下：
- 算法基本信息：算法名称、描述；
- 算法参数：Boot文件路径、参数列表、参数命令；
单击“更新”，在用户自定义算法页面，显示您修改后的算法信息。

# 删除自定义算法

若您创建的自定义算法不满足您的开发需求，可删除该算法。在“操作”一栏中，单击“删除”，点击再次确认，即可删除算法。删除后该算法无法恢复，请谨慎操作。

说明：

自定义算法处于“创建中”时，不能删除。

若正在使用算法进行训练任务时，不能删除。

# 查询自定义算法

您可根据算法名称或算法使用的AI引擎进行过滤，在搜索框内输入搜索内容，单击，进行查询。

# 编辑代码

您可以在线编辑自定义算法，在算法名称后“在线编辑”一栏单击“算法编辑”，进入该算法的在线编辑页面。如图，界面左侧显示的是该算法包的所有算法文件，以文件树的形式展示，支持新建文件夹和文件以及对已有文件重命名，更改界面基础配置。

新建文件夹：选中文件夹并单击，您将新建一个该文件夹的子文件夹；选中工程文件并单击，将会新建一个新的文件夹，与您已有的文件夹同级；
新建文件：单击新建文件，或右键文件夹，单击“新建文件”
修改文件：右键并单击“重命名”，您可以对文件名称进行修改；
删除文件：右键并单击“删除”，您可以删除文件。

说明： 删除后不可恢复，请谨慎操作。
配置界面：单击，按照喜好自定义配置编辑界面基本属性；
删除当前算法文件：单击“删除”，删除当前页面的算法文件。删除后不可恢复，请谨慎操作。
保存算法文件：单击“保存”，保存当前算法。算法更新完毕请及时保存。

← 训练总览系统内置算法 →