昇腾社区首页
中文
注册

main_exit

接口功能

exit组件入口,自带命令行输入参数。无论前面的组件执行成功与否,此接口必须在一次流程运行结束后执行,用来帮训练流程清理残留资源。

接口引用路径

ockics.entry.main_exit

接口格式

函数:main_exit(s3_endpoint=None, s3_ak=None, s3_sk=None, s3_secure=None, s3_certcheck=None)

输入参数

参数

类型

是否必选

说明

取值要求

s3_endpoint

str

可选

组件访问minio存储服务器的endpoint。如果调用时不输入,则默认传入None,内部会自动从环境变量S3_ENDPOINT_URL中获取endpoint。

函数参数,url:port。

s3_ak

str

可选

组件访问minio存储服务器的access key。如果调用时不输入,则默认传入None,内部会自动从环境变量ACCESS_KEY_ID中获取access key。

函数参数,access key字符串。

s3_sk

str

可选

组件访问minio存储服务器的secret key。如果调用时不输入,则默认传入None,内部会自动从环境变量SECRET_ACCESS_KEY中获取secret key。

函数参数,secret key字符串。

s3_secure

bool

可选

访问minio时是否使能https,默认值False。如果调用时不输入,则默认传入None,内部会自动从环境变量ACCESS_SECURE中获取值。开启证书认证时,可以使用环境变量SSL_CERT_FILE指定本地的证书路径。

函数参数:

  • True
  • False

ACCESS_SECURE环境变量使用"True"/"False"字符串代表True/False。

s3_certcheck

bool

可选

预留参数,当前版本暂未使用。

函数参数:

  • True
  • False

-tw/--work-url

str

必选

指定组件运行的工作目录,工作目录是一个s3路径。组件运行过程中的中间输入文件会存放在工作目录下,供其他组件或者ics-manager使用。

命令行输入参数,一个s3存储路径,如:“s3://inclearning/yolov5”

-sa/--standalone

bool

可选

调试使用,输入此参数,除了下载输入数据,中途可不访问s3服务,方便调试。

命令行输入参数:

  • True
  • False

-h/--help

str

可选

查看帮助信息并退出。

命令行输入参数,查看帮助信息并退出。

返回值

使用样例

from ockics.entry import main_exit
if __name__ == "__main__":
    main_exit()