DNIKit 2.0.0 Release.

Co-Authored-By: David Koski <[email protected]>
Co-Authored-By: Miguel Sarabia  <[email protected]>
Co-Authored-By: Niv Sivakumar <[email protected]>
Co-Authored-By: Ian Arawjo <[email protected]>
Co-Authored-By: Aparna Joshi <[email protected]>
Co-Authored-By: Moussa Doumbouya <[email protected]>
Co-Authored-By: Xavier Suau <[email protected]>
Co-Authored-By: Luca Zappella <[email protected]>
Co-Authored-By: Nicholas Apostoloff <[email protected]>

.bumpversion.cfg

@@ -0,0 +1,16 @@
+[bumpversion]
+current_version = 2.0.0
+commit = False
+tag = False
+
+[bumpversion:file:src/dnikit/pyproject.toml]
+
+[bumpversion:file:src/dnikit_tensorflow/pyproject.toml]
+
+[bumpversion:file:src/dnikit_torch/pyproject.toml]
+
+[bumpversion:file:src/dnikit/dnikit/__init__.py]
+
+[bumpversion:file:src/dnikit_tensorflow/dnikit_tensorflow/__init__.py]
+
+[bumpversion:file:src/dnikit_torch/dnikit_torch/__init__.py]

.gitattributes

@@ -0,0 +1,4 @@
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text

.github/ISSUE_TEMPLATE/bug_template.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help fix issues and improve the code.
+title: ''
+labels: 'bug'
+assignees: ''
+---
+# Bug Report
+If this is something you can debug and fix? Send a pull request. Bug fixes, documentation fixes, and other contributions are welcome.
+Please use the other issue template for a [**Feature Request**](https://github.com/apple/dnikit/issues/new?assignees=&labels=&template=feature_request_template.md&title=).
+**One sentence summary of PR:**
+
+## Checklist
+( Replace '[ ]' with '[x]' if completed. )
+
+    - [ ] I've checked [the issues list](https://github.com/apple/dnikit/issues) to make sure a bug for this is not already filed.
+    - [ ] I've updated to the latest version of DNIKit.
+    - [ ] I've searched the [documentation](https://apple.github.io/dnikit/index.html), if appropriate, and found no answer.
+
+## Description
+
+### Expected Behavior
+What were you trying to do and what did you expect to happen?
+
+### Current Behavior
+Please describe what happened and include any failure information you think would be useful (stacktrace, logs, etc.).
+
+### Possible Solution, if applicable
+This would be the place for related issues, suggestions, links for context, etc.
+
+### Environment Setup
+- **Python Version**:
+- **MacOS or Linux**:
+- For general users - **Version of DNIKit**:
+- For developers - **Branch of DNIKit / commit ID (if not latest commit)**:
+- **DNIKit Virtualenv? (Yes/No)**:
+- **Additional dependencies (attach your pip freeze)**:

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,45 @@
+
+Thank you for your interest in contributing to DNIKit! Please review [CONTRIBUTING.md](../CONTRIBUTING.md) first. If you would like to proceed with making a pull request, please indicate your agreement to the terms outlined in CONTRIBUTING.md by checking the box below. If not, please go ahead and fork this repository and make your updates.
+
+We appreciate your interest in the project!
+
+Do not erase the below when submitting your pull request:
+
+- [ ] I agree to the terms outlined in CONTRIBUTING.md
+
+---------------------------------------------
+
+**One sentence summary of PR:**
+
+## Checklist
+( Replace '[ ]' with '[x]' if completed. )
+
+- [ ] I've searched through existing [Pull Requests](https://github.com/apple/dnikit/pulls) and can confirm my PR has not been previously submitted.
+- [ ] I've written new tests for my core changes, as applicable.
+- [ ] I've tested these changes locally (see [Contributor's Guide](https://apple.github.io/dnikit/dev/contributing.html)).
+- [ ] I've updated [CHANGELOG.md](https://github.com/apple/dnikit/blob/main/CHANGELOG.md) and added [documentation](https://github.com/apple/dnikit/tree/main/docs) for major new features.
+- [ ] My PR is of reasonable size for someone to review. (You may be asked to break it up into smaller pieces if it is not.)
+
+***If you did not check one of these boxes, please explain why:***
+
+
+## Description
+
+Please provide enough information so that others can review your pull request.
+
+### What existing problem does this PR aim to solve?
+
+Please replace this line with a description of the previous behavior, why it is an issue, and any other relevant context. You can reference any Github Issues if that will answer this question.
+
+### New Behavior
+
+Please replace this line with a description of what your changes do and why they should be included.
+
+### Type
+Choose what is applicable, delete the others.
+Bug fix (non-breaking change which fixes an issue)
+New feature (non-breaking change which adds functionality)
+Breaking change (fix or feature that would cause existing functionality to change)
+
+### Priority
+Choose high, medium, or low priority and why. (Ex: High priority, blocks X completely.)

.gitignore

@@ -0,0 +1,140 @@
+# macOS
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage*
+coverage*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/**/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+**/notebooks/**/.saved_models
+**/notebooks/.verify
+
+# Dataset Report Notebook:
+docs/notebooks/data_introspection/*
+!docs/notebooks/data_introspection/*.ipynb
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env*
+.venv*
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+
+# pycharm
+.idea
+
+# unit test junit xml reports
+junit*.xml
+
+# DNIKit code coverage reports
+coverage_*
+
+# temp files
+*~
+
+
+# emacs temp files
+\#*\#
+.\#*
+
+#vs code dir
+.vscode/

CHANGELOG.md

@@ -0,0 +1,39 @@
+DNIKit Open Source Changelog
+============================
+
+Version 2.0.0 (2023-08-03)
+--------------------------
+- We're excited to announce DNIKit 2.0.0! Please see our API docs for more information about DNIKit and its components.
+
+Prior releases (Private)
+------------------------
+Note: The versions of DNIKit below are not publicly available,
+but we include a list of each private release for transparency.
+
+- Version 1.7.0 (2023-04-25)
+- Version 1.6.0 (2022-07-12)
+- Version 1.5.3 (2022-04-11)
+- Version 1.5.2 (2022-03-10)
+- Version 1.5.1 (2021-12-17)
+- Version 1.5.0 (2021-11-05)
+  - Addition of PyTorch components (``dnikit_torch``)
+- Version 1.4.0 (2021-08-23)
+  - Introduction of DatasetReport and Duplicates introspectors
+- Version 1.3.0 (2021-06-03)
+- Version 1.2.0 (2021-03-11)
+- Version 1.1.0 (2021-01-26)
+- Version 1.0.1 (2020-11-10)
+- Version 1.0.0 (2020-10-23)
+  - Refactor of API, documentation, examples, and build system
+- Version 1.0.0rc1 (2020-06-29)
+- Version 1.0.0b9 (2020-13-05)
+- Version 1.0.0b8 (2020-19-02)
+- Version 1.0.0b7 (2020-30-01)
+- Version 1.0.0b6 (2019-10-23)
+- Version 1.0.0b4 (2019-04-11)
+- Version 1.0.0b3 (2019-04-09)
+- Version 0.3.2 (2018-05-22)
+- Version 0.3.1 (2018-03-28)
+- Version 0.3.0 (2018-03-16)
+- Version 0.2.1 (2018-03-14)
+  - First DNIKit version with PFA, IUA, DimensionReduction, and TensorFlow components

CITATION.cff

@@ -0,0 +1,27 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Welsh"
+  given-names: "Megan Maher"
+- family-names: "Koski"
+  given-names: "David"
+- family-names: "Sarabia"
+  given-names: "Miguel"
+- family-names: "Sivakumar"
+  given-names: "Niv"
+- family-names: "Arawjo"
+  given-names: "Ian"
+- family-names: "Joshi"
+  given-names: "Aparna"
+- family-names: "Doumbouya"
+  given-names: "Moussa"
+- family-names: "Suau"
+  given-names: "Xavier"
+- family-names: "Zappella"
+  given-names: "Luca"
+- family-names: "Apostoloff"
+  given-names: "Nicholas"
+title: "Data and Network Introspection Kit"
+version: 2.0.0
+date-released: 2023-06-19
+url: "https://github.com/apple/dnikit"

CODEOWNERS

@@ -0,0 +1,7 @@
+# Users listed will be automatically added as reviewers for PRs touch their files
+# Order is important. The last matching pattern has the most precedence.
+# You can also use email addresses instead of github names.
+
+
+# Default owners for everything in the repo
+*       @mmaherwelsh @davidkoski

CODE_OF_CONDUCT.md

@@ -0,0 +1,71 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the open source team at [[email protected]](mailto:[email protected]). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
+available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)