-
Notifications
You must be signed in to change notification settings - Fork 285
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 (Quick) How-To Examples #663
Comments
Hi, |
@namankaushik9876 Thank you for your interest. Perhaps, the first thing you can do is help us identify other docs (from other packages) that could serve as a reasonable example to follow and that we could mimic the style of. As notes above, I think these will be short (maybe 2 paragraphs?) and the code should focus on the STUMPY API and have east-to-understand titles so that experienced data scientists (who know what they want to accomplish) can quickly use the minimum-reproducible code snippet. This should not include code for plotting figures and, instead, we simply embed the necessary figure. But first, we need to find short examples to compare between. How does that sound? |
sure sir |
Here are some crowdsourced references that may be useful:
|
Related issue: #107 |
Recently, I received some feedback:
P_Point_Point = stumpy.stump(point_df["Centroid Location"], m)[:, 0].astype(float)
is hard to readstumpy.stump
is somewhat long. Considerst.stump
when importingUltimately, from the user's perspective, STUMPY is package that they need to figure out how to use in as little time as possible. Even if one package is "better" under the hood, they'd probably accidentally end up using it, if I can get it to work on my data faster.
I think it would help to have "Quick Start" guide with simple examples of how to use STUMPY that avoids lengthy explanations. Perhaps, we can create super-short versions of our tutorials and convert them to quick start examples.
The text was updated successfully, but these errors were encountered: