Skip to content

Clean up TQDM usage #781

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

Merged
merged 1 commit into from
Mar 20, 2025
Merged

Clean up TQDM usage #781

merged 1 commit into from
Mar 20, 2025

Conversation

WardBrian
Copy link
Member

Submission Checklist

  • Run unit tests
  • Declare copyright holder and open-source license: see below

Summary

This fixes a longstanding issue that was preventing us from using the default format from tqdm. @bob-carpenter recently pointed out how useful this output is, so this restores it.

We can't really test this output, so I was just running the cmdstanpy_tutorial.py file with an artificially high number of iterations.

Copyright and Licensing

Please list the copyright holder for the work you are submitting (this will be you or your assignee, such as a university or company):

Simons Foundation

By submitting this pull request, the copyright holder is agreeing to license the submitted work under the following licenses:

@WardBrian WardBrian requested a review from mitzimorris March 20, 2025 13:46
@mitzimorris
Copy link
Member

I'm re-running my case-study notebook now. I agree that the time to completion is useful. The iterations/second is misleading in that it's raw iterations, not EFF/sec, and the iterations / sec is about 10x's the EFF/sec.

can we get timing without iterations/sec?

@mitzimorris
Copy link
Member

EFF/sec
EFF:sec

tqdm for sum_to_zero_vector:
tqdm_ozs

tqdm for soft sum-to-zero constraint:
tqdm_soft

@WardBrian
Copy link
Member Author

WardBrian commented Mar 20, 2025

The iterations/second is misleading in that it's raw iterations, not EFF/sec

I don't see how it's misleading at all. The sample interface asks you to specify a number of iterations, not a number of effective draws, and the progress is in terms of the same thing.

the iterations / sec is about 10x's the EFF/sec

This will be entirely model dependent. If your ESS is 10x smaller than your number of samples, then yes, this is expected

@mitzimorris
Copy link
Member

point taken re iterations vs EFF.

Copy link
Member

@mitzimorris mitzimorris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@WardBrian WardBrian merged commit db3087a into develop Mar 20, 2025
27 of 32 checks passed
@WardBrian WardBrian deleted the cleanup-tqdm branch March 20, 2025 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants