py-why / py-why/EconML

Enable sphinx napoleon type preprocessing

Open
#700 0 comments 0 reactions 1 assignee View on GitHub

@kbattocchi is already working on this.

Since Nov 16, 2022.

Dominant language
Jupyter Notebook
Stars
4.8k
Forks
827
PR merge metrics
No merged PRs in 30d

Description

See https://github.com/microsoft/EconML/blob/1d3d848c1ba156644d6e58bd36e44c0c6733147d/doc/conf.py#L57-L65

This almost works today, but there are a few issues:

  • In DROrthoForest, the default value for the propensity model does not get preprocessed correctly and breaks the documentation build
  • Types with shapes get preprocessed wrong, so they appear like (m, d_x) matrix
  • Things like the return types of our _interval method get especially garbled
  • We should also avoid words like "instance" in argument and return types because that doesn't get handled correctly.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.