diff --git a/docs/source/tutorials/kaggle/heart_failure_prediction.ipynb b/docs/source/tutorials/kaggle/heart_failure_prediction.ipynb index 40aad9a51..1a35c1186 100644 --- a/docs/source/tutorials/kaggle/heart_failure_prediction.ipynb +++ b/docs/source/tutorials/kaggle/heart_failure_prediction.ipynb @@ -49,7 +49,7 @@ "from cyclops.report import ModelCardReport\n", "from cyclops.report.plot.classification import ClassificationPlotter\n", "from cyclops.report.utils import flatten_results_dict\n", - "from cyclops.tasks.mortality_prediction import MortalityPredictionTask\n", + "from cyclops.tasks import BinaryTabularClassificationTask\n", "from cyclops.utils.file import join, load_dataframe" ] }, @@ -57,17 +57,19 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "CyclOps offers a package for documentation of the model through a model card. The `ModelCardReport` class is used to populate and generate the model card as an HTML file. The model card has the following sections:\n", + "CyclOps offers a package for documentation of the model through a model report. The `ModelCardReport` class is used to populate and generate the model report as an HTML file. The model report has the following sections:\n", + "\n", + "- Overview: Provides a high level overview of how the model is doing (a quick glance of important metrics), and how it is doing over time (performance over several metrics and subgroups over time).\n", + "- Datasets: High level statistics of the training data, including changes in distribution over time.\n", + "- Quantitative Analysis: This section contains additional detailed performance metrics of the model for different sets of the data and subpopulations.\n", + "- Fairness Analysis: This section contains the fairness metrics of the model.\n", "- Model Details: This section contains descriptive metadata about the model such as the owners, version, license, etc.\n", "- Model Parameters: This section contains the technical details of the model such as the model architecture, training parameters, etc.\n", "- Considerations: This section contains descriptions of the considerations involved in developing and using the model such as the intended use, limitations, etc.\n", - "- Quantitative Analysis: This section contains the performance metrics of the model for different sets of the data and subpopulations.\n", - "- Explainaibility Analysis: This section contains the explainability metrics of the model.\n", - "- Fairness Analysis: This section contains the fairness metrics of the model.\n", "\n", - "We will use this to document the model development process as we go along and generate the model card at the end.\n", + "We will use this to document the model development process as we go along and generate the model report at the end.\n", "\n", - "`The model card tool is a work in progress and is subject to change.`" + "`The model report tool is a work in progress and is subject to change.`" ] }, { @@ -579,7 +581,7 @@ }, "outputs": [], "source": [ - "mortality_task = MortalityPredictionTask(\n", + "mortality_task = BinaryTabularClassificationTask(\n", " {model_name: model},\n", " task_features=features_list,\n", " task_target=\"outcome\",\n", diff --git a/docs/source/tutorials/nihcxr/cxr_classification.ipynb b/docs/source/tutorials/nihcxr/cxr_classification.ipynb index 1c1dbaaad..32a96e026 100644 --- a/docs/source/tutorials/nihcxr/cxr_classification.ipynb +++ b/docs/source/tutorials/nihcxr/cxr_classification.ipynb @@ -78,17 +78,19 @@ "id": "198896c7", "metadata": {}, "source": [ - "CyclOps offers a package for documentation of the model through a model card. The `ModelCardReport` class is used to populate and generate the model card as an HTML file. The model card has the following sections:\n", + "CyclOps offers a package for documentation of the model through a model report. The `ModelCardReport` class is used to populate and generate the model report as an HTML file. The model report has the following sections:\n", + "\n", + "- Overview: Provides a high level overview of how the model is doing (a quick glance of important metrics), and how it is doing over time (performance over several metrics and subgroups over time).\n", + "- Datasets: High level statistics of the training data, including changes in distribution over time.\n", + "- Quantitative Analysis: This section contains additional detailed performance metrics of the model for different sets of the data and subpopulations.\n", + "- Fairness Analysis: This section contains the fairness metrics of the model.\n", "- Model Details: This section contains descriptive metadata about the model such as the owners, version, license, etc.\n", "- Model Parameters: This section contains the technical details of the model such as the model architecture, training parameters, etc.\n", "- Considerations: This section contains descriptions of the considerations involved in developing and using the model such as the intended use, limitations, etc.\n", - "- Quantitative Analysis: This section contains the performance metrics of the model for different sets of the data and subpopulations.\n", - "- Explainaibility Analysis: This section contains the explainability metrics of the model.\n", - "- Fairness Analysis: This section contains the fairness metrics of the model.\n", "\n", - "We will use this to document the model development process as we go along and generate the model card at the end.\n", + "We will use this to document the model development process as we go along and generate the model report at the end.\n", "\n", - "`The model card tool is a work in progress and is subject to change.`" + "`The model report tool is a work in progress and is subject to change.`" ] }, { @@ -153,7 +155,7 @@ "id": "c7c9172a", "metadata": {}, "source": [ - "### Load Model and get Predictions" + "## Model Creation" ] }, { @@ -164,6 +166,7 @@ "outputs": [], "source": [ "model = PTModel(DenseNet(weights=\"densenet121-res224-nih\"))\n", + "\n", "model.initialize()\n", "nih_ds = model.predict(\n", " nih_ds,\n", diff --git a/docs/source/tutorials/synthea/los_prediction.ipynb b/docs/source/tutorials/synthea/los_prediction.ipynb index ba6c7a496..ac3c763f8 100644 --- a/docs/source/tutorials/synthea/los_prediction.ipynb +++ b/docs/source/tutorials/synthea/los_prediction.ipynb @@ -60,7 +60,7 @@ "from cyclops.report import ModelCardReport\n", "from cyclops.report.plot.classification import ClassificationPlotter\n", "from cyclops.report.utils import flatten_results_dict\n", - "from cyclops.tasks.mortality_prediction import MortalityPredictionTask" + "from cyclops.tasks import BinaryTabularClassificationTask" ] }, { @@ -68,17 +68,19 @@ "id": "a0c35352-ccef-47c9-8d1a-3062c62adb97", "metadata": {}, "source": [ - "CyclOps offers a package for documentation of the model through a model card. The `ModelCardReport` class is used to populate and generate the model card as an HTML file. The model card has the following sections:\n", + "CyclOps offers a package for documentation of the model through a model report. The `ModelCardReport` class is used to populate and generate the model report as an HTML file. The model report has the following sections:\n", + "\n", + "- Overview: Provides a high level overview of how the model is doing (a quick glance of important metrics), and how it is doing over time (performance over several metrics and subgroups over time).\n", + "- Datasets: High level statistics of the training data, including changes in distribution over time.\n", + "- Quantitative Analysis: This section contains additional detailed performance metrics of the model for different sets of the data and subpopulations.\n", + "- Fairness Analysis: This section contains the fairness metrics of the model.\n", "- Model Details: This section contains descriptive metadata about the model such as the owners, version, license, etc.\n", "- Model Parameters: This section contains the technical details of the model such as the model architecture, training parameters, etc.\n", "- Considerations: This section contains descriptions of the considerations involved in developing and using the model such as the intended use, limitations, etc.\n", - "- Quantitative Analysis: This section contains the performance metrics of the model for different sets of the data and subpopulations.\n", - "- Explainaibility Analysis: This section contains the explainability metrics of the model.\n", - "- Fairness Analysis: This section contains the fairness metrics of the model.\n", "\n", - "We will use this to document the model development process as we go along and generate the model card at the end.\n", + "We will use this to document the model development process as we go along and generate the model report at the end.\n", "\n", - "`The model card tool is a work in progress and is subject to change.`" + "`The model report tool is a work in progress and is subject to change.`" ] }, { @@ -808,7 +810,7 @@ }, "outputs": [], "source": [ - "los_task = MortalityPredictionTask(\n", + "los_task = BinaryTabularClassificationTask(\n", " {model_name: model},\n", " task_features=features_list,\n", " task_target=\"outcome\",\n",