microsoft/qlib

Add CI for jupyter notebook example `workflow_by_code.ipynb`

Open

#1.278 geöffnet am 2. Sept. 2022

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (14.037 Stars) (2.431 Forks)batch import
enhancementgood first issue

Beschreibung

🌟 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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
PythonCI/CDJupyter
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
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.