search

stumpy-dev / awesome-stumpy

A place to share quick how-to guides for STUMPY
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

Add notebooks for 100_Time_Series_Data_Mining_Questions__with_Answers.pdf #1

Open NimaSarajpoor opened 2 years ago

NimaSarajpoor commented 2 years ago

I think STUMPY API is ready to create quick-start guide using 100_Time_Series_Data_Mining_Questions__with_Answers.pdf. The file itself provides a link through which one can get access to the data and the MATLAB code.

This is a follow-up to the issue https://github.com/TDAmeritrade/stumpy/issues/107 and it is related to https://github.com/TDAmeritrade/stumpy/issues/663.

sejalgolani2801 commented 7 months ago

Hey, I'm new to open source. Can I work on this issue?

seanlaw commented 7 months ago

@sejalgolani2801 Thank you for your interest in contributing and, yes, please feel free to dive right in! We don't quite know how to structure/present this stuff but this might be a good approach. I think these how-to examples should be short-and-sweet rather than long-form like our tutorials. What do you think?

In The Difference Between A Tutorial And A How-To-Guide, they distinguish the two by saying:

A tutorial serves the needs of the user who is at study. Its obligation is to provide a successful learning experience. A how-to guide serves the needs of the user who is at work. Its obligation is to help the user accomplish a task.

So, I think, like the PDF, we should clearly state the singular task and then provide a short code snippet that accomplishes that task. And, at most, maybe a few sentences to help briefly explain/support the code but not more.

I really like organizing things as cards like the examples for scikit-learn

Please feel free to ask any questions and we will try our best to support you!

seanlaw commented 7 months ago

FYI, I've added a basic example of how to add cards to the PyData Sphinx theme (see this RTD page) and you can find more card customization information from the Sphinx-Design docs:

sejalgolani2801 commented 7 months ago

Thank you so much @seanlaw for the opportunity. I'll start working on this and text you here for help:)

seanlaw commented 7 months ago

Sounds good @sejalgolani2801! I know that it might be a lot so I recommend starting with one or two clear how-to (code) examples and then we can worry about how to present that content afterwards (i.e., with cards).

sejalgolani2801 commented 7 months ago

okay , I'll work on it. Can I get a day or two if that works for you? @seanlaw

seanlaw commented 7 months ago

okay , I'll work on it. Can I get a day or two if that works for you? @seanlaw

There is no rush so please take whatever time you need. We are here to support you. The only thing I ask is that you ask for feedback often rather than trying to perfect things. This way, you don't waste time trying to read our minds and pursuing the wrong path. Again, we are here to help and to answer any questions/doubts.

sejalgolani2801 commented 7 months ago

sure no worries, I'll keep that in mind. Thank you so much @seanlaw

NimaSarajpoor commented 7 months ago

@sejalgolani2801 I worked on some of the problems before but didn't get chance to finish it. So, if you cannot find a data for the first few questions, this might help.

https://github.com/NimaSarajpoor/TimeSeries_Mining

Please do your due diligence as some of the stuff in the link above may not be completely correct.

seanlaw commented 6 months ago

Hi @sejalgolani2801! I wanted to check in to see how things are going and if you need assistance with anything?

seanlaw commented 2 days ago

@sejalgolani2801 How's it going? Can we help review anything?