Add progress bar to refutation operations since they take a long time to run

[amit-sharma]

Suggested by @sjgenco in #367

This would require

• usage of tqdm at the appropriate places in the loop for refutation functions.
• Adding tqdm as a requirement for DoWhy.

[leo-ware]

I'll start on this.

[leo-ware]

Okay, I've finished adding the progress bars to the refuters themselves. Now, I'm thinking about how to include options to silence them when not needed. I'm thinking to add a keyword argument to CausalRefuter.refute_estimate (like "disable_progress_bar" or smth). Then I probably also need to modify CausalModel.refute_estimate to have this argument also, so that users can silence the progress bars even if they aren't using the refuter object directly.

I will just do this if that works.

[amit-sharma]

yes, that sounds good @leo-ware
In the spirit of avoiding double negatives, you may consider show_progress_bar={True/False} (True by default) instead of disable_progress_bar.

In addition, you can add any additional libraries used to the requirements.txt file.

[yemaedahrav]

I would be willing to work on this, we can add this to the estimator as well.

[amit-sharma]

thanks, great to hear @yemaedahrav. If you have any questions as you start implementing it, you can ping on the #refutations channel on Discord.

[yemaedahrav]

I have implemented this with the show_progress_bar={True/False} option. I have made the commit here. Once the other pull request is closed, I will create another PR for this.

[alexkreidler]

Any updates on this?

[yemaedahrav]

I guess my PR #567 addressed this, this issue can be closed

[github-actions]

🤖 This is an automated response from Repo Assist.

It looks like this issue was resolved by PR #567 (merged August 2022), which added the show_progress_bar parameter to refutation operations using tqdm. The dependency is already listed in pyproject.toml (tqdm >= 4.64.0).

This issue can likely be closed — the progress bar feature is already implemented! 🎉

If there are additional refuters or estimators where progress bars are still missing, a separate issue would be a good way to track that.

Note

🔒 Integrity filter blocked 46 items

The following items were blocked because they don't meet the GitHub integrity level.

• #1418 list_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• #1399 list_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• #1396 list_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• #1392 list_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• #1391 list_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• #1371 list_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• ImportError: weighting_sampler is not an existing do sampler. #71 list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• DoSampler: Fails when you Add a Graph to the Causal Model #83 list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• Errors of Notebook: The Causal Story Behind Hotel Booking Cancellations #198 list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• Mediation Analysis key error #214 list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• arrays used as indices must be of integer (or boolean) type #225 list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• effect_estimate different using do operator and _estimate_effect function #309 list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• AttributeError: 'CausalEstimate' object has no attribute '_estimator_object' #357 list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• CausalModel.estimate_effect - UnboundLocalError: local variable 'identifier_name' referenced before assignment #365 list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• Error in Conditional Effect Estimation in backdoor.linear_regression_estimator #401 list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• 'fit_estimator' argument in 'estimate_effect' function of 'CausalModel' object #414 list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• ... and 30 more items

To allow these resources, lower min-integrity in your GitHub frontmatter:

tools:
  github:
    min-integrity: approved  # merged | approved | unapproved | none

Generated by Repo Assist · ◷

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@b897c2f3e43bde9ff7923c8fa9211055b26e27cc