Skip to content

Commit 3c8ed27

Browse files
authored
crucial doc updates (#540)
Co-authored-by: John Wu <johnwu3@sunlab-serv-03.cs.illinois.edu> overriden because updating docs shouldn't take too long.
1 parent 6989978 commit 3c8ed27

5 files changed

Lines changed: 25 additions & 1 deletion

File tree

docs/api/interpret.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Interpretability Module
2+
===============
3+
4+
We implement the following interpretability techniques below:
5+
6+
Help always needed in this direction.
7+
8+
.. toctree::
9+
:maxdepth: 3
10+
11+
interpret/pyhealth.interpret.methods.chefer
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
pyhealth.interpret.methods.chefer
2+
===================================
3+
4+
5+
Transformer interpretability module.
6+
7+
.. autoclass:: pyhealth.interpret.methods.chefer
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
pyhealth.models.TransformersModel
1+
pyhealth.models.sdoh
22
===================================
33

44

docs/how_to_contribute.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,8 @@ Every contribution must include two types of test cases:
160160

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

163+
All unit tests should be placed in the `tests/` directory following the existing structure, with 'tests/core/' for core functionality tests.
164+
163165
Pull Request Guidelines
164166
=======================
165167

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,7 @@ GRASP deep learning ``pyhealth.models.GRASP`
314314
api/datasets
315315
api/tasks
316316
api/models
317+
api/interpret
317318
api/trainer
318319
api/tokenizer
319320
api/metrics

0 commit comments

Comments
 (0)