增强提案#
描述#
sktime 增强提案 (STEP) 是一个软件设计文档,为 sktime 社区提供信息。提案应提供提议设计的理由和简洁的技术规范。
我们在 sktime 的 STEP 仓库 中收集和讨论提案。
我们打算将 STEPs 作为提出重大变更、收集社区对某个问题的意见以及记录已纳入 sktime 的设计决策的主要机制。较小的变更可以直接在问题和拉取请求中讨论和实施。
关于 sktime 中遵循的一般设计原则和模式,请参阅我们的论文:设计 ML 工具箱:概念、原则和模式。
提交一个 STEP#
要创建一个新的 STEP,请复制并使用 template 并在 repository 上提交一个拉取请求。
强烈建议一个 STEP 只包含一个关键提案或新想法。提案越专注,通常越成功。如果有疑问,请将您的 STEP 分成几个专注的提案。
一个 STEP 应该是一个综合文档,包括:
一个简洁的问题陈述,
对提议的解决方案的清晰描述,
与替代解决方案的比较。