Skip to content

crucial doc updates #540

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

Merged
jhnwu3 merged 1 commit into from
Sep 9, 2025
Merged

crucial doc updates #540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 @@
Interpretability Module
===============

We implement the following interpretability techniques below:

Help always needed in this direction.

.. toctree::
:maxdepth: 3

interpret/pyhealth.interpret.methods.chefer
10 changes: 10 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,10 @@
pyhealth.interpret.methods.chefer
===================================


Transformer interpretability module.

.. autoclass:: pyhealth.interpret.methods.chefer
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/api/models/pyhealth.models.SDOH → docs/api/models/pyhealth.models.SDOH.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
pyhealth.models.TransformersModel
pyhealth.models.sdoh
===================================


Expand Down
2 changes: 2 additions & 0 deletions docs/how_to_contribute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,8 @@ Every contribution must include two types of test cases:

**Note**: You can use frontier LLMs to help generate basic test cases, which we consider valid as long as they are reasonable and comprehensive.

All unit tests should be placed in the `tests/` directory following the existing structure, with 'tests/core/' for core functionality tests.

Pull Request Guidelines
=======================

Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,7 @@ GRASP deep learning ``pyhealth.models.GRASP`
api/datasets
api/tasks
api/models
api/interpret
api/trainer
api/tokenizer
api/metrics
Expand Down