rename + add pypi workflow

Author: stevenstetzler

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,55 @@
+name: Publish Python 🐍 distribution 📦 to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+        fetch-depth: 0 
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mcd-regression 
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/publish-to-test-pypi.yml

@@ -0,0 +1,56 @@
+name: Publish Python 🐍 distribution 📦 to TestPyPI
+
+on: push
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+        fetch-depth: 0 
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/mcd-regression
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/

README.md

@@ -1,24 +1,29 @@
-# robust_linear_regression
+# mcd_regression
 
 Python implementation of robust linear regression in the multiple regression and multivariate regression cases using the minimum covariance determinant (MCD).
 
-Usage ([examples/example.ipynb](examples/example.ipynb)):
+Usage ([https://github.com/stevenstetzler/mcd_regression/tree/main/docs/examples/example.ipynb](docs/examples/example.ipynb)):
 ```python
->>> from robust_linear_regression import RobustLinearRegression
->>> rlr = RobustLinearRegression()
+>>> from mcd_regression import MCDRegression
+>>> mcdr = MCDRegression()
 >>> x = data[:, 0, None] # n x d_x, must be 2D
 >>> y = data[:, 1:] # n x d_y, must be 2D
->>> rlr.fit(x, y)
->>> residuals = y - rlr.predict(x)
->>> slope = rlr.beta
->>> intercept = rlr.alpha
+>>> mcdr.fit(x, y)
+>>> residuals = y - mcdr.predict(x)
+>>> slope = mcdr.beta
+>>> intercept = mcdr.alpha
 ```
 
 Installation:
+- Available via PyPI as `mcd-regression`
+```bash
+$ python -m pip install mcd-regression
+```
+
 - Development
 ```bash
-$ git clone https://github.com/stevenstetzler/robust_linear_regression.git
-$ python -m pip install -e robust_linear_regression
+$ git clone https://github.com/stevenstetzler/mcd_regression.git
+$ python -m pip install -e mcd_regression
 ```
 
 References:

examples/data.txt renamed to docs/examples/data.txt

@@ -1,36 +1,36 @@
-from robust_linear_regression import RobustLinearRegression
+from mcd_regression import MCDRegression
 import numpy as np
-import pathlib
 import os
 import matplotlib.pyplot as plt
 
 def main():
     data = np.loadtxt(os.path.join(os.path.dirname(__file__), "data.txt"))
-    rlr = RobustLinearRegression()
+    mcdr = MCDRegression()
     x = data[:, 0, None]
     y = data[:, 1:]
-    rlr.fit(x, y)
+    mcdr.fit(x, y)
     line_x = np.array([[-0.02], [0.20]])
-    line_y = rlr.predict(line_x)
+    line_y = mcdr.predict(line_x)
     fig, axd = plt.subplot_mosaic([['y1', 'd'], ['y2', 'd']], dpi=150)
     plt.sca(axd["y1"])
-    plt.scatter(x[~rlr.outliers, 0], y[~rlr.outliers, 0], s=2, label="inliers")
-    plt.scatter(x[rlr.outliers, 0], y[rlr.outliers, 0], s=2, label="outliers")
+    plt.scatter(x[~mcdr.outliers, 0], y[~mcdr.outliers, 0], s=2, label="inliers")
+    plt.scatter(x[mcdr.outliers, 0], y[mcdr.outliers, 0], s=2, label="outliers")
     plt.plot(line_x, line_y[:, 0], color="k", zorder=-1, label="line")
     plt.legend()
     plt.xlabel("x")
     plt.ylabel("y_1")
     plt.sca(axd["y2"])
-    plt.scatter(x[~rlr.outliers, 0], y[~rlr.outliers, 1], s=2, label="inliers")
-    plt.scatter(x[rlr.outliers, 0], y[rlr.outliers, 1], s=2, label="outliers")
+    plt.scatter(x[~mcdr.outliers, 0], y[~mcdr.outliers, 1], s=2, label="inliers")
+    plt.scatter(x[mcdr.outliers, 0], y[mcdr.outliers, 1], s=2, label="outliers")
     plt.plot(line_x, line_y[:, 1], color="k", zorder=-1, label="line")
     plt.xlabel("x")
     plt.ylabel("y_2")
     plt.legend()
     plt.sca(axd["d"])
-    plt.scatter(rlr.d_x, rlr.d_r, s=2)
-    plt.axvline(rlr.d_x_threshold, color="k")
-    plt.axhline(rlr.d_r_threshold, color="k")
+    plt.scatter(mcdr.d_x[~mcdr.outliers], mcdr.d_r[~mcdr.outliers], s=2)
+    plt.scatter(mcdr.d_x[mcdr.outliers], mcdr.d_r[mcdr.outliers], s=2)
+    plt.axvline(mcdr.outlier_x_threshold, color="k", ls='--')
+    plt.axhline(mcdr.outlier_r_threshold, color="k", ls='--')
     plt.xlabel("d(x)")
     plt.ylabel("d(r)")
     fig.align_ylabels()

docs/examples/example.ipynb

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools>=80", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mcd-regression"
+license = {file = "LICENSE"}
+readme = "README.md"
+authors = [
+    { name = "Steven Stetzler", email = "[email protected]" }
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "License :: OSI Approved :: MIT License",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+]
+dynamic = ["version"]
+requires-python = ">=3.9"
+dependencies = [
+    "numpy",
+    "scipy",
+    "scikit-learn",
+]
+description = "Robust linear regression in the multiple regression and multivariate regression cases using the minimum covariance determinant (MCD)."
+
+[project.urls]
+"Source Code" = "https://github.com/stevenstetzler/mcd_regression"
+
+[tool.setuptools_scm]
+write_to = "src/mcd_regression/_version.py"
+version_scheme = "guess-next-dev"
+local_scheme = "no-local-version"
+
+[project.optional-dependencies]
+dev = [
+    "matplotlib" # Used for examples
+]