hugiml-core 1.0.0__tar.gz

hugiml_core-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,132 @@
+# Contributing to hugiml-core
+
+Thank you for your interest in contributing to **hugiml-core** — the high-performance
+interpretable rule-based ML infrastructure library built on the
+[HUG-IML IEEE Access paper](https://doi.org/10.1109/ACCESS.2024.3455563).
+
+---
+
+## Before You Start
+
+This project is maintained by **Srikumar Krishnamoorthy** ([@srikumar2050](https://github.com/srikumar2050)).
+All contributions — code, documentation, tests, benchmarks — are welcome and reviewed
+on a best-effort basis.
+
+By submitting a pull request you agree to the terms of the
+[Developer Certificate of Origin (DCO)](https://developercertificate.org/) and that
+your contribution will be licensed under the
+[Apache License 2.0](LICENSE).
+
+---
+
+## Developer Certificate of Origin (DCO)
+
+Every commit must be signed off with:
+
+```
+Signed-off-by: Your Name <your@email.com>
+```
+
+Add `-s` to your `git commit` command, or configure Git globally:
+
+```bash
+git config --global user.name  "Your Name"
+git config --global user.email "your@email.com"
+```
+
+---
+
+## Getting Started
+
+```bash
+# Clone the repository
+git clone https://github.com/srikumar2050/hugiml-core.git
+cd hugiml-core
+
+# Create a virtual environment
+python -m venv .venv && source .venv/bin/activate
+
+# Install in editable mode with all dev extras
+pip install -e ".[dev]"
+
+# Build the C++ extension (requires a C++17 compiler)
+python setup.py build_ext --inplace
+```
+
+---
+
+## Running the Test Suite
+
+```bash
+# Fast unit tests (no native extension required for pure-Python paths)
+pytest tests/ -v -m "not integration and not stress"
+
+# Full suite including real-dataset integration tests
+pytest tests/ -v
+
+# Stress tests (memory, concurrency)
+pytest tests/test_stress.py -v -m stress
+```
+
+Coverage must stay at or above **80%**. Check locally with:
+
+```bash
+pytest --cov=hugiml --cov-report=term-missing tests/
+```
+
+---
+
+## Code Style
+
+```bash
+# Linting
+ruff check src/ tests/ benchmarks/
+
+# Type checking
+mypy src/hugiml/
+
+# Auto-format
+ruff format src/ tests/ benchmarks/
+```
+
+All checks run automatically in CI on every pull request.
+
+---
+
+## Pull Request Guidelines
+
+1. **Fork** the repository and create a branch from `main`.
+2. Write tests that cover your change. All new behaviour should have at least
+   one test.
+3. Keep pull requests focused — one logical change per PR.
+4. Update docstrings and `docs/` if you change public API.
+5. Ensure CI passes before requesting a review.
+6. Do not bump version numbers in PRs; releases are managed by the maintainer.
+
+---
+
+## Reporting Issues
+
+Please open a [GitHub Issue](https://github.com/srikumar2050/hugiml-core/issues)
+and include:
+
+- Python version and OS
+- hugiml-core version (`python -c "import hugiml; print(hugiml.__version__)"`)
+- Minimal reproducible example
+- Full traceback
+
+---
+
+## Security Issues
+
+Do **not** open a public issue for security vulnerabilities.
+Email the maintainer directly (see the GitHub profile) with subject
+`[hugiml-core] Security`.
+
+---
+
+## License
+
+All contributions must be compatible with [Apache 2.0](LICENSE).
+Do not introduce code, data, or dependencies that carry GPL, AGPL,
+LGPL, CC-NC, or similarly restrictive terms.

hugiml_core-1.0.0/LICENSE

@@ -0,0 +1,182 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or otherwise designated in writing by the copyright owner as
+      "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any Contribution
+      embodied within the Work constitutes direct or contributory patent
+      infringement, then any patent licenses granted to You under this License
+      for that Work shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or as an addendum to
+          the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the
+      Contribution.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Liability. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a fee
+      for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may offer such conditions only on
+      Your own behalf and on Your sole responsibility, not on behalf of
+      any other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Srikumar Krishnamoorthy
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

hugiml_core-1.0.0/MANIFEST.in

@@ -0,0 +1,25 @@
+include LICENSE
+include NOTICE
+include README.md
+include CONTRIBUTING.md
+include pyproject.toml
+include setup.py
+
+recursive-include native *.cpp *.hpp
+recursive-include src/hugiml *.py py.typed
+recursive-include tests *.py
+recursive-include benchmarks *.py *.json
+recursive-include docs *.md
+recursive-include docker Dockerfile*
+recursive-include kubernetes *.yaml
+recursive-include scripts *.py *.sh
+
+exclude build/
+exclude dist/
+exclude *.egg-info/
+global-exclude __pycache__/
+global-exclude *.py[cod]
+global-exclude .DS_Store
+global-exclude *.so
+global-exclude *.pyd
+global-exclude *.gch

hugiml_core-1.0.0/NOTICE

@@ -0,0 +1,54 @@
+hugiml-core
+===========
+
+Copyright 2026 Srikumar Krishnamoorthy
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+Scientific Reference
+--------------------
+The algorithms implemented in this package are described in:
+
+  Krishnamoorthy, S. (2024). "Interpretable Classifier Models for Decision
+  Support Using High Utility Gain Patterns." IEEE Access, 12, 126088–126107.
+  DOI: 10.1109/ACCESS.2024.3455563
+
+Third-Party Dependencies
+------------------------
+This software depends on the following third-party packages, each governed
+by its own license:
+
+  numpy         — BSD 3-Clause License
+                  https://numpy.org/
+  scipy         — BSD 3-Clause License
+                  https://scipy.org/
+  scikit-learn  — BSD 3-Clause License
+                  https://scikit-learn.org/
+  pandas        — BSD 3-Clause License
+                  https://pandas.pydata.org/
+  pybind11      — BSD 3-Clause License (build-time only)
+                  https://github.com/pybind/pybind11
+
+Optional integrations (not bundled):
+  opentelemetry-api    — Apache License 2.0
+  prometheus-client    — Apache License 2.0
+  shap                 — MIT License
+
+All of the above licenses are compatible with the Apache License 2.0 under
+which this package is distributed.
+
+Provenance
+----------
+Source repository: https://github.com/srikumar2050/hugiml-core
+Primary maintainer: Srikumar Krishnamoorthy