Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Mar 1, 2024
1 parent 307b231 commit ed4bf24
Show file tree
Hide file tree
Showing 26 changed files with 1,264 additions and 1,039 deletions.
Binary file modified _images/MN_geopartition_ensamble.gif
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,347 changes: 619 additions & 728 deletions _images/example_box_pandas.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/gerrymandria_ensamble.gif
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/gerrymandria_region_ensamble.gif
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/gerrymandria_water_and_muni_aware.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/gerrymandria_water_muni_ensamble.gif
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 6 additions & 16 deletions _modules/gerrychain/proposals/tree_proposals.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,6 @@ <h1>Source code for gerrychain.proposals.tree_proposals</h1><div class="highligh
<span class="n">ReselectException</span><span class="p">,</span>
<span class="p">)</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Union</span>
<span class="kn">import</span> <span class="nn">warnings</span>


<div class="viewcode-block" id="MetagraphError"><a class="viewcode-back" href="../../../full_ref.html#gerrychain.proposals.MetagraphError">[docs]</a><span class="k">class</span> <span class="nc">MetagraphError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
Expand All @@ -131,7 +130,7 @@ <h1>Source code for gerrychain.proposals.tree_proposals</h1><div class="highligh
<span class="n">pop_target</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">],</span>
<span class="n">epsilon</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<span class="n">node_repeats</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
<span class="n">weight_dict</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">region_surcharge</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">method</span><span class="p">:</span> <span class="n">Callable</span> <span class="o">=</span> <span class="n">bipartition_tree</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Partition</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
Expand Down Expand Up @@ -173,33 +172,24 @@ <h1>Source code for gerrychain.proposals.tree_proposals</h1><div class="highligh
<span class="sd"> :type epsilon: float</span>
<span class="sd"> :param node_repeats: The number of times to repeat the bipartitioning step. Default is 1.</span>
<span class="sd"> :type node_repeats: int, optional</span>
<span class="sd"> :param weight_dict: The weight dictionary for the graph used for region-aware</span>
<span class="sd"> :param region_surcharge: The surcharge dictionary for the graph used for region-aware</span>
<span class="sd"> partitioning of the grid. Default is None.</span>
<span class="sd"> :type weight_dict: Optional[Dict], optional</span>
<span class="sd"> :type region_surcharge: Optional[Dict], optional</span>
<span class="sd"> :param method: The method used for bipartitioning the tree. Default is</span>
<span class="sd"> :func:`~gerrychain.tree.bipartition_tree`.</span>
<span class="sd"> :type method: Callable, optional</span>

<span class="sd"> :returns: The new partition resulting from the ReCom algorithm.</span>
<span class="sd"> :rtype: Partition</span>

<span class="sd"> :raises ValueWarning: Raised when the sum of the weights in the weight dictionary is</span>
<span class="sd"> greater than 1.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">bad_district_pairs</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="n">n_parts</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">partition</span><span class="p">)</span>
<span class="n">tot_pairs</span> <span class="o">=</span> <span class="n">n_parts</span> <span class="o">*</span> <span class="p">(</span><span class="n">n_parts</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">/</span> <span class="mi">2</span> <span class="c1"># n choose 2</span>

<span class="c1"># Try to add the region aware in if the method accepts the weight dictionary</span>
<span class="k">if</span> <span class="s2">&quot;weight_dict&quot;</span> <span class="ow">in</span> <span class="n">signature</span><span class="p">(</span><span class="n">method</span><span class="p">)</span><span class="o">.</span><span class="n">parameters</span><span class="p">:</span>
<span class="n">method</span> <span class="o">=</span> <span class="n">partial</span><span class="p">(</span><span class="n">method</span><span class="p">,</span> <span class="n">weight_dict</span><span class="o">=</span><span class="n">weight_dict</span><span class="p">)</span>
<span class="k">if</span> <span class="n">weight_dict</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="nb">sum</span><span class="p">(</span><span class="n">weight_dict</span><span class="o">.</span><span class="n">values</span><span class="p">())</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s2">&quot;</span><span class="se">\n</span><span class="s2">The sum of the weights in the weight dictionary is greater than 1.</span><span class="se">\n</span><span class="s2">&quot;</span>
<span class="s2">&quot;Please consider normalizing the weights.&quot;</span><span class="p">,</span>
<span class="n">ValueWarning</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># Try to add the region aware in if the method accepts the surcharge dictionary</span>
<span class="k">if</span> <span class="s2">&quot;region_surcharge&quot;</span> <span class="ow">in</span> <span class="n">signature</span><span class="p">(</span><span class="n">method</span><span class="p">)</span><span class="o">.</span><span class="n">parameters</span><span class="p">:</span>
<span class="n">method</span> <span class="o">=</span> <span class="n">partial</span><span class="p">(</span><span class="n">method</span><span class="p">,</span> <span class="n">region_surcharge</span><span class="o">=</span><span class="n">region_surcharge</span><span class="p">)</span>

<span class="k">while</span> <span class="nb">len</span><span class="p">(</span><span class="n">bad_district_pairs</span><span class="p">)</span> <span class="o">&lt;</span> <span class="n">tot_pairs</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
Expand Down
Loading

0 comments on commit ed4bf24

Please sign in to comment.