microsoft/qlib

Add CI for jupyter notebook example `workflow_by_code.ipynb`

Open

#1.278 aberto em 2 de set. de 2022

Ver no 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

Guia do colaborador

Pilha de tecnologia
python
Domain
devopstesting
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
half day
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
PythonCI/CDJupyter
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60
Direção de pesquisa
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.