microsoft/qlib

Add CI for jupyter notebook example `workflow_by_code.ipynb`

Open

#1,278 创建于 2022年9月2日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)Python (14,037 star) (2,431 fork)batch import
enhancementgood first issue

描述

🌟 Feature Description

CI that it can't detect the errors in the report. So I think it would be better to add such a check in our CI. (It may be some command like jupyter nbconvert workflow_by_code.ipynb)

Please refer to this comment. https://github.com/microsoft/qlib/pull/1267#issuecomment-1230072848

Motivation

  1. Application scenario
  2. Related works (Papers, Github repos etc.):
  3. Any other relevant and important information:

Alternatives

Additional Notes

贡献者指南

技术栈
python
领域
devopstesting
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
PythonCI/CDJupyter
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
The issue asks to add a CI check for the Jupyter notebook `workflow by code.ipynb` to detect execution errors. The proposed solution uses `jupyter nbconvert` to run the notebook. Review the referenced comment in PR #1267 (https://github.com/microsoft/qlib/pull/1267#issuecomment 1230072848) for context. The implementation should modify the CI configuration (likely a YAML file) to include a step that runs the notebook and fails if errors occur. No existing work is claimed, so the task is available for a newcomer.