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 (2,431 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (14,037 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Add a CI step to run `jupyter nbconvert execute workflow by code.ipynb` to verify the notebook runs without errors.
Tech stack
python
Domain
machine learningaidevops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPythonJupyter
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70