alibaba / alibaba/ROCK

[Feature]sandbox detail-info add experiment_name

Open
#671 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
485
Forks
81
Avg merge
16h 12m
Merged PRs (30d)
8

Description

**Feature Category**
- [x] Sandbox
- [ ] Actions
- [ ] Deployments
- [ ] SDK & API
- [ ] Envhub
- [ ] CLI
- [ ] Performance & Optimization
- [ ] Documentation & Examples

**Problem Statement**

当前执行沙箱任务时,系统仅支持通过 `experiment_id` 来标识实验。`experiment_id` 通常是一串自动生成的唯一标识符(如 UUID 或数字序列),在实际使用中可读性较差。当用户需要在多个实验之间进行查找、筛选或回溯时,面对一堆无语义的 ID 很难快速定位到目标实验,影响使用效率和体验。

**Proposed Solution**

在执行沙箱任务时新增一个可选的 `experiment_name` 参数,作为 `experiment_id` 的可读性补充。

- **参数名称**:`experiment_name`
- **参数类型**:`string`
- **是否必填**:可选(Optional)
- **默认值**:未传入时,自动生成默认名称(建议格式如 `experiment-{timestamp}` 或 `experiment-{short_id}`)

**Detailed Feature Description**

1. **参数定义**:在沙箱任务的创建/执行接口中,新增 `experiment_name` 字段。用户可以传入一个有语义的名称(如 `"baseline-gpt4o-swebench"`, `"fix-memory-leak-v2"`),便于后续识别和管理。

2. **与 experiment_id 的关系**:`experiment_name` 不替代 `experiment_id`,二者并存。`experiment_id` 仍然作为系统内部的唯一标识用于精确定位,`experiment_name` 作为用户侧的可读标签用于展示和检索。

3. **展示与检索**:在实验列表、日志输出、结果报告等场景中,优先展示 `experiment_name`(如有),同时保留 `experiment_id` 供精确查询。支持通过 `experiment_name` 进行模糊搜索和筛选。

4. **唯一性约束**:`experiment_name` 不强制全局唯一,允许不同实验使用相同名称(通过 `experiment_id` 保证唯一性)。但建议在同一用户/项目范围内保持名称的辨识度。

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the sandbox task creation/execution interfaces and searching for the existing experiment_id handling. Then trace where experiments appear in lists, logs, and result reports, plus the filtering path. Done means optional experiment_name is accepted alongside experiment_id, has a defined default, is displayed where specified, and supports name-based filtering without requiring global uniqueness.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.