examples/Simulating_Data.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "55155365-701c-41e6-9079-51fb02bb2036",
   "metadata": {},
   "source": [
    "# Simulating Data From Bayesian Networks\n",
    "\n",
    "pgmpy implements the `DiscreteBayesianNetwork.simulate` method to allow users to simulate data from a fully defined Bayesian Network under various conditions. These conditions can be any combination of:\n",
    "1. Virtual Evidence\n",
    "2. Hard Evidence\n",
    "3. Virtual Intervention\n",
    "4. Hard Intervention\n",
    "\n",
    "Lastly, users can also provide data corresponding to some of the variables in the model (partial samples) to the simulation method. This allows users to fix the values of those variables to the specified value."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "2feeb277",
   "metadata": {},
   "outputs": [],
   "source": [
    "# A helper function to compute probability distributions from simulated samples.\n",
    "def get_distribution(samples, variables=None):\n",
    "    \"\"\"\n",
    "    For marginal distribution, P(A): get_distribution(samples, variables=['A'])\n",
    "    For joint distribution, P(A, B): get_distribution(samples, variables=['A', 'B'])\n",
    "    \"\"\"\n",
    "    if variables is None:\n",
    "        raise ValueError(\"variables must be specified\")\n",
    "\n",
    "    return samples.groupby(variables).size() / samples.shape[0]"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "cdb2e2f1",
   "metadata": {},
   "outputs": [],
   "source": [
    "# Do not print warnings\n",
    "import logging\n",
    "from pgmpy.global_vars import logger\n",
    "logger.setLevel(logging.ERROR)\n",
    "\n",
    "# Specify the model to simulate data from.\n",
    "from pgmpy.factors.discrete import TabularCPD\n",
    "from pgmpy.utils import get_example_model\n",
    "\n",
    "import numpy as np\n",
    "import pandas as pd\n",
    "\n",
    "alarm = get_example_model(\"alarm\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "6c064112",
   "metadata": {},
   "source": [
    "## 1. Standard simulation\n",
    "\n",
    "Without any specified conditions for simulation, the `simulate` method draws samples from the joint distribution of the model."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "94e02da7",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "application/vnd.jupyter.widget-view+json": {
       "model_id": "1d87045741e04846a89c99bdb785650b",
       "version_major": 2,
       "version_minor": 0
      },
      "text/plain": [
       "  0%|          | 0/37 [00:00<?, ?it/s]"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>TPR</th>\n",
       "      <th>PAP</th>\n",
       "      <th>MINVOL</th>\n",
       "      <th>HREKG</th>\n",
       "      <th>EXPCO2</th>\n",
       "      <th>DISCONNECT</th>\n",
       "      <th>VENTMACH</th>\n",
       "      <th>VENTLUNG</th>\n",
       "      <th>LVEDVOLUME</th>\n",
       "      <th>HR</th>\n",
       "      <th>...</th>\n",
       "      <th>SHUNT</th>\n",
       "      <th>VENTTUBE</th>\n",
       "      <th>MINVOLSET</th>\n",
       "      <th>LVFAILURE</th>\n",
       "      <th>ERRLOWOUTPUT</th>\n",
       "      <th>HRBP</th>\n",
       "      <th>FIO2</th>\n",
       "      <th>BP</th>\n",
       "      <th>HISTORY</th>\n",
       "      <th>STROKEVOLUME</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>TRUE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>5 rows × 37 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "      TPR     PAP MINVOL   HREKG EXPCO2 DISCONNECT VENTMACH VENTLUNG  \\\n",
       "0     LOW  NORMAL   ZERO  NORMAL    LOW      FALSE   NORMAL     ZERO   \n",
       "1    HIGH  NORMAL   ZERO    HIGH    LOW       TRUE   NORMAL     ZERO   \n",
       "2     LOW  NORMAL   ZERO    HIGH    LOW      FALSE   NORMAL     ZERO   \n",
       "3     LOW  NORMAL   ZERO    HIGH    LOW      FALSE   NORMAL     ZERO   \n",
       "4  NORMAL    HIGH   ZERO    HIGH    LOW      FALSE   NORMAL     ZERO   \n",
       "\n",
       "  LVEDVOLUME    HR  ...   SHUNT VENTTUBE MINVOLSET LVFAILURE ERRLOWOUTPUT  \\\n",
       "0     NORMAL  HIGH  ...  NORMAL      LOW    NORMAL     FALSE        FALSE   \n",
       "1     NORMAL  HIGH  ...  NORMAL     ZERO    NORMAL     FALSE        FALSE   \n",
       "2     NORMAL  HIGH  ...  NORMAL      LOW    NORMAL     FALSE        FALSE   \n",
       "3     NORMAL  HIGH  ...  NORMAL      LOW    NORMAL     FALSE        FALSE   \n",
       "4     NORMAL  HIGH  ...  NORMAL      LOW    NORMAL     FALSE        FALSE   \n",
       "\n",
       "   HRBP    FIO2      BP HISTORY STROKEVOLUME  \n",
       "0  HIGH  NORMAL     LOW   FALSE       NORMAL  \n",
       "1  HIGH  NORMAL    HIGH   FALSE       NORMAL  \n",
       "2  HIGH  NORMAL     LOW   FALSE       NORMAL  \n",
       "3  HIGH  NORMAL     LOW   FALSE       NORMAL  \n",
       "4  HIGH  NORMAL  NORMAL   FALSE       NORMAL  \n",
       "\n",
       "[5 rows x 37 columns]"
      ]
     },
     "execution_count": 3,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "samples = alarm.simulate(n_samples=int(1e4))\n",
    "samples.head()"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "b6d6664d",
   "metadata": {},
   "source": [
    "## 2. Simulation under specified evidence\n",
    "\n",
    "Specifying hard evidence for some variables fixes their values to the specified evidence value during simulation."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "6ebdeade",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "application/vnd.jupyter.widget-view+json": {
       "model_id": "8a54addf4b4f4f22b66f3b155c433192",
       "version_major": 2,
       "version_minor": 0
      },
      "text/plain": [
       "  0%|          | 0/10000 [00:00<?, ?it/s]"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>TPR</th>\n",
       "      <th>PAP</th>\n",
       "      <th>MINVOL</th>\n",
       "      <th>HREKG</th>\n",
       "      <th>EXPCO2</th>\n",
       "      <th>DISCONNECT</th>\n",
       "      <th>VENTMACH</th>\n",
       "      <th>VENTLUNG</th>\n",
       "      <th>LVEDVOLUME</th>\n",
       "      <th>HR</th>\n",
       "      <th>...</th>\n",
       "      <th>SHUNT</th>\n",
       "      <th>VENTTUBE</th>\n",
       "      <th>MINVOLSET</th>\n",
       "      <th>LVFAILURE</th>\n",
       "      <th>ERRLOWOUTPUT</th>\n",
       "      <th>HRBP</th>\n",
       "      <th>FIO2</th>\n",
       "      <th>BP</th>\n",
       "      <th>HISTORY</th>\n",
       "      <th>STROKEVOLUME</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>NORMAL</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>LOW</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>LOW</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>5 rows × 37 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "      TPR     PAP  MINVOL   HREKG EXPCO2 DISCONNECT VENTMACH VENTLUNG  \\\n",
       "0  NORMAL  NORMAL    ZERO    HIGH    LOW      FALSE   NORMAL     ZERO   \n",
       "1     LOW  NORMAL    ZERO    HIGH    LOW      FALSE   NORMAL     ZERO   \n",
       "2     LOW  NORMAL    ZERO    HIGH    LOW      FALSE   NORMAL     ZERO   \n",
       "3     LOW  NORMAL    ZERO    HIGH    LOW      FALSE   NORMAL     ZERO   \n",
       "4     LOW  NORMAL  NORMAL  NORMAL    LOW      FALSE   NORMAL     ZERO   \n",
       "\n",
       "  LVEDVOLUME    HR  ...   SHUNT VENTTUBE MINVOLSET LVFAILURE ERRLOWOUTPUT  \\\n",
       "0     NORMAL  HIGH  ...  NORMAL      LOW    NORMAL     FALSE        FALSE   \n",
       "1     NORMAL  HIGH  ...  NORMAL      LOW    NORMAL     FALSE        FALSE   \n",
       "2     NORMAL  HIGH  ...  NORMAL      LOW    NORMAL     FALSE        FALSE   \n",
       "3     NORMAL  HIGH  ...  NORMAL      LOW    NORMAL     FALSE        FALSE   \n",
       "4     NORMAL  HIGH  ...    HIGH      LOW    NORMAL     FALSE        FALSE   \n",
       "\n",
       "   HRBP    FIO2   BP HISTORY STROKEVOLUME  \n",
       "0  HIGH  NORMAL  LOW   FALSE          LOW  \n",
       "1  HIGH  NORMAL  LOW   FALSE          LOW  \n",
       "2  HIGH     LOW  LOW   FALSE       NORMAL  \n",
       "3  HIGH  NORMAL  LOW   FALSE       NORMAL  \n",
       "4  HIGH  NORMAL  LOW   FALSE       NORMAL  \n",
       "\n",
       "[5 rows x 37 columns]"
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "evidence = {\"CVP\": \"NORMAL\", \"HR\": \"HIGH\"}\n",
    "samples = alarm.simulate(n_samples=int(1e4), evidence=evidence)\n",
    "samples.head()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "id": "2587ee03-7466-4bd2-8f7b-9d7e32780637",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "True\n",
      "True\n"
     ]
    }
   ],
   "source": [
    "# All values of HR and CVP should be set to HIGH and NORMAL respectively.\n",
    "print(all(samples.HR == \"HIGH\"))\n",
    "print(all(samples.CVP == \"NORMAL\"))"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "e58aaee7",
   "metadata": {},
   "source": [
    "## 3. Simulation under soft/virtual evidence\n",
    "\n",
    "Unlike hard evidence where the value of the specified variables is fixed to the specified evidence, virtual evidence allows users to set the marginal distribution of variables."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "id": "edb1b6dd",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "application/vnd.jupyter.widget-view+json": {
       "model_id": "bb0f2d625fdd4148b6bf35f760366ec2",
       "version_major": 2,
       "version_minor": 0
      },
      "text/plain": [
       "  0%|          | 0/10000 [00:00<?, ?it/s]"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "# The virtual evidence is specified using TabularCPDs. Here, P(CVP=NORMAL) = 0.2, P(CVP=LOW) = 0.3, and P(CPV=HIGH) = 0.5\n",
    "cvp_evidence = TabularCPD(variable=\"CVP\",\n",
    "                          variable_card=3,\n",
    "                          values=[[0.2], [0.3], [0.5]],\n",
    "                          state_names={\"CVP\": [\"LOW\", \"NORMAL\", \"HIGH\"]})\n",
    "samples = alarm.simulate(n_samples=int(1e4), virtual_evidence=[cvp_evidence])"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "id": "30e2fb63-8ca2-472e-8c2e-3e32169ea9ef",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "CVP\n",
       "HIGH      0.2414\n",
       "LOW       0.0692\n",
       "NORMAL    0.6894\n",
       "dtype: float64"
      ]
     },
     "execution_count": 7,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# Check the marginal distribution of CVP\n",
    "get_distribution(samples, variables=['CVP'])"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "9332944a",
   "metadata": {},
   "source": [
    "## 4. Simulation under specified intervention\n",
    "\n",
    "Using the `do` argument, users can specify interventions to the model. The value of the intervened variables are set to the specified value and all incoming edges to these variables are removed in the model."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "id": "b89529e8",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "application/vnd.jupyter.widget-view+json": {
       "model_id": "a3b70369804e48f28b7198ac93834b0d",
       "version_major": 2,
       "version_minor": 0
      },
      "text/plain": [
       "  0%|          | 0/10000 [00:00<?, ?it/s]"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>TPR</th>\n",
       "      <th>PAP</th>\n",
       "      <th>MINVOL</th>\n",
       "      <th>HREKG</th>\n",
       "      <th>EXPCO2</th>\n",
       "      <th>DISCONNECT</th>\n",
       "      <th>VENTMACH</th>\n",
       "      <th>VENTLUNG</th>\n",
       "      <th>LVEDVOLUME</th>\n",
       "      <th>HR</th>\n",
       "      <th>...</th>\n",
       "      <th>SHUNT</th>\n",
       "      <th>VENTTUBE</th>\n",
       "      <th>MINVOLSET</th>\n",
       "      <th>LVFAILURE</th>\n",
       "      <th>ERRLOWOUTPUT</th>\n",
       "      <th>HRBP</th>\n",
       "      <th>FIO2</th>\n",
       "      <th>BP</th>\n",
       "      <th>HISTORY</th>\n",
       "      <th>STROKEVOLUME</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>LOW</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>NORMAL</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>LOW</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>TRUE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>LOW</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>NORMAL</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>LOW</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>TRUE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>TRUE</td>\n",
       "      <td>LOW</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>LOW</td>\n",
       "      <td>LOW</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>NORMAL</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>ZERO</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>...</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>LOW</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>HIGH</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>NORMAL</td>\n",
       "      <td>FALSE</td>\n",
       "      <td>LOW</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>5 rows × 37 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "      TPR     PAP MINVOL HREKG EXPCO2 DISCONNECT VENTMACH VENTLUNG LVEDVOLUME  \\\n",
       "0    HIGH  NORMAL   ZERO  HIGH    LOW      FALSE   NORMAL     ZERO        LOW   \n",
       "1  NORMAL  NORMAL   ZERO  HIGH    LOW      FALSE   NORMAL     ZERO        LOW   \n",
       "2  NORMAL  NORMAL   ZERO  HIGH    LOW      FALSE   NORMAL     ZERO        LOW   \n",
       "3     LOW  NORMAL   ZERO  HIGH    LOW      FALSE   NORMAL     ZERO     NORMAL   \n",
       "4  NORMAL  NORMAL   ZERO  HIGH   HIGH      FALSE   NORMAL     ZERO       HIGH   \n",
       "\n",
       "     HR  ...   SHUNT VENTTUBE MINVOLSET LVFAILURE ERRLOWOUTPUT    HRBP  \\\n",
       "0  HIGH  ...  NORMAL      LOW    NORMAL     FALSE        FALSE  NORMAL   \n",
       "1  HIGH  ...  NORMAL      LOW    NORMAL      TRUE        FALSE    HIGH   \n",
       "2  HIGH  ...  NORMAL      LOW    NORMAL      TRUE        FALSE    HIGH   \n",
       "3  HIGH  ...  NORMAL      LOW    NORMAL     FALSE        FALSE    HIGH   \n",
       "4  HIGH  ...  NORMAL      LOW    NORMAL     FALSE        FALSE    HIGH   \n",
       "\n",
       "     FIO2      BP HISTORY STROKEVOLUME  \n",
       "0  NORMAL    HIGH   FALSE       NORMAL  \n",
       "1  NORMAL     LOW   FALSE          LOW  \n",
       "2  NORMAL     LOW    TRUE          LOW  \n",
       "3     LOW     LOW   FALSE       NORMAL  \n",
       "4  NORMAL  NORMAL   FALSE          LOW  \n",
       "\n",
       "[5 rows x 37 columns]"
      ]
     },
     "execution_count": 8,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "samples = alarm.simulate(n_samples=int(1e4), do={\"CVP\": \"NORMAL\", \"HR\": \"HIGH\"})\n",
    "samples.head()"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "4b9fa901",
   "metadata": {},
   "source": [
    "## 5. Simulation under soft/virtual intervention\n",
    "\n",
    "Similar to virtual evidence, users can specify virtual intervention as well."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "id": "eab6d41b",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "application/vnd.jupyter.widget-view+json": {
       "model_id": "215b2f38eada4346ac21fd581671b37c",
       "version_major": 2,
       "version_minor": 0
      },
      "text/plain": [
       "  0%|          | 0/10000 [00:00<?, ?it/s]"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "data": {
      "text/plain": [
       "CVP\n",
       "HIGH      0.3814\n",
       "LOW       0.2110\n",
       "NORMAL    0.4076\n",
       "dtype: float64"
      ]
     },
     "execution_count": 9,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "cvp_intervention = TabularCPD(variable=\"CVP\",\n",
    "                              variable_card=3,\n",
    "                              values=[[0.2], [0.3], [0.5]],\n",
    "                              state_names={\"CVP\": [\"LOW\", \"NORMAL\", \"HIGH\"]})\n",
    "samples = alarm.simulate(n_samples=int(1e4), virtual_intervention=[cvp_intervention])\n",
    "get_distribution(samples, variables=[\"CVP\"])  # P(HISTORY)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "acb80705-1b6d-46f0-81e5-d647231f28d7",
   "metadata": {},
   "source": [
    "## 6. Partial samples\n",
    "\n",
    "Lastly, users can also pass already generated data for some variables (for example, from some other simulation) to the simulation. This is equivalent to separately specifying evidence for each sample that is generate."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "id": "e55792c2-7f57-4e1b-be8c-d0f5ba800dfe",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "application/vnd.jupyter.widget-view+json": {
       "model_id": "1c37a46b25674a7bb508908dd1611315",
       "version_major": 2,
       "version_minor": 0
      },
      "text/plain": [
       "  0%|          | 0/37 [00:00<?, ?it/s]"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "# Generate some data on CVP.\n",
    "partial_cvp = pd.DataFrame(np.random.choice([\"LOW\", \"NORMAL\", \"HIGH\"], int(1e4)), columns=['CVP'])\n",
    "samples = alarm.simulate(n_samples=int(1e4), partial_samples=partial_cvp)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "bb58b071-0365-4bc3-a7d1-09ee955d19fb",
   "metadata": {},
   "outputs": [],
   "source": [
    "samples.CVP == partial_cvp"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.12.0"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}