dodiscover icon indicating copy to clipboard operation
dodiscover copied to clipboard

[DOC] Enhance the documentation for topological order learning methods

Open adam2392 opened this issue 1 year ago • 3 comments

Another high-level comment I have is to ask if you can add some intuition to the hyper parameters of each algorithm, so that it can inform users on how to select them. Some strategies:

  1. Include some blurbs in the Notes section of the docstrings of the algorithms
  2. Include an additional module, similar to constraint_causal_discovery.rst, which sort of gives a more user-friendly introduction to these topological ordering methods.
  3. some combination of the above

We can also include this in a downstream PR.

Originally posted by @francescomontagna in https://github.com/py-why/dodiscover/issues/129#issuecomment-1517362793

adam2392 avatar Apr 21 '23 13:04 adam2392

@francescomontagna are you still interested in submitting a PR to document the concepts behind these methods? This will help ensure more usage and proper understanding of the methods.

adam2392 avatar Jul 25 '23 20:07 adam2392

Hi @adam2392 , sorry for disappearing for a while! And thanks for the PR merging and all the hard work you put in it. So, the idea is to focus on the hyperparameters and use this as a starting point to explain the logic behind the methods, if I understand correctly. Is that it?

francescomontagna avatar Jul 29 '23 12:07 francescomontagna

Yes I think just a gentle introduction to the class of methods and what are some important design decisions to make. This is almost like a "user guide" for the user, such that they can properly use and cite the methods.

adam2392 avatar Jul 29 '23 18:07 adam2392