Skip to content

refactor!: 执行 issue #2629 YAGNI 扫描的立即行动与全部高置信可删条目 - #2633

Open
TATP-233 wants to merge 1 commit into
mainfrom
fix/issue-2629-yagni-public-api-cleanup
Open

TATP-233 wants to merge 1 commit into
mainfrom
fix/issue-2629-yagni-public-api-cleanup

Conversation

@TATP-233

Copy link
Copy Markdown
Collaborator

概要

执行 issue #2629 的「立即行动」与全部「高置信可删」条目(含 issue 评论中经下游生态审计复核后由"维护者决策"升级的批二条目)。97 个文件,+258/−3429。

立即行动:文档错误推荐

  • 2-motion_tracking.md(en + zh_CN)的 crawl-slope WBT 示例原推荐 sampling_mode=start,按文档操作会在 env 构造期抛 NotImplementedError(tensor sampler 从未支持该值)。改为受支持的确定性 clip 起点形式 sampling_mode=mixed + sampling_start_ratio=1.0。
  • MotionCommandCfg.sampling_mode 收窄为 Literal["adaptive", "mixed"],非法值在配置校验期即被清晰拒绝。

批一:高置信可删(issue 正文,18-20 处)

  • managers:clear_finite_verdict ×3、TerminationManager.dones/get_term、RecorderManager.__contains__(含 Null)、DelayBuffer.set_lags、apply_cuda_process_sharing_manifest、get_hydra_runtime_choice(及 unilab.training re-export)。
  • base:EnvConfigAdapter 的 algo_name(静默忽略;~20 处调用点全部清理,含 build_play_backend_adapter 转发参数)、registry.find_available_sim_backend(make() 已内联同一回退)。
  • envs/tasks:UniformVelocityCommandCfg.VizCfg/viz、BaseActionCfg.preserve_order、MotionLoader.get_clip_indices、resolve_checkpoint_file 的 Sequence[str] 分支。
  • rl:rl.runtime.device 的 resolve_torch_device_alias 整组(含 4 个私有助手)、build_actor 的 num_envs。
  • conf:PPO algo.experiment_name/algo.run_name、SAC algo.actor: {} 假兼容键、4 个 motion-tracking owner YAML 中仅重复 dataclass 默认值的 3 行。

批二:评论升级项(原"维护者决策"全部转删除)

  • init_velocity_prob 假旋钮:字段、fail-closed 分支、8 个 owner YAML 行删除。跨仓协调:5 个下游仓库(unitree/engineai 等)的 10 行 init_velocity_prob: 0.0 需在升级时同步删除(issue 已跟踪)。
  • EnvAlgoCapabilities 的 action_low/action_high/joint_names 预留字段(producer 恒填 None、零消费)。
  • tensor 迁移遗留三模块(~985 行):tensor_runtime.py、tensor_state_store.py::DeviceStateStore、go2/tensor_parity.py 及其专属测试;ADR-0011/0012 的 Evidence 引用已同步更新。
  • PPO owner algo.resume/algo.resume_path:读点仅在 off-policy/APPO 路径。删除并新增 reject_removed_ppo_resume_keys(PPO 入口 fail-closed;PPO resume 仍走 algo.load_run+algo.checkpoint;off-policy owner 保留活键)。
  • TorchEnv.record_finite_validation 的 label 参数(实现体 del label 静默丢弃):收窄签名,5 个生产调用点与协议定义同步更新。
  • 调试面家族:ManagerBase.get_active_iterable_terms 及 9 个实现、extract_reset_obs、render_play_mode/run_native_viewer_play_loop 薄封装(调用方与 scripts/visualize_task_env.py 改为直接使用 env.run_playback,测试契约覆盖保留)、OnPolicyLogger(含 api_reference 条目)。
    • 复核修正:TorchEnv.require 原计划删除,但实际是 masked autoreset 延迟 mask 校验的活 sink(set_deferred_mask_checks(self.require)),已保留并恢复其测试。
  • noise 类族:ConstantNoiseCfg/GaussianNoiseCfg/SegmentwiseUniformNoiseCfg 删除(生产 YAML 只用 UniformNoiseCfg);UniformNoiseCfg 与 NoiseModel/NoiseModelWithAdditiveBiasCfg 扩展基座保留。

验证

  • make check ✅(ruff format/check、mypy、tests 静态检查)
  • make test ✅ 2946 passed, 67 skipped, 0 failed
  • 每个删除项均经 rg 全仓(src/tests/scripts/docs)复核零消费;下游 5 仓审计结论来自 issue 评论。

备注

  • 按仓库纪律在 docs/sphinx/source/changelog.md 的 Unreleased(Fixed + Removed)添加双语条目。
  • 未运行 make test-all(含 coverage/benchmark smoke);如需要可补跑。

…NI sweep

Immediate action (docs):
- Fix the crawl-slope WBT example that recommended sampling_mode=start
  (unsupported by the tensor sampler; raises NotImplementedError at env
  construction): use sampling_mode=mixed with sampling_start_ratio=1.0, the
  supported deterministic clip-start form, in both en and zh_CN pages.
- Narrow MotionCommandCfg.sampling_mode to Literal["adaptive", "mixed"] so
  invalid values fail at config validation.

High-confidence deletions, batch 1 (zero in-repo consumers):
- managers: clear_finite_verdict x3, TerminationManager.dones/get_term,
  RecorderManager.__contains__ (and Null), DelayBuffer.set_lags,
  apply_cuda_process_sharing_manifest, get_hydra_runtime_choice.
- base: EnvConfigAdapter algo_name (silently ignored; all call sites cleaned,
  including build_play_backend_adapter), registry.find_available_sim_backend
  (make() already inlines the fallback).
- envs/tasks: UniformVelocityCommandCfg VizCfg/viz, BaseActionCfg.preserve_order,
  MotionLoader.get_clip_indices, resolve_checkpoint_file Sequence[str] branch.
- rl: resolve_torch_device_alias group in rl.runtime.device, build_actor
  num_envs (silently ignored).
- conf: PPO algo.experiment_name/run_name, SAC algo.actor: {} fake-compat key,
  motion-tracking owner YAML lines that only restate dataclass defaults.

High-confidence deletions, batch 2 (issue comments: downstream audit upgraded
all maintainer-decision items):
- UniformVelocityCommandCfg.init_velocity_prob fake knob (8 owner YAML lines
  removed; downstream repos must drop their init_velocity_prob: 0.0 lines on
  upgrade, tracked in the issue).
- EnvAlgoCapabilities action_low/action_high/joint_names reserved fields.
- Tensor-migration leftovers: motion_tracking/common/tensor_runtime.py,
  tensor_state_store.py (DeviceStateStore), locomotion/go2/tensor_parity.py;
  ADR-0011/0012 evidence pointers updated.
- PPO owner algo.resume/algo.resume_path dead keys; the PPO entrypoint fails
  closed via reject_removed_ppo_resume_keys (resume stays on
  algo.load_run + algo.checkpoint; off-policy owners keep the live keys).
- TorchEnv.record_finite_validation label argument (silently dropped).
- Tests-only debug surface: ManagerBase.get_active_iterable_terms and
  implementations, extract_reset_obs, render_play_mode and
  run_native_viewer_play_loop thin wrappers (callers use env.run_playback
  directly), OnPolicyLogger (with its api_reference entry).
  TorchEnv.require is kept: it is the live deferred mask-check sink installed
  by ManagerBasedRlEnv for masked autoreset.
- Zero-consumer noise cfgs ConstantNoiseCfg/GaussianNoiseCfg/
  SegmentwiseUniformNoiseCfg (UniformNoiseCfg and the NoiseModel extension
  base stay).

Validation: make check; make test (2946 passed, 67 skipped).
@TATP-233
TATP-233 requested a review from caozx1110 as a code owner November 19, 2026 15:47

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant