-
Notifications
You must be signed in to change notification settings - Fork 1
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
Rename estimators and package #18
Conversation
- Change estimator names to reflect that they are KnnRegressors - Change package name to "scikit-learn-knn-regression" - Change imported module name to "sknnr"
@aazuspan , a couple of possible changes to consider:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great overall!
Do we want e.g. EuclideanKnnRegressor or EuclideanKNNRegressor? I'm OK either way.
I lean towards KNN
just for consistency with GNN
and MSN
, but not a strong opinion.
Doing a bit of browsing on PyPI, it looks like both scikit-learn and sklearn prefixes are used for custom estimators. scikit-learn is more explicit, sklearn is shorter for an already long package name.
Good points. I guess if I had to choose I would go with the more explicit scikit-learn
, but if you have any preference I'd happily defer to that.
I agree. Changed to
I don't have a strong opinion, but agree that explicit is likely better. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect, looks good to merge!
Cool, I've renamed the repository to
|
Awesome, thanks! |
This PR would close #6 by renaming all current estimators to specify that they are
KnnRegressor
estimators. It also changing the package name toscikit-learn-knn-regression
, although we haven't yet renamed this in Github, but will before we merge this change. The imported module name also changes fromsklearn_knn
tosknnr
.To make the change locally, I did these steps:
scikit-learn-knn
toscikit-learn-knn-regression
in all filessklearn_knn
tosknnr
in all filesKnnRegressor
(Raw
,Euclidean
,Mahalanobis
) orRegressor
(GNN
,MSN
)src\sklearn_knn
tosrc\sknnr
hatch env prune
to get rid ofscikit-learn-knn
andtest
environmentshatch shell
to addscikit-learn-knn-regression
environmenthatch run test:all
to addtest
environment(The only hiccup I had was that the old
scikit-learn-knn
hatch environments were not deleted, but I can do that manually).