microsoft / microsoft/qlib

Logging code in workflow.R

Open
#282 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
48.7k
Forks
7.7k
PR merge metrics
No merged PRs in 30d

Description

🌟 Feature Description

Logging code in workflow.R

Motivation

Currently, Qlib could log commit hash value of code.
But user usally will not commit code before every experiments.

If Qlib can log the code diff between working directory and HEAD, it will bring much convenience for exp reproduction.

Alternatives

Sacred could automatically log stdout std error.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating workflow.R and the existing code that logs the commit hash. Check how workflow metadata is recorded, then define how the working-directory diff should be captured relative to HEAD and how it should appear in experiment records. Done means an experiment preserves that diff for later reproduction, with coverage for the logging behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, python
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.