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

Docs are not updated to date and miss some submodules #392

Closed
paullo0106 opened this issue Oct 6, 2021 · 4 comments
Closed

Docs are not updated to date and miss some submodules #392

paullo0106 opened this issue Oct 6, 2021 · 4 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request

Comments

@paullo0106
Copy link
Collaborator

Describe the bug

In our docs page: https://causalml.readthedocs.io/en/latest/causalml.html# , it doesn't reflect the latest codebase, for example:

  • Missing content in few modules: causalml.inference.tree and causalml.dataset

Screen Shot 2021-10-05 at 6 57 57 PM

  • Some latest code changes are not reflected, for example, we added n_jobs, a new parameter to NearestNeighborMatch last week
  • New modules can be added: causalml.feature_selection, causalml.inference.nn, causalml.inference.tf, and etc.

Other note

Resolving this issue will improve the searchability and consistency of CausalML

@paullo0106 paullo0106 added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Oct 6, 2021
@paullo0106
Copy link
Collaborator Author

some references to fix this bug might be @jeongyoonlee 's previous commit related to sphinx:
#335
https://github.com/uber/causalml/commits/master/docs/causalml.rst

@jeongyoonlee jeongyoonlee self-assigned this Oct 22, 2021
@jeongyoonlee
Copy link
Collaborator

Thanks @paullo0106 for reporting this. I just published latest documentation to https://causalml.readthedocs.io. It's not currently publishing the docs automatically. I will look into it.

@jeongyoonlee
Copy link
Collaborator

I fixed the automatic docs publish by removing the existing the webhook between GitHub and ReadTheDocs, and adding it back.

Regarding missing submodules, tree should be a cython issue. I don't know why dataset module is not rendering. I will look into it further.

@jeongyoonlee
Copy link
Collaborator

Just fixed the missing API docs for inference.tree and dataset. ;)
Please check it out here: https://causalml.readthedocs.io/en/latest/causalml.html
Screen Shot 2021-11-19 at 7 29 57 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants