Progress bar for creating animations #128
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since creating animations can take a long time (tens of minutes), it can be helpful to know how long it's going to take/whether the animation is almost complete.
So I added a keyword argument (
progress_bar) that adds a progress bar when creating animations with ratinabox. I only added it to the modules (not to the notebooks) that callmatplotlib.animation.FuncAnimation:Neurons.animate_rate_timeseries()andAgent.animate_trajectory().I set the default to
Falseto avoid changing existing behaviour. The progress bar is created throughtqdmwhich is imported only ifprogress_baris True. Here is an example from a notebook. It shows what frame you're at, and estimates the total time too.