Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V2.0.0 #121

Merged
merged 47 commits into from
Mar 1, 2024
Merged

V2.0.0 #121

merged 47 commits into from
Mar 1, 2024

Conversation

cdonnay
Copy link
Collaborator

@cdonnay cdonnay commented Feb 29, 2024

Pull request for v2.0.0 of votekit. We break backwards compatibility here, and hence raise the version number.

  1. We implement MCMC sampling for both Bradley-Terry models to allow for sampling with larger numbers of candidates.
  2. We construct two classes of ballot generators; name and slate. We deprecate PL and BT to name_PL and name_BT.
  3. We add a name_Cumulative ballot generator which generates cumulative ballots in the name style.
  4. We generally improve the speed of different ballot generators as well as the ballot class.
  5. We implement a PreferenceInterval class to handle common uses of preference intervals.
  6. We change pref_interval_by_bloc to pref_intervals_by_bloc. This is now a dictionary of dictionaries, where the both sets of keys are the blocs, and the values of the sub-dictionaries are PreferenceInterval objects. The slate models require that we sample from the uncombined PreferenceInterval objects, while the name models require that we combine the PreferenceInterval objects using cohesion parameters.
  7. We change the mds plot functionality to allow users access to the underlying coordinates. This avoids having to recompute each time. We also add a random seed.
  8. We update the documentation.

@cdonnay cdonnay mentioned this pull request Feb 29, 2024
Copy link
Contributor

@peterrrock2 peterrrock2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking pretty good! There were a couple of small things that need some attention, but once those are addressed, I think this will be good to go!

docs/SCR_ballot_generators.md Outdated Show resolved Hide resolved
src/votekit/plots/mds.py Outdated Show resolved Hide resolved
src/votekit/pref_interval.py Outdated Show resolved Hide resolved
src/votekit/ballot_generator.py Outdated Show resolved Hide resolved
src/votekit/ballot_generator.py Outdated Show resolved Hide resolved
src/votekit/ballot_generator.py Outdated Show resolved Hide resolved
Copy link
Contributor

@peterrrock2 peterrrock2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much better! We probably want to think more about plot, but that can come later. Otherwise, things look good to me!

@cdonnay cdonnay merged commit a1c2526 into mggg:main Mar 1, 2024
2 checks passed
@cdonnay cdonnay deleted the v2.0.0 branch March 1, 2024 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants