hs-connectors 0.7.0__tar.gz

hs_connectors-0.7.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 [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.

hs_connectors-0.7.0/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.4
+Name: hs-connectors
+Version: 0.7.0
+Summary: Pluggable backends for transferring hidden states between vLLM and Speculators during online and offline training.
+Author: Red Hat
+License-Expression: Apache-2.0
+Keywords: hidden states,speculative decoding,speculators,vllm,llm,inference,training,online training,offline training,safetensors,mooncake,distributed training
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: safetensors
+Requires-Dist: torch
+Dynamic: license-file
+
+# hs_connectors
+
+`hs_connectors` is a lightweight package that enables the transfer of hidden states between vLLM and Speculators training processes during both online and offline training. It provides a pluggable backend system where each backend registers itself via `@HiddenStatesBackend.register(name)` and exposes hooks for CLI argument injection and configuration, so that training and serving scripts can discover and configure backends without hardcoding.
+
+The package should be installed alongside Speculators as well as within the same environment as vLLM.
+
+## Backends
+
+### Filesystem
+
+The filesystem backend enables the transfer of hidden states between vLLM and Speculators on a single node with a shared filesystem. Hidden states are serialized as safetensors files with file-lock synchronization to prevent partial reads. Cached samples are stored by index and can be reused across training runs.
+
+### Mooncake
+
+The Mooncake backend enables multi-node training by transferring hidden states between vLLM and Speculators across nodes over TCP or RDMA, without requiring a shared filesystem. It uses a Mooncake distributed key-value store where each sample is written under a sanitized request ID, with a metadata marker written last to signal that the sample is complete and ready for consumption. This follows a similar pattern to disaggregated prefill and decode.
+
+When using this backend, install the Mooncake transfer engine separately (`pip install mooncake-transfer-engine`).

hs_connectors-0.7.0/README.md

@@ -0,0 +1,17 @@
+# hs_connectors
+
+`hs_connectors` is a lightweight package that enables the transfer of hidden states between vLLM and Speculators training processes during both online and offline training. It provides a pluggable backend system where each backend registers itself via `@HiddenStatesBackend.register(name)` and exposes hooks for CLI argument injection and configuration, so that training and serving scripts can discover and configure backends without hardcoding.
+
+The package should be installed alongside Speculators as well as within the same environment as vLLM.
+
+## Backends
+
+### Filesystem
+
+The filesystem backend enables the transfer of hidden states between vLLM and Speculators on a single node with a shared filesystem. Hidden states are serialized as safetensors files with file-lock synchronization to prevent partial reads. Cached samples are stored by index and can be reused across training runs.
+
+### Mooncake
+
+The Mooncake backend enables multi-node training by transferring hidden states between vLLM and Speculators across nodes over TCP or RDMA, without requiring a shared filesystem. It uses a Mooncake distributed key-value store where each sample is written under a sanitized request ID, with a metadata marker written last to signal that the sample is complete and ready for consumption. This follows a similar pattern to disaggregated prefill and decode.
+
+When using this backend, install the Mooncake transfer engine separately (`pip install mooncake-transfer-engine`).

hs_connectors-0.7.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools >= 82.0.1", "setuptools-git-versioning>=2.0,<3", "packaging"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["*"]
+
+[project]
+name = "hs-connectors"
+description = "Pluggable backends for transferring hidden states between vLLM and Speculators during online and offline training."
+dynamic = ["version"]
+readme = { file = "README.md", content-type = "text/markdown" }
+requires-python = ">=3.10"
+keywords = [
+    "hidden states",
+    "speculative decoding",
+    "speculators",
+    "vllm",
+    "llm",
+    "inference",
+    "training",
+    "online training",
+    "offline training",
+    "safetensors",
+    "mooncake",
+    "distributed training"
+]
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [ { name = "Red Hat"} ]
+dependencies = [
+    "safetensors",
+    "torch",
+]

hs_connectors-0.7.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

hs_connectors-0.7.0/setup.py

@@ -0,0 +1,112 @@
+import os
+import re
+from pathlib import Path
+
+from packaging.version import Version
+from setuptools import setup
+from setuptools_git_versioning import count_since, get_branch, get_sha, get_tags
+
+REPO_ROOT = Path(__file__).parent.parent
+INITIAL_RELEASE_VERSION = Version("0.7.0")
+TAG_VERSION_PATTERN = re.compile(r"^hsc-v(\d+\.\d+\.\d+)$")
+
+
+def get_last_version_diff() -> tuple[Version, str | None, int]:
+    tagged_versions = [
+        (Version(match.group(1)), tag)
+        for tag in get_tags(root=REPO_ROOT)
+        if (match := TAG_VERSION_PATTERN.match(tag))
+    ]
+    tagged_versions.sort(key=lambda tv: tv[0])
+    last_version, last_tag = (
+        tagged_versions[-1] if tagged_versions else (INITIAL_RELEASE_VERSION, None)
+    )
+    commits_since_last = (
+        count_since(f"{last_tag}^{{commit}}", root=REPO_ROOT) if last_tag else 0
+    )
+    return last_version, last_tag, commits_since_last
+
+
+def get_next_version(build_type: str) -> tuple[Version, str | None, int]:
+    version, tag, commits_since_last = get_last_version_diff()
+
+    if build_type == "release":
+        if not tag:
+            raise ValueError("RELEASE build requires an hsc-vX.Y.Z tag")
+        if commits_since_last:
+            raise ValueError(
+                f"RELEASE build must be on tag {tag}; "
+                f"HEAD is {commits_since_last} commit(s) ahead"
+            )
+        return version, tag, 0
+
+    if build_type == "nightly":
+        # nightly version will be patch+1 from last release tag:
+        # e.g. tag hsc-v0.1.0 + 3 commits -> 0.1.1a3
+        return (
+            Version(
+                f"{version.major}.{version.minor}.{version.micro + 1}"
+                f".a{commits_since_last}"
+            ),
+            tag,
+            commits_since_last,
+        )
+
+    raise ValueError(f"Unsupported HS_CONNECTORS_BUILD_TYPE={build_type!r}")
+
+
+def read_existing_version(version_py: Path) -> tuple[Version, str | None, int]:
+    if version_py.exists():
+        text = version_py.read_text()
+        match_version = re.search(r'^version\s*=\s*["\']([^"\']+)["\']', text, re.M)
+        match_tag = re.search(r'^git_last_tag\s*=\s*["\']([^"\']*)["\']', text, re.M)
+        match_iteration = re.search(
+            r'^build_iteration\s*=\s*["\']([^"\']+)["\']', text, re.M
+        )
+        version = Version(match_version.group(1)) if match_version else None
+        tag = match_tag.group(1) if match_tag and match_tag.group(1) else None
+        build_iteration = int(match_iteration.group(1)) if match_iteration else 0
+    return version, tag, build_iteration
+
+
+def building_from_sdist() -> bool:
+    # sdist extracts as hs_connectors-<version>/setup.py
+    return Path(__file__).parent.name.startswith("hs_connectors-")
+
+
+def write_version_files() -> tuple[Path, Path]:
+    build_type = os.getenv("HS_CONNECTORS_BUILD_TYPE", "nightly").lower()
+    module_path = Path(__file__).parent / "src" / "hs_connectors"
+    version_txt_path = module_path / "version.txt"
+    version_py_path = module_path / "version.py"
+
+    if building_from_sdist() and version_py_path.exists():
+        version, tag, build_iteration = read_existing_version(version_py_path)
+    else:
+        version, tag, build_iteration = get_next_version(build_type)
+
+    git_commit = get_sha(root=REPO_ROOT) if (not building_from_sdist()) else ""
+    git_branch = get_branch(root=REPO_ROOT) if (not building_from_sdist()) else ""
+
+    with version_txt_path.open("w") as f:
+        f.write(str(version))
+    with version_py_path.open("w") as f:
+        f.writelines(
+            [
+                f'version = "{version}"\n',
+                f'build_type = "{build_type}"\n',
+                f'build_iteration = "{build_iteration}"\n',
+                f'git_commit = "{git_commit}"\n',
+                f'git_branch = "{git_branch}"\n',
+                f'git_last_tag = "{tag or ""}"\n',
+            ]
+        )
+    return version_txt_path, version_py_path
+
+
+setup(
+    setuptools_git_versioning={
+        "enabled": True,
+        "version_file": str(write_version_files()[0]),
+    }
+)

hs_connectors-0.7.0/src/hs_connectors/__init__.py

@@ -0,0 +1,22 @@
+from hs_connectors.transfer import (
+    FileBackend,
+    FileTransfer,
+    HiddenStatesBackend,
+    HiddenStatesTransfer,
+    MooncakeBackend,
+    MooncakeTransfer,
+)
+
+__all__ = [
+    "FileBackend",
+    "FileTransfer",
+    "HiddenStatesBackend",
+    "HiddenStatesTransfer",
+    "MooncakeBackend",
+    "MooncakeTransfer",
+]
+
+try:
+    from hs_connectors.version import version as __version__
+except ImportError:
+    __version__ = "unknown"