sissa-data-science / DADApy

Distance-based Analysis of DAta-manifolds in python
https://dadapy.readthedocs.io/
Apache License 2.0
103 stars 18 forks source link

Renaming decimation->data_fraction and fraction->mu_fraction #91

Closed diegodoimo closed 8 months ago

diegodoimo commented 1 year ago

I'd like to propose the following change of argument names in the compute_id_2NN and compute_id_scaling_2NN:

I know that this is a change that would affect the final user but I think that the previous names are confusing and not expressive at all. Moreover,

but what we do is exactly the opposite. This is something we should have thought about more in-depth before, but I think that this is a good change to make.

AldoGl commented 1 year ago

Yes, I agree the original names are confusing! However I don't fully understand why the word "rate" is appropriate here. Shouldn't we prefer something like "data_fraction" and "mu_fraction"? Just asking

diegodoimo commented 1 year ago

Yes, I don't know why I proposed 'rate' to mean 'ratio' / 'fraction'. 'fraction' is better.