This repository has been archived by the owner on Dec 21, 2023. It is now read-only.
Prepare for v2.0.0 #25
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Rename `evaluator.py` * Rename elements of `datasets.py` * Rename + refactor `plot.py` Function methods are not good practice as they cannot be tested. * Write test for pairwise Cramer's function * Clean up some loose formatting * Rename elements of `metrics/classification.py` * Rename `metrics/cluster.py` items + drop MSD The single-k clustered MSD function was already so modular that it didn't warrant being kept separate. * Rework correlation metrics In renaming the correlation functions, I identified an easy opportunity to streamline the interface. Now, all correlation MSD metrics are contained within `metrics.correlation.correlation_msd` and the method can be chosen with `method`. This also adds Spearman and Kendall correlation for free (thanks, `pandas`!) * Remove pairwise Cramer's functions from `plot.py` * Fix upper limits for correlation MSD tests * Rename elements of `privacy.py` Also refactor sample generation and write a test for it. * Move feature density difference to its own module * Rename `univariate_distance.py` as `univariate.py` Now that all the metrics in there *are* univariate, we're away. But they certainly are not all distances! * Sweep for remaining feature diff occurrences * Update metric example tests
Unfortunately, grouped items aren't rendered properly by sphinx, so I've just gone through and separated them.
|
Since we're publishing to PyPI, it would be sensible to move to poetry... |
|
Unfortunately, Please excuse the force push; I was hoping to consolidate our setup files since there's a bit of repetition. However, Python 3.6 requires the current configuration and that's the only version available on our data platform. Leaving both of these for now, but something we could pursue in the future... |
* Move literal version number to `__init__.py` To make single-sourcing more straight forward, I've added the `__version__` attribute literal here. I've also written a test for the string's form. * Point `setup.cfg` at `__init__.py` for version * Remove `pyqt5` as dependency * Direct `docs_src/source/conf.py` for version
* Remove and ignore `docs_src/build` * Add example notebook to docs * Add new extensions to conf + expand home page * Render documentation * Comb through README * Rework contribution guidelines * Fix typo in index; render again * Remove core recursive install from dev requirement
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Big changes breaking back-compatibility in #22. Also rendering the docs again and documenting how to do that.