samesame 0.1.0__tar.gz

samesame-0.1.0/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

samesame-0.1.0/PKG-INFO

@@ -0,0 +1,289 @@
+Metadata-Version: 2.3
+Name: samesame
+Version: 0.1.0
+Summary: Classifier two-sample tests and noninferiority tests.
+Keywords: drift detection,data monitoring,dataset shift,data validation,model validation,noninferiority tests,statistical tests
+Author: Vathy M. Kamulete
+Author-email: Vathy M. Kamulete <vathymut@gmail.com>
+License:                    GNU LESSER GENERAL PUBLIC LICENSE
+                                Version 3, 29 June 2007
+         
+          Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+          Everyone is permitted to copy and distribute verbatim copies
+          of this license document, but changing it is not allowed.
+         
+         
+           This version of the GNU Lesser General Public License incorporates
+         the terms and conditions of version 3 of the GNU General Public
+         License, supplemented by the additional permissions listed below.
+         
+           0. Additional Definitions.
+         
+           As used herein, "this License" refers to version 3 of the GNU Lesser
+         General Public License, and the "GNU GPL" refers to version 3 of the GNU
+         General Public License.
+         
+           "The Library" refers to a covered work governed by this License,
+         other than an Application or a Combined Work as defined below.
+         
+           An "Application" is any work that makes use of an interface provided
+         by the Library, but which is not otherwise based on the Library.
+         Defining a subclass of a class defined by the Library is deemed a mode
+         of using an interface provided by the Library.
+         
+           A "Combined Work" is a work produced by combining or linking an
+         Application with the Library.  The particular version of the Library
+         with which the Combined Work was made is also called the "Linked
+         Version".
+         
+           The "Minimal Corresponding Source" for a Combined Work means the
+         Corresponding Source for the Combined Work, excluding any source code
+         for portions of the Combined Work that, considered in isolation, are
+         based on the Application, and not on the Linked Version.
+         
+           The "Corresponding Application Code" for a Combined Work means the
+         object code and/or source code for the Application, including any data
+         and utility programs needed for reproducing the Combined Work from the
+         Application, but excluding the System Libraries of the Combined Work.
+         
+           1. Exception to Section 3 of the GNU GPL.
+         
+           You may convey a covered work under sections 3 and 4 of this License
+         without being bound by section 3 of the GNU GPL.
+         
+           2. Conveying Modified Versions.
+         
+           If you modify a copy of the Library, and, in your modifications, a
+         facility refers to a function or data to be supplied by an Application
+         that uses the facility (other than as an argument passed when the
+         facility is invoked), then you may convey a copy of the modified
+         version:
+         
+            a) under this License, provided that you make a good faith effort to
+            ensure that, in the event an Application does not supply the
+            function or data, the facility still operates, and performs
+            whatever part of its purpose remains meaningful, or
+         
+            b) under the GNU GPL, with none of the additional permissions of
+            this License applicable to that copy.
+         
+           3. Object Code Incorporating Material from Library Header Files.
+         
+           The object code form of an Application may incorporate material from
+         a header file that is part of the Library.  You may convey such object
+         code under terms of your choice, provided that, if the incorporated
+         material is not limited to numerical parameters, data structure
+         layouts and accessors, or small macros, inline functions and templates
+         (ten or fewer lines in length), you do both of the following:
+         
+            a) Give prominent notice with each copy of the object code that the
+            Library is used in it and that the Library and its use are
+            covered by this License.
+         
+            b) Accompany the object code with a copy of the GNU GPL and this license
+            document.
+         
+           4. Combined Works.
+         
+           You may convey a Combined Work under terms of your choice that,
+         taken together, effectively do not restrict modification of the
+         portions of the Library contained in the Combined Work and reverse
+         engineering for debugging such modifications, if you also do each of
+         the following:
+         
+            a) Give prominent notice with each copy of the Combined Work that
+            the Library is used in it and that the Library and its use are
+            covered by this License.
+         
+            b) Accompany the Combined Work with a copy of the GNU GPL and this license
+            document.
+         
+            c) For a Combined Work that displays copyright notices during
+            execution, include the copyright notice for the Library among
+            these notices, as well as a reference directing the user to the
+            copies of the GNU GPL and this license document.
+         
+            d) Do one of the following:
+         
+                0) Convey the Minimal Corresponding Source under the terms of this
+                License, and the Corresponding Application Code in a form
+                suitable for, and under terms that permit, the user to
+                recombine or relink the Application with a modified version of
+                the Linked Version to produce a modified Combined Work, in the
+                manner specified by section 6 of the GNU GPL for conveying
+                Corresponding Source.
+         
+                1) Use a suitable shared library mechanism for linking with the
+                Library.  A suitable mechanism is one that (a) uses at run time
+                a copy of the Library already present on the user's computer
+                system, and (b) will operate properly with a modified version
+                of the Library that is interface-compatible with the Linked
+                Version.
+         
+            e) Provide Installation Information, but only if you would otherwise
+            be required to provide such information under section 6 of the
+            GNU GPL, and only to the extent that such information is
+            necessary to install and execute a modified version of the
+            Combined Work produced by recombining or relinking the
+            Application with a modified version of the Linked Version. (If
+            you use option 4d0, the Installation Information must accompany
+            the Minimal Corresponding Source and Corresponding Application
+            Code. If you use option 4d1, you must provide the Installation
+            Information in the manner specified by section 6 of the GNU GPL
+            for conveying Corresponding Source.)
+         
+           5. Combined Libraries.
+         
+           You may place library facilities that are a work based on the
+         Library side by side in a single library together with other library
+         facilities that are not Applications and are not covered by this
+         License, and convey such a combined library under terms of your
+         choice, if you do both of the following:
+         
+            a) Accompany the combined library with a copy of the same work based
+            on the Library, uncombined with any other library facilities,
+            conveyed under the terms of this License.
+         
+            b) Give prominent notice with the combined library that part of it
+            is a work based on the Library, and explaining where to find the
+            accompanying uncombined form of the same work.
+         
+           6. Revised Versions of the GNU Lesser General Public License.
+         
+           The Free Software Foundation may publish revised and/or new versions
+         of the GNU Lesser General Public License from time to time. Such new
+         versions will be similar in spirit to the present version, but may
+         differ in detail to address new problems or concerns.
+         
+           Each version is given a distinguishing version number. If the
+         Library as you received it specifies that a certain numbered version
+         of the GNU Lesser General Public License "or any later version"
+         applies to it, you have the option of following the terms and
+         conditions either of that published version or of any later version
+         published by the Free Software Foundation. If the Library as you
+         received it does not specify a version number of the GNU Lesser
+         General Public License, you may choose any version of the GNU Lesser
+         General Public License ever published by the Free Software Foundation.
+         
+           If the Library as you received it specifies that a proxy can decide
+         whether future versions of the GNU Lesser General Public License shall
+         apply, that proxy's public statement of acceptance of any version is
+         permanent authorization for you to choose that version for the
+         Library.
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Operating System :: OS Independent
+Requires-Dist: numpy>=1.21
+Requires-Dist: scipy>=1.15
+Requires-Dist: scikit-learn
+Requires-Dist: samesame[docs,test] ; extra == 'dev'
+Requires-Dist: mkdocs-material ; extra == 'docs'
+Requires-Dist: mkdocstrings-python ; extra == 'docs'
+Requires-Dist: numpydoc ; extra == 'docs'
+Requires-Dist: jupyter ; extra == 'docs'
+Requires-Dist: uv ; extra == 'test'
+Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: pytest-cov ; extra == 'test'
+Requires-Dist: ruff ; extra == 'test'
+Maintainer: Vathy M. Kamulete
+Maintainer-email: Vathy M. Kamulete <vathymut@gmail.com>
+Requires-Python: >=3.12
+Provides-Extra: dev
+Provides-Extra: docs
+Provides-Extra: test
+Description-Content-Type: text/markdown
+
+<!-- markdownlint-disable MD041 -->
+<!-- markdownlint-disable MD033 -->
+<!-- Add to badges above once on PyPI
+    [![ReadTheDocs](https://readthedocs.org/projects/samesame/badge/?version=latest)](https://samesame.readthedocs.io/en/stable/)
+    [![PyPI-Server](https://img.shields.io/pypi/v/samesame.svg)](https://pypi.org/project/samesame/)
+    [![Monthly Downloads](https://pepy.tech/badge/samesame/month)](https://pepy.tech/project/samesame)
+-->
+
+# samesame
+
+<!-- badges: start -->
+[![Python](https://img.shields.io/badge/python-3.12+-blue.svg)](https://pypi.org/project/samesame/)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![License: LGPLv3](https://img.shields.io/badge/License-LGPL--3.0-green.svg)](https://opensource.org/license/lgpl-3-0)
+[![arXiv](https://img.shields.io/badge/arXiv-2107.02990-b31b1b.svg)](https://arxiv.org/abs/2107.02990) 
+
+<!-- badges: end -->
+
+> Same, same but different ...
+
+`samesame` implements classifier two-sample tests (CTSTs) and as a bonus 
+extension, a noninferiority test (NIT). 
+
+These were either missing or implemented with some tradeoffs 
+(looking at you, sample-splitting) in existing libraries. And so, 
+`samesame` fills in the gaps :)
+
+## Motivation
+
+What is `samesame` good for? It is for data (model) validation, performance
+monitoring, drift detection (dataset shift), statistical process control, and
+on and on. 
+
+Want more? 
+[Here you go](https://vathymut.github.io/dsos/articles/motivation.html).
+This motivating example comes from the related R package 
+[`dsos`](https://github.com/vathymut/dsos).
+
+## Installation
+
+To install, run the following command:
+
+```bash
+python -m pip install samesame
+```
+
+## Usage
+
+### Functionality
+
+Below, you will find an overview of common modules in `samesame`. 
+
+| Function                                  | Module           |
+|-------------------------------------------|------------------|
+| Bayesian inference                        | `samesame.bayes` |
+| Classifier two-sample tests (CTSTs)       | `samesame.ctst`  |
+| Noninferiority tests (NITs)               | `samesame.nit`   |
+
+
+### Attributes
+
+When the method is a statistical test, `samesame` saves (stores) the results of
+some potentially computationally intensive results in attributes. These
+attributes, when available, can be accessed as follows. 
+
+| Attribute      | Description                                   |
+|----------------|-----------------------------------------------|
+| `.statistic`   | The test statistic for the hypothesis.        |
+| `.null`        | The null distribution for the hypothesis.     |
+| `.pvalue`      | The p-value for the hypothesis.               |
+| `.posterior`   | The posterior distribution for the hypothesis.|
+| `.bayes_factor`| The bayes factor for the hypothesis.          |
+
+## Examples
+
+To get started, please see the documentation and examples.
+
+## Dependencies
+
+`samesame` has few dependencies beyond the standard library. It will 
+probably work with some older Python versions. It is, in short, a lightweight
+dependency for most machine learning projects.`samesame` is built on top of,
+and is compatible with, [scikit-learn][scikit-learn] and [numpy][numpy].
+
+[numpy]: https://numpy.org/
+[PyPI]: https://pypi.org/project/samesame
+[scikit-learn]: https://scikit-learn.org/stable

samesame-0.1.0/README.md

@@ -0,0 +1,88 @@
+<!-- markdownlint-disable MD041 -->
+<!-- markdownlint-disable MD033 -->
+<!-- Add to badges above once on PyPI
+    [![ReadTheDocs](https://readthedocs.org/projects/samesame/badge/?version=latest)](https://samesame.readthedocs.io/en/stable/)
+    [![PyPI-Server](https://img.shields.io/pypi/v/samesame.svg)](https://pypi.org/project/samesame/)
+    [![Monthly Downloads](https://pepy.tech/badge/samesame/month)](https://pepy.tech/project/samesame)
+-->
+
+# samesame
+
+<!-- badges: start -->
+[![Python](https://img.shields.io/badge/python-3.12+-blue.svg)](https://pypi.org/project/samesame/)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![License: LGPLv3](https://img.shields.io/badge/License-LGPL--3.0-green.svg)](https://opensource.org/license/lgpl-3-0)
+[![arXiv](https://img.shields.io/badge/arXiv-2107.02990-b31b1b.svg)](https://arxiv.org/abs/2107.02990) 
+
+<!-- badges: end -->
+
+> Same, same but different ...
+
+`samesame` implements classifier two-sample tests (CTSTs) and as a bonus 
+extension, a noninferiority test (NIT). 
+
+These were either missing or implemented with some tradeoffs 
+(looking at you, sample-splitting) in existing libraries. And so, 
+`samesame` fills in the gaps :)
+
+## Motivation
+
+What is `samesame` good for? It is for data (model) validation, performance
+monitoring, drift detection (dataset shift), statistical process control, and
+on and on. 
+
+Want more? 
+[Here you go](https://vathymut.github.io/dsos/articles/motivation.html).
+This motivating example comes from the related R package 
+[`dsos`](https://github.com/vathymut/dsos).
+
+## Installation
+
+To install, run the following command:
+
+```bash
+python -m pip install samesame
+```
+
+## Usage
+
+### Functionality
+
+Below, you will find an overview of common modules in `samesame`. 
+
+| Function                                  | Module           |
+|-------------------------------------------|------------------|
+| Bayesian inference                        | `samesame.bayes` |
+| Classifier two-sample tests (CTSTs)       | `samesame.ctst`  |
+| Noninferiority tests (NITs)               | `samesame.nit`   |
+
+
+### Attributes
+
+When the method is a statistical test, `samesame` saves (stores) the results of
+some potentially computationally intensive results in attributes. These
+attributes, when available, can be accessed as follows. 
+
+| Attribute      | Description                                   |
+|----------------|-----------------------------------------------|
+| `.statistic`   | The test statistic for the hypothesis.        |
+| `.null`        | The null distribution for the hypothesis.     |
+| `.pvalue`      | The p-value for the hypothesis.               |
+| `.posterior`   | The posterior distribution for the hypothesis.|
+| `.bayes_factor`| The bayes factor for the hypothesis.          |
+
+## Examples
+
+To get started, please see the documentation and examples.
+
+## Dependencies
+
+`samesame` has few dependencies beyond the standard library. It will 
+probably work with some older Python versions. It is, in short, a lightweight
+dependency for most machine learning projects.`samesame` is built on top of,
+and is compatible with, [scikit-learn][scikit-learn] and [numpy][numpy].
+
+[numpy]: https://numpy.org/
+[PyPI]: https://pypi.org/project/samesame
+[scikit-learn]: https://scikit-learn.org/stable

samesame-0.1.0/pyproject.toml

@@ -0,0 +1,70 @@
+[project]
+name = "samesame"
+version = "0.1.0"
+description = "Classifier two-sample tests and noninferiority tests."
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = ["numpy >= 1.21", "scipy >= 1.15", "scikit-learn"]
+authors = [{ name = "Vathy M. Kamulete", email = "vathymut@gmail.com" }]
+maintainers = [{ name = "Vathy M. Kamulete", email = "vathymut@gmail.com" }]
+license = { file = "LICENSE.txt" }
+keywords = [
+  "drift detection",
+  "data monitoring",
+  "dataset shift",
+  "data validation",
+  "model validation",
+  "noninferiority tests",
+  "statistical tests",
+]
+classifiers = [
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed",
+  "Topic :: Scientific/Engineering",
+  "Topic :: Scientific/Engineering :: Artificial Intelligence",
+  "Intended Audience :: Science/Research",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
+  "Operating System :: OS Independent",
+]
+
+[build-system]
+requires = ["uv_build>=0.8.11,<0.9.0"]
+build-backend = "uv_build"
+
+
+[project.optional-dependencies]
+dev = ["samesame[docs,test]"]
+test = ["uv", "pytest", "pytest-cov", "ruff"]
+docs = ["mkdocs-material", "mkdocstrings-python", "numpydoc", "jupyter"]
+
+[tool.pytest.ini_options]
+addopts = "--cov samesame --cov-report term-missing --verbose --doctest-modules --doctest-continue-on-failure"
+testpaths = ["tests"]
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.numpydoc_validation]
+checks = [
+  "all",  # report on all checks, except the below
+  "EX01",
+  "SA01",
+  "ES01",
+]
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+extend-select = [
+  "UP", # pyupgrade
+  "I",  # sort imports
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"

samesame-0.1.0/src/samesame/__init__.py

@@ -0,0 +1,18 @@
+# Copyright (c) 2025-present, Royal Bank of Canada.
+# All rights reserved.
+#
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+from . import (
+    bayes,
+    ctst,
+    nit,
+)
+
+__all__ = [
+    "bayes",
+    "ctst",
+    "nit",
+]