Skip to content

create interpret autodocs module #530

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

create interpret autodocs module #530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fe9d19
create interpret autodocs module
Aug 4, 2025
c38593a
Update docs/api/interpret/pyhealth.datasets.interpret.methods.chefer.rst
jhnwu3 Aug 4, 2025
2d7ef50
fixing syntax issues
Aug 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/api/interpret.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Interpret Module
Copy link

Copilot AI Aug 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The title formatting is inconsistent. The title should not have a trailing space and the underline should match the title length.

Copilot uses AI. Check for mistakes.

PyHealth provides specialized tools for interpreting deep models post-hoc.
===============
Copy link

Copilot AI Aug 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The underline length (15 characters) doesn't match the title length (16 characters including the trailing space). For proper RST formatting, the underline should be at least as long as the title.

Copilot uses AI. Check for mistakes.
Comment on lines +1 to +4
Copy link

Copilot AI Aug 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The title format is inconsistent with RST conventions. The title should be followed by an underline of equal signs matching the title length, and the description should come after the underline.

Suggested change
Interpret Module
PyHealth provides specialized tools for interpreting deep models post-hoc.
===============
Interpret Module
================
PyHealth provides specialized tools for interpreting deep models post-hoc.

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Aug 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The underline length (15 characters) does not match the title 'Interpret Module' (16 characters including space). RST requires the underline to be at least as long as the title.

Suggested change
===============
================

Copilot uses AI. Check for mistakes.

.. toctree::
:maxdepth: 3

interpret/pyhealth.interpret.methods.chefer


17 changes: 17 additions & 0 deletions docs/api/interpret/pyhealth.interpret.methods.chefer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
pyhealth.interpret.methods.chefer
===================================
This method implements the Chefer et al. method for interpreting transformer models in PyHealth.

Paper is available at https://arxiv.org/abs/2012.09838.


.. autoclass:: pyhealth.interpret.methods.chefer
:members:
:undoc-members:
:show-inheritance:






2 changes: 1 addition & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ GRASP deep learning ``pyhealth.models.GRASP`
api/metrics
api/medcode
api/calib

api/interpret

.. toctree::
:maxdepth: 2
Expand Down