feat: add parallel run support and update run_id validation (#1491)

* Add parallel run support and update run_id validation

Introduce a parallel run option and related env var, propagate slug usage, and relax run_id validation:

- Add a `parallel` parameter to SwanLabInitializer (and SWANLAB_RUN_PARALLEL env) to enable shared parallel runs; when enabled it forces mode='cloud', resume='allow', and generates an id if missing.
- Load `parallel` from config/env and validate it during initialization; minor warning/formatting tweaks.
- Add ExperimentInfo.slug property and use it in Client.web_exp_url to prefer exp.slug over exp_id when available.
- Update run_id validation: allow lengths 1–64 and disallow characters '/ \ # ? % :', with corresponding updates to tests.
- Add missing import (random) required for id generation.

Tests updated to reflect new run_id rules and additional valid/invalid cases.

* Update sdk.py

* Update sdk.py

Author: SAKURA-CAT

swanlab/core_python/client/__init__.py

@@ -113,7 +113,7 @@ def web_proj_url(self) -> str:
 
     @property
     def web_exp_url(self) -> str:
-        return f"{self.web_proj_url}/runs/{self.exp_id}"
+        return f"{self.web_proj_url}/runs/{self.exp.slug or self.exp_id}"
 
     # ---------------------------------- http方法 ----------------------------------
 

swanlab/core_python/client/utils.py

@@ -83,6 +83,10 @@ def flag_id(self):
     def cuid(self):
         return self.__data["cuid"]
 
+    @property
+    def slug(self):
+        return self.__data["slug"]
+
     @property
     def name(self):
         return self.__data["name"]

swanlab/data/sdk.py

@@ -8,6 +8,8 @@
     在此处封装swanlab在日志记录模式下的各种接口
 """
 import os
+import random
+import secrets
 import time
 from datetime import datetime
 from typing import Union, Dict, Literal, List
@@ -108,6 +110,7 @@ def init(
         settings: Settings = None,
         id: str = None,
         resume: Union[Literal['must', 'allow', 'never'], bool] = None,
+        parallel: Union[Literal['none', 'shared'], bool] = None,
         reinit: bool = None,
         color: str = None,
         **kwargs,
@@ -186,6 +189,10 @@ def init(
                 - never: You cannot pass the `id` parameter, and a new run will be created.
             You can also pass a boolean value, where `True` is equivalent to 'allow' and `False` is equivalent to 'never'.
             [Notice that] This parameter is only valid when mode='cloud'
+        parallel : Literal['none', 'shared'], optional
+            Whether to run experiments in parallel or not:
+                - none: Run experiments sequentially.
+                - shared: Run experiments in parallel, equivalent to `mode='cloud' and resume='allow'`.
         id : str, optional
             The run ID of the previous run, which is used to resume the previous run.
         reinit : bool, optional
@@ -242,6 +249,7 @@ def init(
             public = _load_from_dict(load_data, "private", public)
             id = _load_from_dict(load_data, "id", id)
             resume = _load_from_dict(load_data, "resume", resume)
+            parallel = _load_from_dict(load_data, "parallel", parallel)
         # 1.2 初始化confi参数
         config = _init_config(config)
         # 如果config是以下几个类别之一，则抛出异常
@@ -263,6 +271,7 @@ def init(
         id = _load_from_env(SwanLabEnv.RUN_ID.value, id)
         logdir = _load_from_env(SwanLabEnv.SWANLOG_FOLDER.value, logdir)
         color = _load_from_env(SwanLabEnv.EXP_COLOR.value, color)
+        parallel = _load_from_env(SwanLabEnv.RUN_PARALLEL.value, parallel)
         # 2. 部分格式校验
         # 2.1 校验项目名称，默认实验名称为当前目录名
         project = project if project else os.path.basename(os.getcwd())
@@ -273,7 +282,9 @@ def init(
         # 2.2 校验实验名称
         # 处理空字符串或纯空格字符串情况
         if experiment_name is not None and not experiment_name.strip():
-            swanlog.warning("The experiment name is an empty or whitespace-only string, automatically converted to None.")
+            swanlog.warning(
+                "The experiment name is an empty or whitespace-only string, automatically converted to None."
+            )
             experiment_name = None
         if experiment_name:
             e = check_exp_name_format(experiment_name)
@@ -315,6 +326,11 @@ def init(
         # 3. 校验回调函数
         callbacks = check_callback_format(self.cbs + callbacks)
         self.cbs = []
+        # 4. 校验并行模式
+        if str(parallel).lower() in ["shared", "true", "yes"]:
+            resume = "allow"
+            mode = "cloud"
+            id = id or secrets.token_hex(4)
         # 5. 校验mode参数并适配 backup 模式
         mode = "cloud" if mode == "online" else mode
         mode, login_info = _init_mode(mode, folder_settings.mode)
@@ -325,7 +341,9 @@ def init(
         resume = resume or 'never'
         # 非 cloud 模式下，resume 只支持 'never'
         if resume in ('must', 'allow') and mode != "cloud":
-            swanlog.warning(f"resume='{resume}' is only supported in cloud mode, automatically switch to resume='never'.")
+            swanlog.warning(
+                f"resume='{resume}' is only supported in cloud mode, automatically switch to resume='never'."
+            )
             resume = 'never'
             id = None
         # 根据 resume 的最终值进行校验

swanlab/env.py

@@ -141,6 +141,10 @@ class SwanLabEnv(enum.Enum):
     """
     禁用Git功能，设置为true时不会采集Git信息
     """
+    RUN_PARALLEL = "SWANLAB_RUN_PARALLEL"
+    """
+    是否开启并行模式，设置为true时会并行运行实验，等同于mode='cloud' and resume='allow'
+    """
 
     @staticmethod
     def is_hostname(value: str) -> bool:

swanlab/formatter.py

@@ -188,17 +188,19 @@ def check_group_format(group: str, auto_cut: bool = True) -> str:
 def check_run_id_format(run_id: str = None) -> Optional[str]:
     """
     检查运行ID格式，要求：
-    1. 只能包含小写字母和数字
-    2. 长度为21个字符
+    1. 长度为1-64个字符
+    2. 不能包含 /, \\, #, ?, %, : 字符
     :param run_id: 运行ID字符串
     :return: str 检查后的字符串
     :raises ValueError: 如果运行ID不符合要求
     """
     if not run_id:
         return None
     run_id_str = str(run_id)
-    if not re.match(r"^[a-z0-9]{21}$", run_id_str):
-        raise ValueError(f"id `{run_id}` is invalid, it must be 21 characters of lowercase letters and digits")
+    if not (1 <= len(run_id_str) <= 64):
+        raise ValueError(f"id `{run_id}` is invalid, length must be between 1 and 64 characters")
+    if re.search(r'[/\\#?%:]', run_id_str):
+        raise ValueError(f"id `{run_id}` is invalid, it must not contain /, \\, #, ?, %, or :")
     return run_id_str
 
 

test/unit/test_formatter.py

@@ -255,30 +255,36 @@ def test_tag_no_cut(self, value: str):
 
 class TestRunIdFormat:
     @staticmethod
-    def test_run_id_format_valid_run_id():
+    def test_run_id_format_valid_short():
+        assert check_run_id_format("abc") == "abc"
+
+    @staticmethod
+    def test_run_id_format_valid_21_chars():
         assert check_run_id_format("abcdefghijklmnopqrstu") == "abcdefghijklmnopqrstu"
 
     @staticmethod
-    def test_run_id_format_invalid_length():
-        with pytest.raises(
-            ValueError, match=r"id .* is invalid, it must be 21 characters of lowercase letters and digits"
-        ):
-            check_run_id_format("shortid")
+    def test_run_id_format_valid_64_chars():
+        value = "a" * 64
+        assert check_run_id_format(value) == value
 
     @staticmethod
-    def test_run_id_format_invalid_characters():
-        with pytest.raises(
-            ValueError, match=r"id .* is invalid, it must be 21 characters of lowercase letters and digits"
-        ):
-            check_run_id_format("abc123!@#def456ghi789")
+    def test_run_id_format_valid_mixed_chars():
+        assert check_run_id_format("Hello_World-2024.run") == "Hello_World-2024.run"
 
     @staticmethod
-    def test_run_id_format_none_input():
-        assert check_run_id_format(None) is None
+    def test_run_id_format_invalid_too_long():
+        with pytest.raises(ValueError, match=r"id .* is invalid, length must be between 1 and 64 characters"):
+            check_run_id_format("a" * 65)
 
     @staticmethod
-    def test_run_id_format_numeric_input():
-        assert check_run_id_format(123456789012345678901) == "123456789012345678901"
+    @pytest.mark.parametrize("invalid_id", ["abc/def", "abc\\def", "abc#def", "abc?def", "abc%def", "abc:def"])
+    def test_run_id_format_invalid_characters(invalid_id):
+        with pytest.raises(ValueError, match=r"id .* is invalid, it must not contain"):
+            check_run_id_format(invalid_id)
+
+    @staticmethod
+    def test_run_id_format_none_input():
+        assert check_run_id_format(None) is None
 
     @staticmethod
     def test_run_id_format_empty_string():