beacon-biosignals / multiwaynumberpartitioning.jl Goto Github PK

Task list for v0.1 open source release (based on beacon-biosignals/LighthouseFlux.jl#14):

• Make this tracking issue :)

Open source:

• Add MIT license
• Sanity-check no private info in commits/issues (w/ @jrevels)
  • No private info in code
• Make repo public
• Enable repo access for the general julia registrator (ask one of our GitHub admins)

Release:

• decide on a name (#2)
• make sure all API functions are documented (in the README, in this case)
• add CI and codecov badge to README
• make sure codecov is working
• Make sure repo follows best-practice settings
• Lint it
• Open PR in Julia registry by triggering Registrator (JuliaRegistries/General#45228)
  • Wait for it to auto-merge (3 days)
  • double-check sure tagbot works (i.e. makes a tag once that PR is merged)

@palday @kimlaberinto any bikeshedding on the naming? Scope is to provide exact or approximate solutions to combinatorial problems around partitioning objects, with an eye to usage in cross validation and test/train splits in ML tasks. Things like:

• I have N pieces of data grouped into M buckets. I know data within a bucket is correlated, so I don't want to split a bucket across CV splits or test/train splits. How do I partition my data into K equal groups? (That's the problem currently solved)
• My data is also labelled by class, and I want to obtain groups with equal class balance
• Instead of equal sized groups, I want an 80/20 split for test/train
• ...generalizations thereof, maybe multiple types of correlation, maybe more things to balance over, etc

name ideas:

• PartitioningProblems.jl
• DataPartitions.jl
• Partitioning.jl

Related work:

• https://github.com/JuliaML/MLDataPattern.jl
• https://alan-turing-institute.github.io/MLJ.jl/dev/evaluating_model_performance/#MLJBase.StratifiedCV
• https://github.com/kahypar/KaHyPar.jl ?
• https://github.com/JuliaSparse/Metis.jl ?

This issue is used to trigger TagBot; feel free to unsubscribe.

If you haven't already, you should update your TagBot.yml to include issue comment triggers.
Please see this post on Discourse for instructions and more details.

If you'd like for me to do this for you, comment TagBot fix on this issue.
I'll open a PR within a few hours, please be patient!