Skip to content

Meet sklearn contrib conventions #29

Closed
8 of 8 issues completed
Closed
Task
8 of 8 issues completed
@quentinhaenn

Description

@quentinhaenn

Need some work to meet sklearn contrib conventions.

Each bullet point will be addressed in a specific issue, not necessarily in this order :

  • change project's name from radius-clustering to sklearn-contrib-radius-clustering on PyPI
  • add some issue and PR templates
  • Review default values of all estimators to meet requirements and justify them
  • Add lint and format in GitHub workflows
  • Check if pyproject.toml is valid and still correct
  • think about using meson for building extensions (maybe some help will be required here)
  • Add Code of Conduct and Contributing guidelines
  • Rework wheel build workflows, from actual to "dispatch" and "on tag" or similar, to only build and push new versions pushed on main branch
  • Rework Readme
    • watch for opening an example in binder
    • Add badges for coverage, build status and maybe a DOI from zenodo or software heritage in actual version
    • New examples, reworked benchmarks, review dependencies

@adrinjalali, I think I covered the most issues to address, can you please tell me if I am missing something ?

Sub-issues

Metadata

Metadata

Assignees

Labels

Priority: HIGHHigh priority issuedocumentationImprovements or additions to documentationenhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions