algorithm-nexus 0.2.1__tar.gz

algorithm_nexus-0.2.1/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 [yyyy] [name of copyright owner]
+
+   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.

algorithm_nexus-0.2.1/PKG-INFO

@@ -0,0 +1,319 @@
+Metadata-Version: 2.4
+Name: algorithm-nexus
+Version: 0.2.1
+Summary: A comprehensive library for AI model delivery, testing, and benchmarking
+Author-email: Christian Pinto <christian.pinto@ibm.com>
+Maintainer-email: Christian Pinto <christian.pinto@ibm.com>
+Project-URL: Homepage, https://github.com/IBM/algorithm-nexus
+Project-URL: Issues, https://github.com/IBM/algorithm-nexus/issues
+Project-URL: Repository, https://github.com/IBM/algorithm-nexus
+Requires-Python: <3.14,>=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: candidate
+Requires-Dist: bmfm-targets[vllm]>=0.20.0; extra == "candidate"
+Requires-Dist: opencv-python-headless!=5.0.0.93; extra == "candidate"
+Requires-Dist: terrakit==0.2.0; extra == "candidate"
+Requires-Dist: terratorch[vllm]==1.2.10; extra == "candidate"
+Requires-Dist: vllm==0.24.0; extra == "candidate"
+Provides-Extra: cli
+Requires-Dist: ado-core>=2.0; extra == "cli"
+Requires-Dist: pydantic>=2.13.3; extra == "cli"
+Requires-Dist: pyyaml>=6.0.3; extra == "cli"
+Requires-Dist: rich>=15.0.0; extra == "cli"
+Requires-Dist: typer>=0.25.0; extra == "cli"
+Provides-Extra: ecosystem
+Requires-Dist: bmfm-targets; extra == "ecosystem"
+Requires-Dist: terrakit>=0.2.0; extra == "ecosystem"
+Requires-Dist: terratorch>=1.2.7; extra == "ecosystem"
+Requires-Dist: tokamind; extra == "ecosystem"
+Provides-Extra: product
+Requires-Dist: opencv-python-headless!=5.0.0.93; extra == "product"
+Requires-Dist: terrakit==0.2.0; extra == "product"
+Requires-Dist: terratorch[vllm]==1.2.10; extra == "product"
+Requires-Dist: vllm==0.24.0; extra == "product"
+Dynamic: license-file
+
+# Algorithm Nexus
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+Algorithm Nexus packages a diverse set of AI algorithm stacks — models,
+frameworks, and related tooling — within a unified Python environment. Each
+algorithm stack is described by a **Nexus package**: a small metadata directory
+that records the package's dependencies, models, and validation requirements.
+The `nexus` CLI validates Nexus packages and supports contributors in keeping
+their packages well-formed.
+
+## Roadmap
+
+### Version 0.1 (Alpha, End of April 2026)
+
+- **Project requirements for dependencies resolution, Nexus package definition,
+  testing and benchmarking**
+- **Protocol and tools for cross package dependency resolution in place**,
+  supporting with/without vLLM with latest and pinned scenarios
+- **Benchmarking and testing protocols defined**
+- **Nexus package and model owner responsibilities defined**
+- **Rules for contributing a new Nexus Package defined**
+- **Initial CI in place**, supporting Nexus package structure validation
+  (without vLLM validation), dependency resolution and models inference testing
+- **Nexus package for TerraTorch integrated**
+
+### Version 0.2 (Beta, End of May 2026)
+
+- **Requirements for models integration with vLLM defined**
+- **CI workflows extended** with validation of vLLM integration requirements and
+  benchmarking tasks
+- **Agentic skills implemented** for generation of a Nexus package and PR
+- **Agentic functionalities implemented** for supporting the implementation of
+  the vLLM plugins required for a model
+- **Integration of
+  [Tokamind](https://github.com/UKAEA-IBM-STFC-Fusion-FMs/tokamind) Fusion
+  models**
+
+### Version 0.3 (First Release, End of June 2026)
+
+- **Agentic functionalities extended** to supporting the deployment of the
+  integrated models
+- **Integration of additional algorithm packages from beta-test phase**
+- **Models scoreboard implemented** to track the performance of the integrated
+  models
+
+## Installation
+
+Choose the section that matches your goal:
+
+- [I want to install algorithm nexus packages in my environment](#installing-algorithm-nexus-packages-in-your-environment)
+- [I want to contribute my Python library to Algorithm Nexus](#contributing-your-python-library-to-algorithm-nexus)
+- [I want to develop Algorithm Nexus itself](#developing-algorithm-nexus)
+
+### Installing algorithm nexus packages in your environment
+
+Algorithm Nexus is **not published to PyPI**. All installs reference a tagged
+[GitHub Release](https://github.com/IBM/algorithm-nexus/releases).
+
+Each release ships three mutually-exclusive dependency variants. Pick the one
+that matches your environment:
+
+| Variant     | vLLM included    | Intended use                          |
+| ----------- | ---------------- | ------------------------------------- |
+| `ecosystem` | No               | Research and exploration environments |
+| `candidate` | Yes (latest)     | Pre-production evaluation             |
+| `product`   | Yes (stable pin) | Production deployments                |
+
+#### Install a variant
+
+Each release tag includes a pinned, hash-verified requirements file for every
+variant. Install using `uv`:
+
+```bash
+uv pip install -r https://raw.githubusercontent.com/IBM/algorithm-nexus/refs/tags/{version}/requirements-{variant}.txt
+```
+
+Replace `{version}` with the release tag (e.g. `v0.1.0`) and `{variant}` with
+`ecosystem`, `candidate`, or `product`.
+
+### Contributing your python library to algorithm nexus
+
+> **Note:** This project is currently in closed beta. Contributions are open to
+> IBM contributors only.
+
+Contributing a package means adding your Python library as an Algorithm Nexus
+dependency, creating a Nexus package metadata directory under `packages/`, and
+opening a pull request from a fork of the nexus repository.
+
+Before you begin you will need:
+
+- Your algorithm package publicly available on GitHub
+- [`uv`](https://docs.astral.sh/uv/getting-started/installation/) installed
+- A
+  [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
+  of this repository checked out locally
+
+Set up your local environment:
+
+```bash
+cd algorithm-nexus
+uv sync --group dev --extra cli
+uv run pre-commit install
+```
+
+Then create a branch and follow one of the two paths below.
+
+#### Option A — Coding Agent (Recommended)
+
+An agent skill is available for adding Nexus packages. Open the algorithm nexus
+repository in your coding agent and ask it to add your python package to the
+nexus giving it your package repository URL e.g.
+
+```commandline
+Add the package at ${URL} to the nexus
+```
+
+replacing `${URL}` with your packages repo URL.
+
+#### Option B — Manual
+
+Follow the step-by-step guide in
+[`docs/contributing/add_new_nexus_package.md`](docs/contributing/add_new_nexus_package.md),
+which covers variant classification, `nexus.yaml` authoring, dependency
+resolution with `uv add`, and opening a PR.
+
+#### Before opening a pull request
+
+Read [CONTRIBUTING.md](CONTRIBUTING.md) for DCO sign-off requirements, commit
+message conventions (Conventional Commits / Angular style), and coding style
+checks. All checks must pass before a PR can be merged.
+
+### Developing Algorithm Nexus
+
+For IBM contributors working on the CLI, validation logic, tests, or CI
+infrastructure. This setup is a superset of the package contributor setup — it
+adds the `test` dependency group.
+
+```bash
+git clone https://github.com/IBM/algorithm-nexus.git
+cd algorithm-nexus
+uv sync --extra cli --group dev --group test
+uv run pre-commit install --install-hooks
+uv run pre-commit install --hook-type commit-msg
+```
+
+Full details on coding standards, legal requirements (DCO), commit conventions,
+and manual lint commands are in [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## CLI Reference
+
+Algorithm Nexus provides the `nexus` CLI for working with Nexus packages.
+
+### Validating nexus packages
+
+To validate the structure and configuration of a Nexus package run:
+
+```bash
+nexus validate package /path/to/package
+```
+
+This will examine the following:
+
+- **Package structure**: Verifies required files (`nexus.yaml`, `model.yaml`)
+  and directories exist
+- **YAML syntax**: Ensures all configuration files are valid YAML
+- **Schema validation**: Validates configuration against Pydantic models for
+  correct field types and required fields
+- **Cross-validation**: Checks dependencies between configurations
+- **Model declarations**: Ensures all models have corresponding directories
+- **Duplicate detection**: Checks for duplicate HuggingFace model IDs
+
+In case of validation errors, a detailed report guides you to fix each issue.
+
+### Discovering packages and benchmarks
+
+Algorithm Nexus provides commands to discover and list packages, benchmark
+packages, and experiments across your repository.
+
+#### List all Nexus packages
+
+```bash
+nexus list packages [PACKAGES_ROOT]
+```
+
+Lists all valid Nexus packages found in the packages directory (default:
+`./packages`). Supports JSON and CSV output formats with `-o json` or `-o csv`.
+Use `--strict` to show warnings for packages that fail to load.
+
+**Example:**
+
+```bash
+nexus list packages ./packages --strict
+```
+
+#### List benchmark packages
+
+```bash
+nexus list benchmark-packages [PACKAGES_ROOT]
+```
+
+Lists all benchmark packages registered across Nexus packages. Shows which Nexus
+packages use each benchmark package. Filter by a specific Nexus package with
+`--nexus-package`.
+
+**Example:**
+
+```bash
+nexus list benchmark-packages ./packages --nexus-package terratorch
+```
+
+#### List benchmark experiments
+
+```bash
+nexus list benchmark-experiments [PACKAGES_ROOT]
+```
+
+Lists all benchmark experiments with their associated benchmark packages and
+Nexus packages. Filter by a specific Nexus package with `--nexus-package`.
+
+**Example:**
+
+```bash
+nexus list benchmark-experiments ./packages -o json
+```
+
+#### Get benchmark requirements
+
+```bash
+nexus get benchmark-requirements NEXUS_PACKAGE [PACKAGES_ROOT]
+```
+
+Retrieves the benchmark requirement specifiers for a specific Nexus package.
+Output in requirements.txt format with `-o txt` for use with pip.
+
+**Example:**
+
+```bash
+nexus get benchmark-requirements terratorch ./packages -o txt --output-file requirements.txt
+```
+
+### Output formats
+
+Most list commands support multiple output formats:
+
+- **Table** (default): Human-readable table output
+- **JSON** (`-o json`): Machine-readable JSON format
+- **CSV** (`-o csv`): Comma-separated values for spreadsheets
+- **TXT** (`-o txt`): Requirements file format (get commands only)
+
+Use `--output-file` to write output to a file instead of stdout.
+
+## Contributing
+
+This project is currently in closed beta. We are not accepting external
+contributions at this time.
+
+For IBM contributors:
+
+- See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.
+- See
+  [`docs/contributing/add_new_nexus_package.md`](docs/contributing/add_new_nexus_package.md)
+  for step-by-step instructions for contributing a Nexus package.
+
+## License
+
+This project is licensed under the Apache License 2.0 — see the
+[LICENSE](LICENSE) file for details.
+
+## Maintainers
+
+See [MAINTAINERS.md](MAINTAINERS.md) for the list of project maintainers.
+
+## Support
+
+- **Issues**: [GitHub Issues](https://github.com/IBM/algorithm-nexus/issues)
+- **Discussions**:
+  [GitHub Discussions](https://github.com/IBM/algorithm-nexus/discussions)
+
+## Acknowledgments
+
+This project is part of IBM's commitment to open-source AI infrastructure and
+collaboration with Red Hat.