Skip to content

crucial doc updates#540

Merged
jhnwu3 merged 1 commit intomasterfrom
docs/update_interpret_models
Sep 9, 2025
Merged

crucial doc updates#540
jhnwu3 merged 1 commit intomasterfrom
docs/update_interpret_models

Conversation

@jhnwu3
Copy link
Collaborator

@jhnwu3 jhnwu3 commented Sep 9, 2025

This pull request primarily adds documentation for a new interpretability module, updates existing documentation for model references, and clarifies testing guidelines. The most significant changes are the addition of interpretability documentation and improvements to the organization and clarity of docs.

Documentation improvements

  • Added a new section for the interpretability module in docs/api/interpret.rst, including a toctree entry for the chefer method.
  • Created detailed API documentation for pyhealth.interpret.methods.chefer, describing the transformer interpretability module and its class members.
  • Updated the main documentation index in docs/index.rst to include a link to the new interpretability API section.

Model documentation updates

  • Renamed and updated the documentation for the SDOH model from pyhealth.models.TransformersModel to pyhealth.models.sdoh in docs/api/models/pyhealth.models.SDOH.rst.

Contribution guidelines clarification

  • Added instructions specifying that all unit tests should be placed in the tests/ directory, with core functionality tests in tests/core/, to docs/how_to_contribute.rst.

@jhnwu3 jhnwu3 merged commit 3c8ed27 into master Sep 9, 2025
1 check passed
@jhnwu3 jhnwu3 deleted the docs/update_interpret_models branch September 9, 2025 18:33
dalloliogm pushed a commit to dalloliogm/PyHealth that referenced this pull request Nov 26, 2025
Co-authored-by: John Wu <johnwu3@sunlab-serv-03.cs.illinois.edu>

overriden because updating docs shouldn't take too long.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant