Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
amit-sharma opened this issue Jan 30, 2022 · 8 comments
Labels
good first issue Good for newcomers

Comments

@amit-sharma
Copy link
Member

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.
@amit-sharma amit-sharma added the good first issue Good for newcomers label Jan 30, 2022
@leo-ware
Copy link

leo-ware commented Feb 4, 2022

I'll start on this.

@leo-ware
Copy link

leo-ware commented Mar 4, 2022

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
Copy link
Member Author

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.

@amit-sharma amit-sharma added this to Requests in Refutation methods May 29, 2022
@yemaedahrav
Copy link
Contributor

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

@amit-sharma
Copy link
Member Author

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
Copy link
Contributor

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
Copy link

Any updates on this?

@yemaedahrav
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Refutation methods
  
Requests
Development

No branches or pull requests

4 participants