m-Py / anticlust

Subset partitioning via anticlustering
Other
28 stars 5 forks source link

Insufficient documentation in new version 0.8.6 #55

Open m-Py opened 2 months ago

m-Py commented 2 months ago

Yesterday, I somewhat hastily released version 0.8.6., to get the code out and to release some mental load due to too many Git branches. I think it has all the code that it should have, but the documentation is slightly lacking, for example:

I will extend this list when I become aware of additional omissions.

One reason for the lack of documentation is that I am currently working on a preprint that explains a lot of the changes in version 0.8.6 in more detail and on a "theoretical" level (especially regarding cannot-link constraints, but also the average diversity objective). However, I wanted to get the code out »now«, and I am not sure if / when I can finish the paper during summer. I should also insert a new vignette on anticlustering with cannot-link constraints then (because there are several ways to do it).

m-Py commented 2 months ago

The anticlust blog now has some additional information on the update.