Quantco / Quantco/dataframely

Feature Request: Enhanced Soft Failure support

Open
#122 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
618
Forks
21
Avg merge
14h 34m
Merged PRs (30d)
7

Description

Just started experimenting with dataframely and liking a lot of what I see.

It would be great if Soft Failure support was extended in a way that makes it easy to generate failure reports for users who supply the input data.

Some ideas that sound useful to me:

  • Provide a way to mark a set of columns as debug ID columns for Failure reports
  • Extend FailureInfo counts and cooccurrence_counts methods with a "group_by_ids=True" or "group_by='id'" or similar parameter - if set, errors are grouped by the id columns suggested above
  • it would be great if friendly names (that have a meaning to non technical users) could assigned to dy.rule

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 tracing the existing Soft Failure support and the FailureInfo counts and cooccurrence_counts methods. Clarify how callers would mark debug ID columns and assign friendly names to dy.rule, then define and test grouped failure reports; the issue names no files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.