ranknexus 0.1.0__tar.gz

ranknexus-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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, whether in Source or
+      Object form, 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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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 individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated 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 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 a Contribution incorporated 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, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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 copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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 redistributing 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 consequential 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 any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional 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 act 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 such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Gaurav Aggarwal
+
+   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.

ranknexus-0.1.0/PKG-INFO

@@ -0,0 +1,317 @@
+Metadata-Version: 2.4
+Name: ranknexus
+Version: 0.1.0
+Summary: A lightweight, framework-agnostic library for fusing multiple search rankings in search and RAG systems.
+Author: Gaurav Aggarwal
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/GauravAgga/Riffusion
+Project-URL: Repository, https://github.com/GauravAgga/Riffusion
+Project-URL: Issues, https://github.com/GauravAgga/Riffusion/issues
+Keywords: search,rag,rrf,rank-fusion,hybrid-search,retrieval
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Dynamic: license-file
+
+# RankNexus
+
+A lightweight, framework-agnostic library for fusing multiple search rankings into a single, better-ranked result list — built for modern hybrid search and RAG systems.
+
+> **Note:** This project is **not** related to the [Riffusion music-generation AI](https://github.com/riffusion/riffusion-hobby). The PyPI package is published as `ranknexus` to avoid naming conflicts.
+
+![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)
+![Python](https://img.shields.io/badge/Python-3.10%2B-blue.svg)
+
+## Why RankNexus?
+
+Hybrid retrieval pipelines often combine multiple retrievers — for example, BM25 keyword search and dense vector search. Each retriever returns scores on incompatible scales, making direct score combination unreliable.
+
+**Reciprocal Rank Fusion (RRF)** solves this by using only rank positions, not raw scores. For each document `d` that appears in one or more ranked lists:
+
+```
+RRF(d) = Σ  1 / (k + rank_i(d))
+```
+
+Documents that rank highly across multiple retrievers rise to the top. No score normalization required.
+
+**Weighted RRF** keeps the same rank-based approach but applies a per-ranking weight:
+
+```
+WRRF(d) = Σ  w_i / (k + rank_i(d))
+```
+
+When scores *are* meaningful, **Weighted Score Fusion** combines (optionally min-max normalized) scores with per-ranking weights:
+
+```
+WSF(d) = Σ  w_i · s'_i(d)
+```
+
+
+
+## Features
+
+- **RRF fusion** — merge rankings from heterogeneous retrievers using rank positions only
+- **Weighted RRF** — same rank-based fusion with required per-list weights
+- **Weighted score fusion** — combine retriever scores with per-list weights and optional min-max normalization
+- **Framework-agnostic** — works with dict payloads from Elasticsearch, OpenSearch, pgvector, LangChain, LlamaIndex, or any custom retriever
+- **Flexible document IDs** — use a field name or a callable extractor
+- **Zero runtime dependencies**
+- **Pluggable architecture** — designed for additional fusion algorithms
+
+**Planned:** additional score-based fusion variants.
+
+## Installation
+
+```bash
+pip install ranknexus
+```
+
+For local development:
+
+```bash
+git clone https://github.com/GauravAgga/Riffusion.git
+cd Riffusion
+pip install -e ".[dev]"
+```
+
+**Requirements:** Python 3.10+
+
+## Quick Start
+
+
+
+### Reciprocal Rank Fusion (RRF)
+
+Fuse BM25 and vector search results when score scales are incompatible and all retrievers should count equally:
+
+```python
+from ranknexus import fuse
+
+bm25_results = [
+    {"id": "doc-a", "text": "Introduction to machine learning"},
+    {"id": "doc-b", "text": "Deep learning fundamentals"},
+    {"id": "doc-c", "text": "Natural language processing"},
+]
+
+vector_results = [
+    {"id": "doc-b", "text": "Deep learning fundamentals"},
+    {"id": "doc-a", "text": "Introduction to machine learning"},
+    {"id": "doc-d", "text": "Transformer architectures"},
+]
+
+fused = fuse([bm25_results, vector_results], method="rrf", k=60, top_k=10)
+
+for result in fused:
+    print(result.document_id, result.score)
+```
+
+
+
+### Weighted Reciprocal Rank Fusion
+
+When ranks are trustworthy but one retriever should count more, use weighted RRF. Weights are **required**, must each satisfy `0 < w_i <= 1`, and must sum to `1`:
+
+```python
+from ranknexus import fuse
+
+bm25_results = [
+    {"id": "doc-a", "text": "Introduction to machine learning"},
+    {"id": "doc-b", "text": "Deep learning fundamentals"},
+]
+
+vector_results = [
+    {"id": "doc-b", "text": "Deep learning fundamentals"},
+    {"id": "doc-c", "text": "Transformer architectures"},
+]
+
+fused = fuse(
+    [bm25_results, vector_results],
+    method="weighted_rrf",
+    weights=[0.3, 0.7],
+    k=60,
+    top_k=10,
+)
+
+for result in fused:
+    print(result.document_id, result.score)
+```
+
+
+
+### Weighted Score Fusion
+
+When retriever scores are meaningful, fuse them with weights (scores are min-max normalized per list by default):
+
+```python
+from ranknexus import fuse
+
+bm25_results = [
+    {"id": "doc-a", "score": 12.4, "text": "Introduction to machine learning"},
+    {"id": "doc-b", "score": 8.1, "text": "Deep learning fundamentals"},
+]
+
+vector_results = [
+    {"id": "doc-b", "score": 0.92, "text": "Deep learning fundamentals"},
+    {"id": "doc-c", "score": 0.71, "text": "Transformer architectures"},
+]
+
+fused = fuse(
+    [bm25_results, vector_results],
+    method="weighted_score",
+    score_field="score",
+    weights=[0.3, 0.7],
+    top_k=10,
+)
+
+for result in fused:
+    print(result.document_id, result.score)
+```
+
+
+
+### Custom document IDs
+
+```python
+results = fuse(
+    [product_ranking],
+    id_field="product_id",
+)
+
+results = fuse(
+    [product_ranking],
+    id_field=lambda item: item["product"]["id"],
+)
+```
+
+
+
+## API Reference
+
+
+
+### `fuse(rankings, *, method, id_field, score_field, weights, k, normalize, top_k)`
+
+
+| Parameter     | Default      | Description                                                                                                                                          |
+| ------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `rankings`    | *(required)* | Iterable of ranked document lists. Order within each list represents rank (best first).                                                              |
+| `method`      | `"rrf"`      | Fusion algorithm: `"rrf"`, `"weighted_rrf"`, or `"weighted_score"`.                                                                                  |
+| `id_field`    | `"id"`       | Field name or callable used to identify documents across lists.                                                                                      |
+| `score_field` | `None`       | Score field or callable. **Required** for `"weighted_score"`.                                                                                        |
+| `weights`     | `None`       | Per-ranking weights. **Required** for `"weighted_rrf"` (`0 < w_i <= 1`, must sum to 1). Optional for `"weighted_score"`. Not supported by plain RRF. |
+| `k`           | `60`         | RRF / weighted RRF smoothing constant.                                                                                                               |
+| `normalize`   | `True`       | For `"weighted_score"`: min-max normalize each ranking to `[0, 1]` before weighting. Set `False` for raw weighted CombSUM.                           |
+| `top_k`       | `None`       | Maximum number of results to return.                                                                                                                 |
+
+
+**Returns:** A list of `FusedResult` objects, each with:
+
+- `document` — the original document payload
+- `document_id` — the document identifier
+- `score` — the fused ranking score
+
+
+
+## Architecture
+
+```
+ranknexus/
+├── api/          # Public fuse() entry point
+├── core/         # Data models and FusionAlgorithm protocol
+└── algorithms/   # Fusion implementations (RRF, weighted RRF, weighted score, …)
+```
+
+
+
+## Choosing an Algorithm
+
+
+
+### Reciprocal Rank Fusion (RRF)
+
+**Good fit:**
+
+- Hybrid search (keyword + semantic) with incompatible score scales
+- Multi-index RAG with different retrievers
+- Ensemble retrieval where all sources should count equally and you trust ranks more than raw scores
+
+**Not ideal:**
+
+- When you need to weight one retriever more heavily than another — use weighted RRF
+- When calibrated relevance scores matter more than rank position — use weighted score fusion
+
+
+
+### Weighted Reciprocal Rank Fusion
+
+**Good fit:**
+
+- Same situations as RRF, but one retriever should count more (for example, `weights=[0.3, 0.7]`)
+- You trust ranks more than raw scores, yet still want source emphasis
+
+**Not ideal:**
+
+- All retrievers should count equally — plain RRF is simpler
+- Raw scores are meaningful and comparable (after optional normalization) — prefer weighted score fusion
+
+
+
+### Weighted Score Fusion
+
+**Good fit:**
+
+- Retrievers produce meaningful scores you want to combine
+- You want to emphasize one source (for example, `weights=[0.3, 0.7]`)
+- Scores need a common scale — keep `normalize=True` (default) for min-max per list
+
+**Not ideal:**
+
+- Scores are on wildly different, untrusted scales and ranks are more reliable — prefer RRF or weighted RRF
+- You only have ordered lists without scores
+
+
+
+## Development
+
+```bash
+git clone https://github.com/GauravAgga/Riffusion.git
+cd Riffusion
+pip install -e ".[dev]"
+pytest tests/ -v
+```
+
+
+
+## Contributing
+
+Contributions are welcome. To add a new fusion algorithm:
+
+1. Implement the `FusionAlgorithm` protocol in `src/ranknexus/core/algorithm.py`
+2. Register it in `src/ranknexus/api/fusion.py`
+3. Add tests in `tests/`
+
+Please open an issue before large changes, and ensure all tests pass before submitting a pull request.
+
+## Roadmap
+
+- [ ] Publish to PyPI
+- [x] Weighted score fusion
+- [x] Weighted RRF
+- [ ] CI with GitHub Actions
+- [ ] Integration examples (LangChain, LlamaIndex)
+
+
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE).
+
+
+