added model info card to sidebar (#498)

* added model info card to sidebar

---------

Signed-off-by: Amrit Krishnan <amrit110@gmail.com>
Co-authored-by: Ali Kore <akore0x5f@gmail.com>
Co-authored-by: Amrit Krishnan <amrit110@gmail.com>
Co-authored-by: Amrit K <amritk@vectorinstitute.ai>

Author: 3 people

cyclops/report/templates/cyclops_generic_template.jinja

@@ -473,10 +473,16 @@
   </div>
 </label>
 <div id='sidebar'>
-  <a href="https://vectorinstitute.github.io/cyclops/" target="_blank"><img
-    src="https://raw.githubusercontent.com/VectorInstitute/cyclops/main/docs/source/theme/static/cyclops_logo-dark.png"
-    alt="CyclOps Logo" id="logo"></a>
-  <span class='title'>CARD SECTIONS</span>
+  <div id="model_info_card">
+    <div id="model_info">
+        <h4 style="margin: 0.5rem;">{{ model_card.model_details.name }}</h4>
+        <h6 style="margin: 0.5rem;">Model Monitoring Report</h6>
+        <br>
+        <h6 style="margin: 0.5rem;">Model Developed By: {{ model_card.model_details.owners[0].name }}</h6>
+        <h6 style="margin: 0.5rem;">Contact: {{ model_card.model_details.owners[0].contact }}</h6>
+        <h6 style="margin: 0.5rem;">Email: {{ model_card.model_details.owners[0].email }}</h6>
+    </div>
+  </div>
   <hr>
   <ul id='contents'>
     {% for name, section in model_card %}
@@ -703,6 +709,19 @@
         transition: margin-left 0.2s ease-in-out;
       }
 
+      #model_info_card {
+        width: 100%;
+        background-color: #0073e4;
+        text-align: left;
+        color: white;
+        display: inline-block;
+      }
+
+      #model_info {
+        padding-top: 2.5rem;
+        padding-left: 1rem;
+      }
+
       body {
         background-color: #f3f4f6;
       }

docs/source/tutorials/kaggle/heart_failure_prediction.ipynb

@@ -1082,17 +1082,23 @@
    "source": [
     "report.log_from_dict(\n",
     "    data={\n",
+    "        \"name\": \"Heart Failure Prediction Model\",\n",
     "        \"description\": \"The model was trained on the Kaggle Heart Failure \\\n",
     "        Prediction Dataset to predict risk of heart failure.\",\n",
     "    },\n",
     "    section_name=\"model_details\",\n",
     ")\n",
+    "\n",
     "report.log_version(\n",
     "    version_str=\"0.0.1\",\n",
     "    date=str(date.today()),\n",
     "    description=\"Initial Release\",\n",
     ")\n",
-    "report.log_owner(name=\"CyclOps Team\", contact=\"vectorinstitute.github.io/cyclops/\")\n",
+    "report.log_owner(\n",
+    "    name=\"CyclOps Team\",\n",
+    "    contact=\"vectorinstitute.github.io/cyclops/\",\n",
+    "    email=\"cyclops@vectorinstitute.ai\",\n",
+    ")\n",
     "report.log_license(identifier=\"Apache-2.0\")\n",
     "report.log_reference(\n",
     "    link=\"https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.SGDClassifier.html\",  # noqa: E501\n",

docs/source/tutorials/nihcxr/cxr_classification.ipynb

@@ -552,7 +552,7 @@
     "report.log_owner(\n",
     "    name=\"Machine Learning and Medicine Lab\",\n",
     "    contact=\"mlmed.org\",\n",
-    "    email=\"mlmed@gmail.com\",\n",
+    "    email=\"joseph@josephpcohen.com\",\n",
     ")\n",
     "\n",
     "# considerations\n",

docs/source/tutorials/synthea/los_prediction.ipynb

@@ -1360,6 +1360,7 @@
    "source": [
     "report.log_from_dict(\n",
     "    data={\n",
+    "        \"name\": \"Prolonged Length of Stay Prediction Model\",\n",
     "        \"description\": \"The model was trained on the Synthea synthetic dataset \\\n",
     "            to predict prolonged stay in the hospital.\",\n",
     "    },\n",
@@ -1370,7 +1371,11 @@
     "    date=str(date.today()),\n",
     "    description=\"Initial Release\",\n",
     ")\n",
-    "report.log_owner(name=\"CyclOps Team\", contact=\"vectorinstitute.github.io/cyclops/\")\n",
+    "report.log_owner(\n",
+    "    name=\"CyclOps Team\",\n",
+    "    contact=\"vectorinstitute.github.io/cyclops/\",\n",
+    "    email=\"cyclops@vectorinstitute.ai\",\n",
+    ")\n",
     "report.log_license(identifier=\"Apache-2.0\")\n",
     "report.log_reference(\n",
     "    link=\"https://xgboost.readthedocs.io/en/stable/python/python_api.html\",  # noqa: E501\n",