refactor: model

swankit/callback/models/__init__.py

@@ -7,7 +7,7 @@
 @Description:
     与回调函数通信时的模型
 """
-from .key import MediaBuffer, MetricInfo, ColumnInfo, MetricErrorInfo, KeyClass, SectionType, ColumnConfig, YRange
+from .key import MediaBuffer, MetricInfo, ColumnInfo, MetricErrorInfo, ColumnClass, SectionType, ColumnConfig, YRange
 from .error import OperateErrorInfo
 from .runtime import RuntimeInfo
 
@@ -18,7 +18,7 @@
     "MetricErrorInfo",
     "OperateErrorInfo",
     "RuntimeInfo",
-    "KeyClass",
+    "ColumnClass",
     "SectionType",
     "ColumnConfig",
     "YRange",

swankit/callback/models/key.py

@@ -13,7 +13,7 @@
 from urllib.parse import quote
 import os
 
-KeyClass = Literal["CUSTOM", "SYSTEM"]
+ColumnClass = Literal["CUSTOM", "SYSTEM"]
 SectionType = Literal["PINNED", "HIDDEN", "PUBLIC", "SYSTEM"]
 YRange = Optional[Tuple[Optional[float], Optional[float]]]
 
@@ -34,9 +34,9 @@ class ColumnInfo:
     def __init__(
         self,
         key: str,
-        key_id: str,
-        key_name: str,
-        key_class: KeyClass,
+        kid: str,
+        name: str,
+        cls: ColumnClass,
         chart_type: ChartType,
         chart_reference: ChartReference,
         section_name: Optional[str],
@@ -47,10 +47,10 @@ def __init__(
     ):
         """
         生成的列信息对象
-        :param key: 生成的列名称
-        :param key_id: 当前实验下，列的唯一id，与保存路径等信息有关
-        :param key_name: key的别名
-        :param key_class: 列的类型，CUSTOM为自定义列，SYSTEM为系统生成列
+        :param key: 生成的列名称，作为索引键值
+        :param kid: 当前实验下，列的唯一id，与保存路径等信息有关，与云端请求无关
+        :param name: 列的别名
+        :param cls: 列的类型，CUSTOM为自定义列，SYSTEM为系统生成列
         :param chart_type: 列对应的图表类型
         :param chart_reference: 这个列对应图表的参考系，step为步数，time为时间
         :param section_name: 列的组名
@@ -59,9 +59,9 @@ def __init__(
         :param config: 列的额外配置信息
         """
         self.key = key
-        self.key_id = key_id
-        self.key_name = key_name
-        self.key_class = key_class
+        self.kid = kid
+        self.name = name
+        self.cls = cls
 
         self.chart_type = chart_type
         self.chart_reference = chart_reference
@@ -139,7 +139,7 @@ def __init__(
         self.metric_summary = metric_summary
         self.metric_step = metric_step
         self.metric_epoch = metric_epoch
-        _id = self.column_info.key_id
+        _id = self.column_info.kid
         self.metric_file_path = None if self.is_error else os.path.join(swanlab_logdir, _id, metric_file_name)
         self.summary_file_path = None if self.is_error else os.path.join(swanlab_logdir, _id, self.__SUMMARY_NAME)
         self.swanlab_media_dir = swanlab_media_dir

swankit/callback/models/runtime.py

@@ -8,7 +8,7 @@
     运行时信息模型
 """
 from abc import ABC, abstractmethod
-from typing import Optional, Any
+from typing import Optional
 import json
 import yaml
 import os
@@ -108,13 +108,7 @@ def to_dict(self):
         # 没有在__init__中直接修改是因为可能会有其他地方需要原始数据，并且会丢失一些性能
         if self.__data is not None:
             return self.__data
-        self.__data = {
-            k: {
-                "value": v,
-                "sort": i,
-                "desc": ""
-            } for i, (k, v) in enumerate(self.info.items())
-        }
+        self.__data = {k: {"value": v, "sort": i, "desc": ""} for i, (k, v) in enumerate(self.info.items())}
         return self.__data
 
 
@@ -130,14 +124,10 @@ def __init__(self, requirements: str = None, metadata: dict = None, config: dict
         :param metadata: 系统信息
         :param config: 上传的配置信息
         """
-        self.requirements: Optional[RequirementInfo] = RequirementInfo(
-            requirements
-        ) if requirements is not None else None
+        self.requirements: Optional[RequirementInfo] = (
+            RequirementInfo(requirements) if requirements is not None else None
+        )
 
-        self.metadata: Optional[MetadataInfo] = MetadataInfo(
-            metadata
-        ) if metadata is not None else None
+        self.metadata: Optional[MetadataInfo] = MetadataInfo(metadata) if metadata is not None else None
 
-        self.config: Optional[ConfigInfo] = ConfigInfo(
-            config
-        ) if config is not None else None
+        self.config: Optional[ConfigInfo] = ConfigInfo(config) if config is not None else None