microsoft/qlib

Add CI for jupyter notebook example `workflow_by_code.ipynb`

Open

#1,278 opened on Sep 2, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (14,037 stars) (2,431 forks)batch import
enhancementgood first issue

Description

🌟 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

Contributor guide

Tech stack
python
Domain
devopstesting
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonCI/CDJupyter
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
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.