search

TDAmeritrade / stumpy

STUMPY is a powerful and scalable Python library for modern time series analysis
https://stumpy.readthedocs.io/en/latest/
Other
3.68k stars 322 forks source link

Tutotorials raises KeyboardInterrupt #1020

Closed th0ger closed 3 months ago

th0ger commented 3 months ago

Several places in the tutorials (latest and stable), output cells are failing.

They all seem to be caused by "KeyboardInterrupt", see:

https://stumpy.readthedocs.io/en/latest/search.html?q=KeyboardInterrupt#

seanlaw commented 3 months ago

@th0ger Thank you for reporting this! I will take a look and see if I can resolve this. It appears to be a problem with numpy

seanlaw commented 3 months ago

I can confirm that the KeyboardInterrupt is appearing on the following two pages:

seanlaw commented 3 months ago

I can confirm that the KeyboardInterrupt is appearing on the following two pages:

This is consistent with the errors that I am seeing in the readthedocs logs:

/home/docs/checkouts/readthedocs.org/user_builds/stumpy/checkouts/latest/docs/Tutorial_Matrix_Profiles_For_Streaming_Data.ipynb: WARNING: Executing notebook failed: CellTimeoutError [mystnb.exec] /home/docs/checkouts/readthedocs.org/user_builds/stumpy/checkouts/latest/docs/Tutorial_Matrix_Profiles_For_Streaming_Data.ipynb: WARNING: Notebook exception traceback saved in: /home/docs/checkouts/readthedocs.org/user_builds/stumpy/checkouts/latest/_readthedocs/html/reports/Tutorial_Matrix_Profiles_For_Streaming_Data.err.log [mystnb.exec] /home/docs/checkouts/readthedocs.org/user_builds/stumpy/checkouts/latest/docs/Tutorial_Pattern_Matching.ipynb: WARNING: Executing notebook failed: CellTimeoutError [mystnb.exec] /home/docs/checkouts/readthedocs.org/user_builds/stumpy/checkouts/latest/docs/Tutorial_Pattern_Matching.ipynb: WARNING: Notebook exception traceback saved in: /home/docs/checkouts/readthedocs.org/user_builds/stumpy/checkouts/latest/_readthedocs/html/reports/Tutorial_Pattern_Matching.err.log [mystnb.exec]

Specifically, there are some notebooks cells that are taking a bit too long to execute and we are seeing a CellTimeoutError. I think I've fixed the Tutorial_Pattern_Matching.html one by shortening the example to 100_000 data points and this enhancement by @NimaSarajpoor might actually clear things up for Tutorial_Matrix_Profiles_For_Streaming_Data.html once it is merged.

I can't seem to figure out how to increase the timeout.

th0ger commented 3 months ago

Suggest adding CI tests, if possible, to ensure notebooks completed fully.

seanlaw commented 3 months ago

Suggest adding CI tests, if possible, to ensure notebooks completed fully.

@th0ger Do you have any suggestions on this or can point to some relevant resources for me to learn? Locally, the everything builds without issues and the timeout isn't actually causing readthedocs to fail and so the docs ultimately end up getting built.

I can't seem to figure out how to increase the timeout.

It appears that we can try to increase the timeout by doing

# Notebook cell execution timeout; defaults to 30.
nb_execution_timeout = -1
th0ger commented 3 months ago

@seanlaw Sorry, I'm not that experienced with readthedocs.

seanlaw commented 3 months ago

@th0ger The issue appears to be resolved now. You may need to clear your browser cache to see the updates. Feel free to re-open if the problem persists and thanks again for bring it to our attention!