dodiscover
dodiscover copied to clipboard
[DOC] Enhance the documentation for topological order learning methods
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:
- Include some blurbs in the
Notes
section of the docstrings of the algorithms- Include an additional module, similar to
constraint_causal_discovery.rst
, which sort of gives a more user-friendly introduction to these topological ordering methods.- 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
@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.
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?
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.