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

Implement diversity stats collector (collect_diversity_stats func) #400

Merged
merged 7 commits into from May 27, 2022

Conversation

InnovativeInventor
Copy link
Member

This is a draft PR which adds a collect_diversity_stats() function that reports the diversity of a given chain. I will come back and add docs/tests.

@InnovativeInventor InnovativeInventor changed the title Implement prelim. diversity stats collector Implement prelim. diversity stats collector (collect_diversity_stats) May 26, 2022
@InnovativeInventor InnovativeInventor marked this pull request as ready for review May 26, 2022 22:00
@InnovativeInventor InnovativeInventor changed the title Implement prelim. diversity stats collector (collect_diversity_stats) Implement diversity stats collector (collect_diversity_stats()) May 26, 2022
@InnovativeInventor InnovativeInventor changed the title Implement diversity stats collector (collect_diversity_stats()) Implement diversity stats collector (collect_diversity_stats func) May 26, 2022
@codecov
Copy link

codecov bot commented May 26, 2022

Codecov Report

Merging #400 (3710eed) into main (27cc3cd) will increase coverage by 0.20%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #400      +/-   ##
==========================================
+ Coverage   87.77%   87.97%   +0.20%     
==========================================
  Files          37       39       +2     
  Lines        1742     1772      +30     
==========================================
+ Hits         1529     1559      +30     
  Misses        213      213              
Impacted Files Coverage Δ
gerrychain/meta/__init__.py 100.00% <100.00%> (ø)
gerrychain/meta/diversity.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 27cc3cd...3710eed. Read the comment docs.

@InnovativeInventor
Copy link
Member Author

I just added docs and tests. Should be ready for review now.

Copy link

@chanelrichardson chanelrichardson 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 awesome! I've often wondered about this, given 100,000 steps I feel like it makes more sense to report the unique and accepted plans rather than making it seem like there's definitively 100,000 to report stats on.

@InnovativeInventor InnovativeInventor merged commit b1823d0 into main May 27, 2022
@InnovativeInventor InnovativeInventor deleted the diversity-stats branch May 27, 2022 13:58
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