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

v.0.1.2 - Final merge dev to main #63

Merged
merged 24 commits into from
Jul 11, 2022
Merged

v.0.1.2 - Final merge dev to main #63

merged 24 commits into from
Jul 11, 2022

Conversation

tms-bananaquit
Copy link
Collaborator

@tms-bananaquit tms-bananaquit commented Jul 8, 2022

This pushes the changes for v0.1.2. into main. Changelog will be updated with actual changes from this PR upon release.

tms-bananaquit and others added 23 commits June 9, 2022 09:21
configure and run flake8

Co-authored-by: Thomas Schill <tschill@mitre.org>
* fix typo

* add refs.bib, update citations

Co-authored-by: Thomas Schill <tschill@mitre.org>
Including it didn't speed up the pipeline or squash the complaint from sklearn.
Transferred changes for issue #133 on kdqtree pandas from GL to GH

Co-authored-by: Shashank Jarmale <SJARMALE@MITRE.ORG>
* add simple copy of main yml towards #8

* add environment variable for script tester

* add script tester towards #8

* limit job to example scripts

* use abspath for executing from tests/

* split src / example tests, reorganize test directories

* revert to simpler file refs, edit workflow to cd into correct dir

* fix typo in job trigger

* add notebook tester towards #8

* add venv/kernel steps to allow for nbconvert tests

* fix typo towards !43

* clean up lines to close !43
* move coverage to separate workflow, fail under 100

* revert to 1 combined job for test + cov, fail under 99 (#5)

* remove tmp branch from workflow

* separate lint workflow, add isort

* rework black step, remove isort

* fix black version

* run black, update README towards #44

* add badges to readme

* fix badge section

* Update .github/workflows/tests.yml

* Update README.rst

* Update README.rst

* Update README.rst

* Update README.rst

Co-authored-by: Thomas Schill <33845624+tms-bananaquit@users.noreply.github.com>
* Adds more unit tests for kdqTree

* add validation unit tests

* Add a unit test for KDQTreePartitioner

* add reset to set_reference

* use ref_data variable properly when drift occurs
* updated docs

* closes issue 33

* apply black formatting

Co-authored-by: Thomas Schill <33845624+tms-bananaquit@users.noreply.github.com>
* Started testing out python example notebooks with sphinx

* update conf.py to enable pandoc, move examples around

* Added example notebooks for data drift detectors

* Added example notebooks for modules

* remove extra notebooks, fix plotly plots

Co-authored-by: Shashank Jarmale
Co-authored-by: Shashank Jarmale
Duplicating the examples for the purpose of the documentation got us an older version pulled forward that I didn't catch during review of the PR.
* add tox python version checks towards #2

* Update .gitignore

* fix syntax

* add version notes

* remove older versions from tox

* Update README to include pyenv steps, towards #2

* remove pyenv section

Co-authored-by: Thomas Schill <33845624+tms-bananaquit@users.noreply.github.com>
* add (untested) .python that duplicates make_example_data.R

* add TODO items

* reorganize tools => datasets towards #38

* further reorganize datasets module, add DataGenerator idea

* split DataGenerator idea, and fix bugs in make_example_batch_data

* update any example_data.csv script to now use function

* consolidate dataset descriptions into one README

* debug make_example_data

* delete outdated data files towards #38

* remove TODO comment

* satisfy formatting requirements

* add unit tests and comment out untested code

* comment out missing code, add single-line description towards #38

* minor formatting changes to trigger checks

* debug unit tests, re-satisfy formatting requirements

* update references in docs notebooks, add generator docstring
 also fixes some whitespace in cdbd.py

Co-authored-by: Thomas Schill <33845624+tms-bananaquit@users.noreply.github.com>
* separate into streaming and batch detector ABCs (#46)

* split kdqtree into streaming/batch versions, update tests

* finish batch version of kdqtree

* begin using multiple inheritance scheme for kdqtree detectors (#46)

* establish commonly inherited functionality in new KdqTreeDetector class

* establish commonly inherited functionality in new KdqTree detector class (#46)

* deconstruct update to enable code reuse in KdqTreeDetector (#46)

* debug all failing tests in test_kdqtree (#46)

* update __init__, update refs in examples (#46)

* update outdated data refs

* add any missing docstrings (#46)

* format with black

* add unit test for new ABC drift setters

* updated the data_drift_examples notebook

* docstring formatting tweaks

* fix typo

Co-authored-by: Thomas Schill <33845624+tms-bananaquit@users.noreply.github.com>

* fix formatting in docstring

Co-authored-by: Thomas Schill <33845624+tms-bananaquit@users.noreply.github.com>

* fix formatting in docstring

Co-authored-by: Thomas Schill <33845624+tms-bananaquit@users.noreply.github.com>

* fix typo

Co-authored-by: Thomas Schill <33845624+tms-bananaquit@users.noreply.github.com>

* fix description in docstring

Co-authored-by: Thomas Schill <33845624+tms-bananaquit@users.noreply.github.com>

* formatting

* remove double-documented attributes from docstring

* provide useful information in child docstrings

* move _drift_counter into KdqTreeStreaming

* delete coverage file

* toss ref data once processed

* format with black

Co-authored-by: Thomas Schill <33845624+tms-bananaquit@users.noreply.github.com>
* switch to README.md for better rendering on github
 - removes reference links from table
 - adds placeholder mermaid flow diagram
 - makes some tweaks to the README text

* update requirements in setup.cfg

* test mermaid rendering

* Add "Choosing a Detector" page to TOC

* tweak README text

* add RTD hyperlink

* Merge with current dev

* remove draft flow diagram
* add CHANGELOG, yaml

* add Action to push to pypi upon published release

* change name of workflow

* test adding security linter

* test bandit linting

* comments

* alphabetize setup.cfg.test

* increment version number

* change lint badge name
@tms-bananaquit tms-bananaquit marked this pull request as ready for review July 8, 2022 18:16
Copy link
Contributor

@Anmol-Srivastava Anmol-Srivastava left a comment

Choose a reason for hiding this comment

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

A couple of non-urgent minor comments. I guess we may need to take one final look after #65 is merged.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@tms-bananaquit tms-bananaquit merged commit 8bdac6d into main Jul 11, 2022
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

4 participants