Skip to content

Conversation

@SAKURA-CAT
Copy link
Member

@SAKURA-CAT SAKURA-CAT commented Apr 26, 2024

Description

  • 重新设计了全局变量形式,特别注意的是,全局变量将影响代码的可维护性,应该尽量避免使用
  • 支持了相同进程中多次初始化实验
  • 新的FONT.loading,从协程改为普通函数,避免上下文重复进入的问题
  • 对SwanLabRun类增加了一些api,见下面详细描述
  • 完善部分单元测试

新增api

下面如果使用run说明是实例方法,SwanLabRun说明是静态方法——目前没有添加类方法。

swanlab.get_run

通过此方法可以获取当前的运行实例

run.finish

标记实验状态为成功。在设计上手动执行finish说明是成功的实验,在执行此方法后会返回当前SwanLabRun实例,但是在此方法以后swanlab.get_run的返回值将为None

当然也可以设置参数state为SwanLabRunState.CRASHED,此时必须输入第二个参数error,表示当前的错误,用于记录。

如果是云端版本,此实验将会关闭云端上传线程池,并完成上传收尾工作。因此此方法在云端版本下会有一定耗时。

可选择是否开启动画,默认为开启。

run.state

此为属性,代表当前实验的状态,返回枚举SwanLabRunState中的一个,可能是运行、崩溃、成功等

于此同时添加了is_running、is_crashed等接口,用于便捷获取状态

SwanLabRun.get_state

此为方法,返回当前实验的状态,为枚举SwanLabRunState中的一个,可能是未开始、运行、崩溃、成功等

新增类

新增枚举类SwanLabRunState,用于状态标记,具体内容可看源码

@SAKURA-CAT SAKURA-CAT self-assigned this Apr 26, 2024
@SAKURA-CAT SAKURA-CAT added 🐛 bug Something isn't working 💪 enhancement New feature or request labels Apr 26, 2024
@SAKURA-CAT SAKURA-CAT changed the title update doc opt/finish Apr 26, 2024
@SAKURA-CAT SAKURA-CAT marked this pull request as ready for review April 26, 2024 13:21
@SAKURA-CAT SAKURA-CAT requested a review from Zeyi-Lin April 26, 2024 13:23
@SAKURA-CAT SAKURA-CAT merged commit d318804 into main Apr 26, 2024
@SAKURA-CAT SAKURA-CAT deleted the opt/finish branch April 26, 2024 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🐛 bug Something isn't working 💪 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants