From a2175f2ed3ecb257e294597e84ab1cc211d0b409 Mon Sep 17 00:00:00 2001 From: John Wu Date: Tue, 9 Sep 2025 13:31:51 -0500 Subject: [PATCH] crucial doc updates --- docs/api/interpret.rst | 11 +++++++++++ .../interpret/pyhealth.interpret.methods.chefer.rst | 10 ++++++++++ ...{pyhealth.models.SDOH => pyhealth.models.SDOH.rst} | 2 +- docs/how_to_contribute.rst | 2 ++ docs/index.rst | 1 + 5 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 docs/api/interpret.rst create mode 100644 docs/api/interpret/pyhealth.interpret.methods.chefer.rst rename docs/api/models/{pyhealth.models.SDOH => pyhealth.models.SDOH.rst} (84%) diff --git a/docs/api/interpret.rst b/docs/api/interpret.rst new file mode 100644 index 000000000..36e6cd565 --- /dev/null +++ b/docs/api/interpret.rst @@ -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 \ No newline at end of file diff --git a/docs/api/interpret/pyhealth.interpret.methods.chefer.rst b/docs/api/interpret/pyhealth.interpret.methods.chefer.rst new file mode 100644 index 000000000..e832b2d34 --- /dev/null +++ b/docs/api/interpret/pyhealth.interpret.methods.chefer.rst @@ -0,0 +1,10 @@ +pyhealth.interpret.methods.chefer +=================================== + + +Transformer interpretability module. + +.. autoclass:: pyhealth.interpret.methods.chefer + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/api/models/pyhealth.models.SDOH b/docs/api/models/pyhealth.models.SDOH.rst similarity index 84% rename from docs/api/models/pyhealth.models.SDOH rename to docs/api/models/pyhealth.models.SDOH.rst index e453bad7e..9b587fbf6 100644 --- a/docs/api/models/pyhealth.models.SDOH +++ b/docs/api/models/pyhealth.models.SDOH.rst @@ -1,4 +1,4 @@ -pyhealth.models.TransformersModel +pyhealth.models.sdoh =================================== diff --git a/docs/how_to_contribute.rst b/docs/how_to_contribute.rst index 75a684e92..734657ac0 100644 --- a/docs/how_to_contribute.rst +++ b/docs/how_to_contribute.rst @@ -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 ======================= diff --git a/docs/index.rst b/docs/index.rst index 8ffa77961..79a2130ef 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -314,6 +314,7 @@ GRASP deep learning ``pyhealth.models.GRASP` api/datasets api/tasks api/models + api/interpret api/trainer api/tokenizer api/metrics