Closed peterrrock2 closed 10 months ago
Attention: 39 lines
in your changes are missing coverage. Please review.
Comparison is base (
627e6c6
) 88.88% compared to head (ea56d4e
) 91.88%.
Codecov Report
Attention:
39 lines
in your changes are missing coverage. Please review.Comparison is base (
627e6c6
) 88.88% compared to head (06350dd
) 91.88%.❗ Current head 06350dd differs from pull request most recent head 000fbfb. Consider uploading reports for the commit 000fbfb to get more accurate results
Additional details and impacted files
Ignore this. The code coverage has gone up compared to base and several tests were added for this release
This should be the main PR for v0.3.0. Below is a summary of the proposed release notes:
What's Changed
Major updates have been made to all of the documentation to try to make it
(i) More complete (ii) More accessible for new Python users
Bipartition Tree now has max_attempts default set to 100000 to prevent infinite loop conditions, but this value should also give plenty of time to sample sufficiently from the set of spanning trees.
The
recom
method now has functionality for running region-aware chains which allow for the construction of ensembles of districting plans that try not to split a particular region or set of regionstally_region_splits
has been added to make quick tallying of the number of splits of a region type easyMany of the issue tickets have been resolved. See below for more info.
Deprecations
Resolved Issues
#412 Resolved due to deprecation of conda-forge
#409 Related to the following issue:
#408 Resolved with deprecation of the conda-forge
#364: The global random seed is no longer set in a custom random file. The user must now set the seed manually if they wish for their work to be reproducible.
#319 is now fixed for recom. In
bipartition_tree
the user may now specify the parameterallow_pair_reslection
as true or false. The default is false to maintain backwards compatibility, but in the case where this parameter is set to true, an error is propagated back up torecom
and a new pair is selected there. The selection of the new pair does not advance the chain. See the documentation for more information.#294 This is now a part of the "Good Data Practices" section of the documentation
#288
__repr__
methods have been added across the packageconstraints
for theis_valid
property that allows for the printing and editing of constraints. For example. one may print the constraints with the callprint(chain.constraints)
which will print something like[<function single_flip_contiguous at 0x7f3d80f45b20>]
, and the constraints can be set with something likechain.constraints = [contiguous]
. When set, the constraints are checked against the initial state of the chain. This improves the UX by making it so that you do not need to reinitialize a full MarkovChain object to experiment with different constraints.#279 This has been partially addressed in the documentation update and the remaining reference materials for how to plot data is left to the documentation of matplotlib and seaborn
#44 This is now a part of the documentation.