Rename the pkg to "treeple"

neurodata / treeple

Scikit-learn compatible decision trees beyond those offered in scikit-learn

https://treeple.ai

Other

61 stars 14 forks source link

Rename the pkg to "treeple" #292

Closed SUKI-O closed 2 months ago

SUKI-O commented 2 months ago

Reference Issues/PRs

Change the package name from scikit-tree to treeple

What does this implement/fix? Explain your changes.

Replace scikit-tree to treeple
Replace sktree to treeple
Change the directory name sktree to treeple

Any other comments?

The name of the repo itself in GH also need to be changed when ready
After that, pypi has to be updated (I need help with this part)
It builds locally using spin as expected.
When trying locally, I believe you have to re-initialize the submodule
```
git submodule init
git submodule update
```

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 78.55%. Comparing base (52ac9e4) to head (4f67823). Report is 1 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #292 +/- ## ======================================= Coverage 78.55% 78.55% ======================================= Files 24 24 Lines 2252 2252 Branches 414 414 ======================================= Hits 1769 1769 Misses 352 352 Partials 131 131 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

adam2392 commented 2 months ago

Mostly LGTM, but

you'll need to fix the building of the documentation (https://app.circleci.com/pipelines/github/neurodata/scikit-tree/1741/workflows/345d4498-1b23-4ca7-8aaa-4dedf03eac94/jobs/2969?utm_campaign=vcs-integration-link&utm_medium=referral&utm_source=github-checks-link&utm_content=summary)
in the CHANGELOG entry, you should add a summary specifying the entire package was renamed. https://github.com/neurodata/scikit-tree/blob/98b67fcbaf028ee8a9bd92407089ab4a34008e9b/doc/whats_new/v0.9.rst?plain=1#L11
In the README, it would also be good to specify that in v0.9 and onwards, the package was renamed to treeple. <v0.8 is still installable via scikit-tree on pip.

SUKI-O commented 2 months ago

@adam2392 I think the error is bc the repo name hasn't changed yet.. I think it should be fine once rename the repo itself? LMK what you think.

adam2392 commented 2 months ago

@SUKI-O I think we can make that final change once we confirm the CI functions as expected. Seems like there are still some leftover warnings. You can try resolving locally too