Skip to content
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.

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

Docs #36

Merged
merged 48 commits into from
Jul 3, 2024
Merged

Docs #36

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
fa228da
Removed auto generated API files
mmcdermott Jun 13, 2024
27cba9b
Small README modifications
mmcdermott Jun 13, 2024
adf93b0
Use relative imports inside the (now nested) scripts files.
mmcdermott Jun 13, 2024
e39b934
Fixed unexpected first-element-only issue with the readthedocs API. F…
mmcdermott Jun 13, 2024
aeadfde
checkpointing rst
Jun 13, 2024
2f72bb8
fixed docs
Jun 13, 2024
b0365a6
updated requirements
Jun 13, 2024
b2655a6
Add PDF format
mmcdermott Jun 13, 2024
0bcde72
trying a different readthedocs config for dependency management
mmcdermott Jun 13, 2024
1fe9186
Update index.md
mandiehyewon Jun 13, 2024
14bad2b
Added appendix A to README
mmcdermott Jun 13, 2024
5f75c2f
Added B
mmcdermott Jun 13, 2024
0daab40
Added C
mmcdermott Jun 13, 2024
7929e5a
Added D
mmcdermott Jun 13, 2024
85bfd5e
Fixed spelling issues
mmcdermott Jun 13, 2024
f6e229a
added docs
Jun 13, 2024
0227900
added eicu docs
Jun 13, 2024
16325b2
added appendix b
Jun 13, 2024
3e81f60
fixed overview being two chapters
Jun 13, 2024
1ab0405
beginning small updates to docs
teyaberg Jun 18, 2024
46fc6aa
index md edit
aleksiakolo Jun 24, 2024
eb77da1
small overview edits
aleksiakolo Jun 24, 2024
877cfd3
implementation md edit
aleksiakolo Jun 24, 2024
dd53a9f
implementation md edit
aleksiakolo Jun 24, 2024
caf203f
profiling md edit
aleksiakolo Jun 24, 2024
ceda62b
added missing language identifiers
aleksiakolo Jun 24, 2024
a934edb
code-quality issues
aleksiakolo Jun 24, 2024
0b6b840
prediction md edit and typo fixes
aleksiakolo Jun 24, 2024
ed6b1d0
added space check
aleksiakolo Jun 24, 2024
8008824
fixed utils doctest. Some machines return a different min dtype it seems
Oufattole Jun 24, 2024
215ab04
Merge branch 'docs' of github.com:mmcdermott/MEDS_Tabular_AutoML into…
aleksiakolo Jun 24, 2024
ae42305
swapped from bash to console
Oufattole Jun 24, 2024
88320ea
Merge branch 'docs' of github.com:mmcdermott/MEDS_Tabular_AutoML into…
Oufattole Jun 24, 2024
4a57e11
bash to console
aleksiakolo Jun 24, 2024
a374b26
Revert "bash to console"
aleksiakolo Jun 24, 2024
72dc060
overview bash to console
aleksiakolo Jun 24, 2024
6eddea4
last bash to console
aleksiakolo Jun 24, 2024
ba90809
code quality fixed ?
aleksiakolo Jun 24, 2024
f3d615f
minor structure changes
aleksiakolo Jun 24, 2024
c6cc059
Update pyproject.toml
Oufattole Jul 2, 2024
d1ac6b2
Cleaned up docs formating. Added versioning. Fixed typos. Added feat…
Jul 3, 2024
c82703b
updated versions
Jul 3, 2024
1da8e6d
updated the switcher json file which had a bug
Jul 3, 2024
40e85ce
updated dev version switcher for config so dev version is associated …
Jul 3, 2024
0d148d7
updated switcher json to point to the latest read the docs page
Jul 3, 2024
11e4623
cleaned up tables
Jul 3, 2024
a7cb194
updated the readme
Jul 3, 2024
7fe635a
cleaned up tables
Jul 3, 2024
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
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ instance/

# Sphinx documentation
docs/_build/
docs/source/_autosummary/
docs/source/api/
docs/source/bin/

# PyBuilder
.pybuilder/
Expand Down Expand Up @@ -158,3 +161,5 @@ cython_debug/
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

docs/source/generated
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ This repository consists of two key pieces:
what is more advanced is the efficient construction, storage, and loading of tabular features for the
candidate AutoML models, enabling a far more extensive search over different featurization strategies.

### Scripts and Examples
## Scripts and Examples

See `tests/test_integration.py` for an example of the end-to-end pipeline being run on synthetic data. This
script is a functional test that is also run with `pytest` to verify the correctness of the algorithm.

For an end to end example over MIMIC-IV, see the [companion repository](https://github.com/mmcdermott/MEDS_TAB_MIMIC_IV)
For an end to end example over Philips eICU, see the [eICU companion repository](https://github.com/mmcdermott/MEDS_TAB_EICU).

### Core CLI Scripts Overview
## Core CLI Scripts Overview

1. **`meds-tab-describe`**: This command processes MEDS data shards to compute the frequencies of different code-types
Copy link
Contributor

Choose a reason for hiding this comment

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

Please review the punctuation and grammar in the descriptions of the CLI scripts to ensure clarity and professionalism.

- **`meds-tab-describe`**: This command processes MEDS data shards...
+ **`meds-tab-describe`**: This command processes MEDS data shards...
- **`meds-tab-tabularize-static`**: Filters and processes the dataset based...
+ **`meds-tab-tabularize-static`**: Filters and processes the dataset based...
- **`meds-tab-tabularize-time-series`**: Iterates through combinations of a shard...
+ **`meds-tab-tabularize-time-series`**: Iterates through combinations of a shard...
- **`meds-tab-xgboost`**: Trains an XGBoost model using user-specific parameters.
+ **`meds-tab-xgboost`**: Trains an XGBoost model using user-specific parameters.
- **`meds-tab-xgboost-sweep`**: Conducts an Optuna hyperparameter sweep...
+ **`meds-tab-xgboost-sweep`**: Conducts an Optuna hyperparameter sweep...
- **`generate-permutations`**: Generates and prints a sorted list of all permutations...
+ **`generate-permutations`**: Generates and prints a sorted list of all permutations...

Also applies to: 72-72, 84-84, 99-99, 112-112, 125-125, 129-129

Tools
LanguageTool

[uncategorized] ~59-~59: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...pts Overview 1. meds-tab-describe: This command processes MEDS data shards...


Expand Down Expand Up @@ -124,7 +124,7 @@ For an end to end example over Philips eICU, see the [eICU companion repository]

6. **`meds-tab-xgboost-sweep`**: Conducts an Optuna hyperparameter sweep to optimize over `window_sizes`, `aggregations`, and `min_code_inclusion_frequency`, aiming to enhance model performance and adaptability.

### Additional CLI Scripts
## Additional CLI Scripts

1. **`generate-permutations`**: Generates and prints a sorted list of all permutations from a comma separated input. This is provided for the convenience of sweeping over all possible combinations of window sizes and aggregations.
Comment on lines +140 to 142
Copy link
Contributor

Choose a reason for hiding this comment

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

Ensure clarity in the command's functionality.

Clarify the description of the generate-permutations command.

- 1. **`generate-permutations`**: Generates and prints a sorted list of all permutations from a comma separated input. This is provided for the convenience of sweeping over all possible combinations of window sizes and aggregations.
+ 1. **`generate-permutations`**: Generates and prints all permutations from a comma-separated input, aiding in sweeping over combinations of window sizes and aggregations.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Additional CLI Scripts
1. **`generate-permutations`**: Generates and prints a sorted list of all permutations from a comma separated input. This is provided for the convenience of sweeping over all possible combinations of window sizes and aggregations.
## Additional CLI Scripts
1. **`generate-permutations`**: Generates and prints all permutations from a comma-separated input, aiding in sweeping over combinations of window sizes and aggregations.
Tools
LanguageTool

[uncategorized] ~142-~142: Loose punctuation mark.
Context: ... Scripts 1. generate-permutations: Generates and prints a sorted list of a...

(UNLIKELY_OPENING_PUNCTUATION)


Expand All @@ -149,7 +149,7 @@ For an end to end example over Philips eICU, see the [eICU companion repository]

# How does MEDS-Tab Work?

#### What do you mean "tabular pipelines"? Isn't _all_ structured EHR data already tabular?
## What do you mean "tabular pipelines"? Isn't _all_ structured EHR data already tabular?

This is a common misconception. _Tabular_ data refers to data that can be organized in a consistent, logical
set of rows/columns such that the entirety of a "sample" or "instance" for modeling or analysis is contained
Expand Down
Binary file added docs/assets/main_fig.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/meds_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/pivot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ if "%SPHINXBUILD%" == "" (
set SOURCEDIR=source
set BUILDDIR=build

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
Expand All @@ -19,17 +21,15 @@ if errorlevel 9009 (
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
echo.http://sphinx-doc.org/
exit /b 1
)

if "%1" == "" goto help

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:end
popd
popd
5 changes: 2 additions & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
sphinx==7.1.2
sphinx-rtd-theme==1.3.0rc1
sphinx-collections
recommonmark
piccolo_theme
sphinx_immaterial
sphinx_subfigure
nbsphinx
myst_parser
pypandoc
linkify-it-py
ipykernel
omegaconf
ipywidgets
ipykernel
ipython
esgpt @ git+https://github.com/mmcdermott/EventStreamGPT
8 changes: 0 additions & 8 deletions docs/source/api.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/source/computational-performance.rst

This file was deleted.

Loading
Loading