From 01481396e56bba5b3913b05be8c5ef0d8916ef3b Mon Sep 17 00:00:00 2001 From: Amrit K <amritk@vectorinstitute.ai> Date: Tue, 7 Nov 2023 14:39:19 -0500 Subject: [PATCH 1/2] Update links to model report html files --- README.md | 2 +- docs/source/tutorials/kaggle/heart_failure_prediction.ipynb | 2 +- docs/source/tutorials/nihcxr/cxr_classification.ipynb | 2 +- docs/source/tutorials/synthea/los_prediction.ipynb | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 405352354..311033aa9 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ * Chest X-ray classification * `evaluate` - Evaluate models on clinical prediction tasks * `monitor` - Detect dataset shift relevant for clinical use cases -* `report` - Create [model report cards](https://vectorinstitute.github.io/cyclops/api/tutorials/kaggle/model_card.html) for clinical ML models +* `report` - Create [model report cards](https://vectorinstitute.github.io/cyclops/api/tutorials/nihcxr/nihcxr_report_periodic.html) for clinical ML models ``cyclops`` also provides a library of end-to-end use cases on clinical datasets such as diff --git a/docs/source/tutorials/kaggle/heart_failure_prediction.ipynb b/docs/source/tutorials/kaggle/heart_failure_prediction.ipynb index b921ff863..40aad9a51 100644 --- a/docs/source/tutorials/kaggle/heart_failure_prediction.ipynb +++ b/docs/source/tutorials/kaggle/heart_failure_prediction.ipynb @@ -1211,7 +1211,7 @@ "tags": [] }, "source": [ - "You can view the generated HTML [report](./model_card.html)." + "You can view the generated HTML [report](./heart_failure_report_periodic.html)." ] } ], diff --git a/docs/source/tutorials/nihcxr/cxr_classification.ipynb b/docs/source/tutorials/nihcxr/cxr_classification.ipynb index 921311294..1c1dbaaad 100644 --- a/docs/source/tutorials/nihcxr/cxr_classification.ipynb +++ b/docs/source/tutorials/nihcxr/cxr_classification.ipynb @@ -626,7 +626,7 @@ "id": "d7545d39", "metadata": {}, "source": [ - "You can view the generated HTML [report](./model_card.html)." + "You can view the generated HTML [report](./nihcxr_report_periodic.html)." ] } ], diff --git a/docs/source/tutorials/synthea/los_prediction.ipynb b/docs/source/tutorials/synthea/los_prediction.ipynb index 4eacc6c15..ba6c7a496 100644 --- a/docs/source/tutorials/synthea/los_prediction.ipynb +++ b/docs/source/tutorials/synthea/los_prediction.ipynb @@ -1489,7 +1489,7 @@ "id": "0d953f1b-845d-424e-b8b6-d782973d9e84", "metadata": {}, "source": [ - "You can view the generated HTML [report](./model_card.html)." + "You can view the generated HTML [report](./length_of_stay_report_periodic.html)." ] } ], From 38884df40e870bcc957b46fbdaaa6e33a91b560a Mon Sep 17 00:00:00 2001 From: Amrit K <amritk@vectorinstitute.ai> Date: Tue, 7 Nov 2023 14:40:00 -0500 Subject: [PATCH 2/2] Update RST file --- docs/source/intro.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/intro.rst b/docs/source/intro.rst index 125c6e38c..36c728c5a 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -25,7 +25,7 @@ models for healthcare. It provides a few high-level APIs namely: - ``evaluate`` - Evaluate models on clinical prediction tasks - ``monitor`` - Detect dataset shift relevant for clinical use cases - ``report`` - Create `model report - cards <https://vectorinstitute.github.io/cyclops/api/tutorials/kaggle/model_card.html>`__ + cards <https://vectorinstitute.github.io/cyclops/api/tutorials/nihcxr/nihcxr_report_periodic.html>`__ for clinical ML models ``cyclops`` also provides a library of end-to-end use cases on clinical @@ -73,7 +73,7 @@ Multiple extras could also be combined, for example to install with both python3 -m pip install 'pycyclops[report,models]' 🧑🏿💻 Developing -============= +======================= Using poetry ------------