deploy: 2c2d6a8

Bayer-Group · Jun 26, 2024 · ab06eac · ab06eac
1 parent 341dd13
commit ab06eac
Show file tree

Hide file tree

Showing 31 changed files with 138 additions and 95 deletions.
diff --git a/.doctrees/demos/balance_calculators.doctree b/.doctrees/demos/balance_calculators.doctree
diff --git a/.doctrees/demos/cardinality_matcher.doctree b/.doctrees/demos/cardinality_matcher.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/nbsphinx/demos/balance_calculators.ipynb b/.doctrees/nbsphinx/demos/balance_calculators.ipynb
@@ -1,5 +1,13 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "f21133df-9ed8-4757-8963-6e2176c3128e",
+   "metadata": {},
+   "source": [
+    "# Balance Calculators"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,
@@ -313,7 +321,7 @@
    "id": "3eddef9b-b87d-4a0c-ae51-17d204422be9",
    "metadata": {},
    "source": [
-    "# Fit Balance Calculator"
+    "## Fit Balance Calculator"
    ]
   },
   {
@@ -336,7 +344,7 @@
    "id": "3d588103-f175-43f8-9ab5-38b0a186bb04",
    "metadata": {},
    "source": [
-    "# Compute the balance between pool and target"
+    "## Balance between pool and target"
    ]
   },
   {
@@ -387,7 +395,7 @@
    "id": "ceb3e196-21c8-43ad-83f3-12686008bb27",
    "metadata": {},
    "source": [
-    "# Compute the balance between subset of pool and target"
+    "## Balance between subset of pool and target"
    ]
   },
   {
@@ -438,7 +446,7 @@
    "id": "9cb4fcef-14a0-4344-a28a-601911160219",
    "metadata": {},
    "source": [
-    "# Compute the balance between several subsets simultaneously"
+    "## Balance between several subsets simultaneously"
    ]
   },
   {
@@ -539,7 +547,7 @@
    "id": "63857014-b52b-40d9-8d7b-208c7b981129",
    "metadata": {},
    "source": [
-    "# Basic Genetic Optimizer"
+    "## Basic Genetic Optimizer"
    ]
   },
   {

diff --git a/.doctrees/nbsphinx/demos/cardinality_matcher.ipynb b/.doctrees/nbsphinx/demos/cardinality_matcher.ipynb
@@ -1,5 +1,13 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "5dacbe5f-0aa3-4b43-bfb1-cc58f02a7ded",
+   "metadata": {},
+   "source": [
+    "# Cardinality matching"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,
@@ -263,7 +271,7 @@
    "id": "4e699cd6-9f4c-4493-a261-0a704f288c64",
    "metadata": {},
    "source": [
-    "# Solve for largest subset of pool subject to balance constraint"
+    "## Optimize pool size subject to balance constraint"
    ]
   },
   {
@@ -427,7 +435,7 @@
    "id": "ce715a25-d006-419d-ab1b-c6dfe3e77c29",
    "metadata": {},
    "source": [
-    "# Optimize match among all subsets of a fixed size with balance constraint"
+    "## Optimize balance with balance constraint"
    ]
   },
   {
@@ -548,7 +556,7 @@
    "id": "f6461053-c41c-472a-ad31-57245b690d42",
    "metadata": {},
    "source": [
-    "# Optimize match among all subsets of a fixed size without balance constraint"
+    "## Optimize balance without balance constraint"
    ]
   },
   {

diff --git a/...bsphinx/demos_cardinality_matcher_9_0.png → ...sphinx/demos_cardinality_matcher_10_0.png b/...bsphinx/demos_cardinality_matcher_9_0.png → ...sphinx/demos_cardinality_matcher_10_0.png
diff --git a/...bsphinx/demos_cardinality_matcher_9_1.png → ...sphinx/demos_cardinality_matcher_10_1.png b/...bsphinx/demos_cardinality_matcher_9_1.png → ...sphinx/demos_cardinality_matcher_10_1.png
diff --git a/...sphinx/demos_cardinality_matcher_12_0.png → ...sphinx/demos_cardinality_matcher_13_0.png b/...sphinx/demos_cardinality_matcher_12_0.png → ...sphinx/demos_cardinality_matcher_13_0.png
diff --git a/...sphinx/demos_cardinality_matcher_12_1.png → ...sphinx/demos_cardinality_matcher_13_1.png b/...sphinx/demos_cardinality_matcher_12_1.png → ...sphinx/demos_cardinality_matcher_13_1.png
diff --git a/...bsphinx/demos_cardinality_matcher_6_0.png → ...bsphinx/demos_cardinality_matcher_7_0.png b/...bsphinx/demos_cardinality_matcher_6_0.png → ...bsphinx/demos_cardinality_matcher_7_0.png
diff --git a/...bsphinx/demos_cardinality_matcher_6_1.png → ...bsphinx/demos_cardinality_matcher_7_1.png b/...bsphinx/demos_cardinality_matcher_6_1.png → ...bsphinx/demos_cardinality_matcher_7_1.png
diff --git a/02_demos.html b/02_demos.html
@@ -51,11 +51,7 @@
 <li class="toctree-l1"><a class="reference internal" href="01_installation.html">Installation instructions</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Demos</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="demos/matching_data.html">Matching Data</a></li>
-<li class="toctree-l2"><a class="reference internal" href="demos/balance_calculators.html">Fit Balance Calculator</a></li>
-<li class="toctree-l2"><a class="reference internal" href="demos/balance_calculators.html#Compute-the-balance-between-pool-and-target">Compute the balance between pool and target</a></li>
-<li class="toctree-l2"><a class="reference internal" href="demos/balance_calculators.html#Compute-the-balance-between-subset-of-pool-and-target">Compute the balance between subset of pool and target</a></li>
-<li class="toctree-l2"><a class="reference internal" href="demos/balance_calculators.html#Compute-the-balance-between-several-subsets-simultaneously">Compute the balance between several subsets simultaneously</a></li>
-<li class="toctree-l2"><a class="reference internal" href="demos/balance_calculators.html#Basic-Genetic-Optimizer">Basic Genetic Optimizer</a></li>
+<li class="toctree-l2"><a class="reference internal" href="demos/balance_calculators.html">Balance Calculators</a></li>
 <li class="toctree-l2"><a class="reference internal" href="demos/ps_matcher.html">Propensity Score Matcher</a></li>
 <li class="toctree-l2"><a class="reference internal" href="demos/ea_matcher.html">Genetic Matcher</a></li>
 <li class="toctree-l2"><a class="reference internal" href="demos/lp_matcher.html">Constraint Satisfaction Matcher</a></li>
@@ -107,11 +103,14 @@ <h1>Demos<a class="headerlink" href="#demos" title="Permalink to this heading">
 <li class="toctree-l2"><a class="reference internal" href="demos/matching_data.html#Visualizing-MatchingData">Visualizing MatchingData</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="demos/balance_calculators.html">Fit Balance Calculator</a></li>
-<li class="toctree-l1"><a class="reference internal" href="demos/balance_calculators.html#Compute-the-balance-between-pool-and-target">Compute the balance between pool and target</a></li>
-<li class="toctree-l1"><a class="reference internal" href="demos/balance_calculators.html#Compute-the-balance-between-subset-of-pool-and-target">Compute the balance between subset of pool and target</a></li>
-<li class="toctree-l1"><a class="reference internal" href="demos/balance_calculators.html#Compute-the-balance-between-several-subsets-simultaneously">Compute the balance between several subsets simultaneously</a></li>
-<li class="toctree-l1"><a class="reference internal" href="demos/balance_calculators.html#Basic-Genetic-Optimizer">Basic Genetic Optimizer</a></li>
+<li class="toctree-l1"><a class="reference internal" href="demos/balance_calculators.html">Balance Calculators</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="demos/balance_calculators.html#Fit-Balance-Calculator">Fit Balance Calculator</a></li>
+<li class="toctree-l2"><a class="reference internal" href="demos/balance_calculators.html#Balance-between-pool-and-target">Balance between pool and target</a></li>
+<li class="toctree-l2"><a class="reference internal" href="demos/balance_calculators.html#Balance-between-subset-of-pool-and-target">Balance between subset of pool and target</a></li>
+<li class="toctree-l2"><a class="reference internal" href="demos/balance_calculators.html#Balance-between-several-subsets-simultaneously">Balance between several subsets simultaneously</a></li>
+<li class="toctree-l2"><a class="reference internal" href="demos/balance_calculators.html#Basic-Genetic-Optimizer">Basic Genetic Optimizer</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="demos/ps_matcher.html">Propensity Score Matcher</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="demos/ps_matcher.html#Optimize-Beta-(Mean-Absolute-SMD)">Optimize Beta (Mean Absolute SMD)</a></li>
 </ul>

diff --git a/_images/demos_cardinality_matcher_9_0.png → _images/demos_cardinality_matcher_10_0.png b/_images/demos_cardinality_matcher_9_0.png → _images/demos_cardinality_matcher_10_0.png
diff --git a/_images/demos_cardinality_matcher_9_1.png → _images/demos_cardinality_matcher_10_1.png b/_images/demos_cardinality_matcher_9_1.png → _images/demos_cardinality_matcher_10_1.png
diff --git a/_images/demos_cardinality_matcher_12_0.png → _images/demos_cardinality_matcher_13_0.png b/_images/demos_cardinality_matcher_12_0.png → _images/demos_cardinality_matcher_13_0.png
diff --git a/_images/demos_cardinality_matcher_12_1.png → _images/demos_cardinality_matcher_13_1.png b/_images/demos_cardinality_matcher_12_1.png → _images/demos_cardinality_matcher_13_1.png
diff --git a/_images/demos_cardinality_matcher_6_0.png → _images/demos_cardinality_matcher_7_0.png b/_images/demos_cardinality_matcher_6_0.png → _images/demos_cardinality_matcher_7_0.png
diff --git a/_images/demos_cardinality_matcher_6_1.png → _images/demos_cardinality_matcher_7_1.png b/_images/demos_cardinality_matcher_6_1.png → _images/demos_cardinality_matcher_7_1.png
diff --git a/_sources/demos/balance_calculators.ipynb.txt b/_sources/demos/balance_calculators.ipynb.txt
@@ -1,5 +1,13 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "f21133df-9ed8-4757-8963-6e2176c3128e",
+   "metadata": {},
+   "source": [
+    "# Balance Calculators"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,
@@ -313,7 +321,7 @@
    "id": "3eddef9b-b87d-4a0c-ae51-17d204422be9",
    "metadata": {},
    "source": [
-    "# Fit Balance Calculator"
+    "## Fit Balance Calculator"
    ]
   },
   {
@@ -336,7 +344,7 @@
    "id": "3d588103-f175-43f8-9ab5-38b0a186bb04",
    "metadata": {},
    "source": [
-    "# Compute the balance between pool and target"
+    "## Balance between pool and target"
    ]
   },
   {
@@ -387,7 +395,7 @@
    "id": "ceb3e196-21c8-43ad-83f3-12686008bb27",
    "metadata": {},
    "source": [
-    "# Compute the balance between subset of pool and target"
+    "## Balance between subset of pool and target"
    ]
   },
   {
@@ -438,7 +446,7 @@
    "id": "9cb4fcef-14a0-4344-a28a-601911160219",
    "metadata": {},
    "source": [
-    "# Compute the balance between several subsets simultaneously"
+    "## Balance between several subsets simultaneously"
    ]
   },
   {
@@ -539,7 +547,7 @@
    "id": "63857014-b52b-40d9-8d7b-208c7b981129",
    "metadata": {},
    "source": [
-    "# Basic Genetic Optimizer"
+    "## Basic Genetic Optimizer"
    ]
   },
   {

diff --git a/_sources/demos/cardinality_matcher.ipynb.txt b/_sources/demos/cardinality_matcher.ipynb.txt
@@ -1,5 +1,13 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "5dacbe5f-0aa3-4b43-bfb1-cc58f02a7ded",
+   "metadata": {},
+   "source": [
+    "# Cardinality matching"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,
@@ -263,7 +271,7 @@
    "id": "4e699cd6-9f4c-4493-a261-0a704f288c64",
    "metadata": {},
    "source": [
-    "# Solve for largest subset of pool subject to balance constraint"
+    "## Optimize pool size subject to balance constraint"
    ]
   },
   {
@@ -427,7 +435,7 @@
    "id": "ce715a25-d006-419d-ab1b-c6dfe3e77c29",
    "metadata": {},
    "source": [
-    "# Optimize match among all subsets of a fixed size with balance constraint"
+    "## Optimize balance with balance constraint"
    ]
   },
   {
@@ -548,7 +556,7 @@
    "id": "f6461053-c41c-472a-ad31-57245b690d42",
    "metadata": {},
    "source": [
-    "# Optimize match among all subsets of a fixed size without balance constraint"
+    "## Optimize balance without balance constraint"
    ]
   },
   {

diff --git a/demos/balance_calculators.html b/demos/balance_calculators.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Fit Balance Calculator &mdash; PyBalance</title>
+  <title>Balance Calculators &mdash; PyBalance</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="../_static/nbsphinx-code-cells.css" />
@@ -54,11 +54,14 @@
 <li class="toctree-l1"><a class="reference internal" href="../01_installation.html">Installation instructions</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="../02_demos.html">Demos</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="matching_data.html">Matching Data</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Fit Balance Calculator</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#Compute-the-balance-between-pool-and-target">Compute the balance between pool and target</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#Compute-the-balance-between-subset-of-pool-and-target">Compute the balance between subset of pool and target</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#Compute-the-balance-between-several-subsets-simultaneously">Compute the balance between several subsets simultaneously</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#Basic-Genetic-Optimizer">Basic Genetic Optimizer</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">Balance Calculators</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#Fit-Balance-Calculator">Fit Balance Calculator</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#Balance-between-pool-and-target">Balance between pool and target</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#Balance-between-subset-of-pool-and-target">Balance between subset of pool and target</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#Balance-between-several-subsets-simultaneously">Balance between several subsets simultaneously</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#Basic-Genetic-Optimizer">Basic Genetic Optimizer</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="ps_matcher.html">Propensity Score Matcher</a></li>
 <li class="toctree-l2"><a class="reference internal" href="ea_matcher.html">Genetic Matcher</a></li>
 <li class="toctree-l2"><a class="reference internal" href="lp_matcher.html">Constraint Satisfaction Matcher</a></li>
@@ -90,7 +93,7 @@
   <ul class="wy-breadcrumbs">
       <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
           <li class="breadcrumb-item"><a href="../02_demos.html">Demos</a></li>
-      <li class="breadcrumb-item active">Fit Balance Calculator</li>
+      <li class="breadcrumb-item active">Balance Calculators</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/demos/balance_calculators.ipynb.txt" rel="nofollow"> View page source</a>
       </li>
@@ -100,7 +103,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <div class="nbinput nblast docutils container">
+  <section id="Balance-Calculators">
+<h1>Balance Calculators<a class="headerlink" href="#Balance-Calculators" title="Permalink to this heading"></a></h1>
+<div class="nbinput nblast docutils container">
 <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[1]:
 </pre></div>
 </div>
@@ -385,7 +390,7 @@
 </div></div>
 </div>
 <section id="Fit-Balance-Calculator">
-<h1>Fit Balance Calculator<a class="headerlink" href="#Fit-Balance-Calculator" title="Permalink to this heading"></a></h1>
+<h2>Fit Balance Calculator<a class="headerlink" href="#Fit-Balance-Calculator" title="Permalink to this heading"></a></h2>
 <div class="nbinput nblast docutils container">
 <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[14]:
 </pre></div>
@@ -400,8 +405,8 @@ <h1>Fit Balance Calculator<a class="headerlink" href="#Fit-Balance-Calculator" t
 </div>
 </div>
 </section>
-<section id="Compute-the-balance-between-pool-and-target">
-<h1>Compute the balance between pool and target<a class="headerlink" href="#Compute-the-balance-between-pool-and-target" title="Permalink to this heading"></a></h1>
+<section id="Balance-between-pool-and-target">
+<h2>Balance between pool and target<a class="headerlink" href="#Balance-between-pool-and-target" title="Permalink to this heading"></a></h2>
 <div class="nbinput docutils container">
 <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[15]:
 </pre></div>
@@ -438,8 +443,8 @@ <h1>Compute the balance between pool and target<a class="headerlink" href="#Comp
 </pre></div></div>
 </div>
 </section>
-<section id="Compute-the-balance-between-subset-of-pool-and-target">
-<h1>Compute the balance between subset of pool and target<a class="headerlink" href="#Compute-the-balance-between-subset-of-pool-and-target" title="Permalink to this heading"></a></h1>
+<section id="Balance-between-subset-of-pool-and-target">
+<h2>Balance between subset of pool and target<a class="headerlink" href="#Balance-between-subset-of-pool-and-target" title="Permalink to this heading"></a></h2>
 <div class="nbinput docutils container">
 <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[17]:
 </pre></div>
@@ -476,8 +481,8 @@ <h1>Compute the balance between subset of pool and target<a class="headerlink" h
 </pre></div></div>
 </div>
 </section>
-<section id="Compute-the-balance-between-several-subsets-simultaneously">
-<h1>Compute the balance between several subsets simultaneously<a class="headerlink" href="#Compute-the-balance-between-several-subsets-simultaneously" title="Permalink to this heading"></a></h1>
+<section id="Balance-between-several-subsets-simultaneously">
+<h2>Balance between several subsets simultaneously<a class="headerlink" href="#Balance-between-several-subsets-simultaneously" title="Permalink to this heading"></a></h2>
 <div class="nbinput docutils container">
 <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[19]:
 </pre></div>
@@ -564,7 +569,7 @@ <h1>Compute the balance between several subsets simultaneously<a class="headerli
 </div>
 </section>
 <section id="Basic-Genetic-Optimizer">
-<h1>Basic Genetic Optimizer<a class="headerlink" href="#Basic-Genetic-Optimizer" title="Permalink to this heading"></a></h1>
+<h2>Basic Genetic Optimizer<a class="headerlink" href="#Basic-Genetic-Optimizer" title="Permalink to this heading"></a></h2>
 <p>Here is a very basic, un-optimized implementation of genetic matching! It’s not very smart, because it doesn’t mix the good populations. This is just an illustration of using the balance calculator.</p>
 <div class="nbinput docutils container">
 <div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[27]:
@@ -627,6 +632,7 @@ <h1>Basic Genetic Optimizer<a class="headerlink" href="#Basic-Genetic-Optimizer"
 </pre></div>
 </div>
 </div>
+</section>
 </section>
 
 

diff --git a/demos/balance_calculators.ipynb b/demos/balance_calculators.ipynb
@@ -1,5 +1,13 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "f21133df-9ed8-4757-8963-6e2176c3128e",
+   "metadata": {},
+   "source": [
+    "# Balance Calculators"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,
@@ -313,7 +321,7 @@
    "id": "3eddef9b-b87d-4a0c-ae51-17d204422be9",
    "metadata": {},
    "source": [
-    "# Fit Balance Calculator"
+    "## Fit Balance Calculator"
    ]
   },
   {
@@ -336,7 +344,7 @@
    "id": "3d588103-f175-43f8-9ab5-38b0a186bb04",
    "metadata": {},
    "source": [
-    "# Compute the balance between pool and target"
+    "## Balance between pool and target"
    ]
   },
   {
@@ -387,7 +395,7 @@
    "id": "ceb3e196-21c8-43ad-83f3-12686008bb27",
    "metadata": {},
    "source": [
-    "# Compute the balance between subset of pool and target"
+    "## Balance between subset of pool and target"
    ]
   },
   {
@@ -438,7 +446,7 @@
    "id": "9cb4fcef-14a0-4344-a28a-601911160219",
    "metadata": {},
    "source": [
-    "# Compute the balance between several subsets simultaneously"
+    "## Balance between several subsets simultaneously"
    ]
   },
   {
@@ -539,7 +547,7 @@
    "id": "63857014-b52b-40d9-8d7b-208c7b981129",
    "metadata": {},
    "source": [
-    "# Basic Genetic Optimizer"
+    "## Basic Genetic Optimizer"
    ]
   },
   {