-
Notifications
You must be signed in to change notification settings - Fork 21
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
Abbrivations #17
Comments
Hi. Thank you for the suggestions! Great to get some feedback.
Thank you |
Nope. I maen returning lisf of callable functions that are fits to each segments. For example:
|
mshemuni
added a commit
to mshemuni/piecewise-regression
that referenced
this issue
Mar 3, 2024
See the issue chasmani#17. This commit changes all abbreviations to its actual name and fixes tests to be aware of the change. It also adds tst.py to the .gitignore so oone can easily work on it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hello,
I'd like to express my gratitude for your efforts in creating this valuable tool.
I have a few suggestions that I believe could enhance the user experience and improve the documentation:
Improved Variable Naming in
get_results()
:The
get_results()
function returns a wealth of useful information. However, the use of abbreviations such asse
,t_stat
,p_t
,bic
, orrss
might be challenging for users from diverse fields. See: this Software Engineering Stack Exchange post.Example Usage for
get_results()
andget_params()
in Documentation:While
get_results()
andget_params()
are excellent methods, the documentation lacks examples illustrating their usage. Adding clear examples, possibly with simple mathematical models like the ones below, would significantly benefit users:Introduce a Function for Returning a List of Fits:
It would be valuable to introduce a new function that returns a list of fits, such as
[fit_1, breakpoint1, fit_2, breakpoint2]
. Each fit (e.g.,fit_1
) could be a callable function that acceptsxs
and returns correspondingys
based on the fit.Thank you for considering these suggestions. I believe these enhancements will contribute to the overall usability and understanding of your tool.
I already forked the repository and fixed the Variable Naming in
get_results()
. I can request a merge. However Wanted to share my thoughts here first.The text was updated successfully, but these errors were encountered: