Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Enhance the documentation for topological order learning methods #133

Open
adam2392 opened this issue Apr 21, 2023 · 3 comments
Open

Comments

@adam2392
Copy link
Collaborator

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 #129 (comment)

@adam2392
Copy link
Collaborator Author

@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.

@francescomontagna
Copy link
Contributor

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?

@adam2392
Copy link
Collaborator Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants