prefixsim 0.1.0__tar.gz

prefixsim-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+build/
+dist/
+*.egg-info/
+__pycache__/
+*.so
+.venv/
+.pytest_cache/
+wheelhouse/

prefixsim-0.1.0/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "extern/PrefixSim"]
+	path = extern/PrefixSim
+	url = https://github.com/cacheMon/PrefixSim.git

prefixsim-0.1.0/CMakeLists.txt

@@ -0,0 +1,62 @@
+cmake_minimum_required(VERSION 3.15...3.31)
+project(prefixsim_python LANGUAGES C CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)  # static libs linked into a shared module
+
+set(PREFIXSIM_DIR ${CMAKE_CURRENT_SOURCE_DIR}/extern/PrefixSim)
+if(NOT EXISTS ${PREFIXSIM_DIR}/libCacheSim/CMakeLists.txt)
+    message(FATAL_ERROR "run `git submodule update --init --recursive`")
+endif()
+
+# tcmalloc must own the heap from process start, so it cannot come in with a module.
+set(CMAKE_DISABLE_FIND_PACKAGE_Tcmalloc ON)
+
+# For wheels: manylinux counts glib as a system library, so auditwheel does not
+# bundle it, but slim images lack it. libCacheSim links glib by the name
+# glib-2.0, and a target of that name takes precedence: point it at the static
+# archive and its static dependencies (pkg-config --static).
+option(PREFIXSIM_STATIC_GLIB "link glib statically" OFF)
+if(PREFIXSIM_STATIC_GLIB)
+    find_package(PkgConfig REQUIRED)
+    pkg_check_modules(GLIB_STATIC REQUIRED glib-2.0)
+    set(glib_deps "")
+    foreach(lib IN LISTS GLIB_STATIC_STATIC_LIBRARIES)
+        if(lib MATCHES "^(glib-2.0|m|dl|pthread|rt)$")
+            continue()
+        endif()
+        find_library(${lib}_archive lib${lib}.a REQUIRED)
+        list(APPEND glib_deps ${${lib}_archive})
+    endforeach()
+    find_library(glib_archive libglib-2.0.a REQUIRED)
+    find_package(Threads REQUIRED)
+    add_library(glib-2.0 STATIC IMPORTED GLOBAL)
+    set_target_properties(glib-2.0 PROPERTIES IMPORTED_LOCATION ${glib_archive}
+        INTERFACE_LINK_LIBRARIES "${glib_deps};Threads::Threads;m")
+    message(STATUS "glib linked statically: ${glib_archive} ${glib_deps}")
+endif()
+# libCacheSim's xxhash (0.7.4) reads keys through a packed union when GCC targets
+# ARM, which breaks strict aliasing: on Linux aarch64 at -O3 the hash table then
+# hashes stale stack bytes and cannot find what it just inserted. Use the memcpy
+# reads that x86 and clang already get; they compile to the same loads.
+add_compile_definitions(XXH_FORCE_MEMORY_ACCESS=0)
+set(PREFIXSIM_ENABLE_TESTS OFF CACHE BOOL "" FORCE)
+add_subdirectory(${PREFIXSIM_DIR} ${CMAKE_BINARY_DIR}/PrefixSim EXCLUDE_FROM_ALL)
+# upstream's -Werror should not fail the build on a newer compiler
+foreach(target libCacheSim prefixsim_lib)
+    target_compile_options(${target} PRIVATE -Wno-error)
+endforeach()
+
+find_package(Python REQUIRED COMPONENTS Interpreter Development.Module)
+find_package(pybind11 CONFIG REQUIRED)
+pybind11_add_module(_core MODULE csrc/bindings.cpp)
+target_link_libraries(_core PRIVATE prefixsim_lib)
+# libCacheSim links glib by name and adds its directory only in its own scope
+# (see PrefixSim's CMakeLists); glib is off the default path on macOS
+get_directory_property(glib_dirs DIRECTORY ${PREFIXSIM_DIR}/libCacheSim
+    DEFINITION GLib_LIBRARY_DIRS)
+target_link_directories(_core PRIVATE ${glib_dirs})
+if(PREFIXSIM_STATIC_GLIB)
+    target_link_options(_core PRIVATE -Wl,--exclude-libs,ALL)  # keep the bundled glib private
+endif()
+install(TARGETS _core LIBRARY DESTINATION prefixsim)

prefixsim-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

prefixsim-0.1.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: prefixsim
+Version: 0.1.0
+Summary: Python bindings for PrefixSim, the KV-block prefix-cache simulator
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: extern/PrefixSim/LICENSE
+License-File: extern/PrefixSim/libCacheSim/LICENSE
+License-File: extern/PrefixSim/libCacheSim/NOTICE
+License-File: third_party/NOTICE.md
+License-File: third_party/glib-LGPL-2.1.txt
+License-File: third_party/pcre-LICENCE.txt
+License-File: third_party/sysprof-capture-COPYING.txt
+License-File: third_party/zstd-LICENSE.txt
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering
+Project-URL: Homepage, https://github.com/haochengxia/PrefixSim-python
+Project-URL: Issues, https://github.com/haochengxia/PrefixSim-python/issues
+Project-URL: PrefixSim, https://github.com/cacheMon/PrefixSim
+Requires-Python: >=3.10
+Requires-Dist: huggingface_hub>=0.20
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Description-Content-Type: text/markdown
+
+# PrefixSim-python
+
+Python bindings for [PrefixSim](https://github.com/cacheMon/PrefixSim). The
+simulation is PrefixSim's own C++ (the `extern/PrefixSim` submodule), so results
+match its CLI. The Python layer adds:
+
+- cache sizes in bytes (`"24GiB"`), from a model's KV size and the trace's block size;
+- models from their Hugging Face config: KV bytes per token and a prefill-FLOPs cost model;
+- parallel sweeps, one process per (algorithm, cache size);
+- engine metrics: hits before each request's first miss, which is what vLLM and SGLang reuse.
+
+## Install
+
+```bash
+pip install prefixsim
+```
+
+Wheels are prebuilt for Python 3.10–3.14 on Linux (x86_64 and aarch64, glibc
+2.34+: Ubuntu 22.04+, Debian 12+, RHEL 9+) and Apple-silicon macOS, with
+PrefixSim, libCacheSim, glib and zstd inside: there is nothing to compile or
+install first. Elsewhere pip builds from source, which needs a C++17 compiler,
+glib, zstd and Python's headers.
+
+## Use
+
+```python
+import prefixsim
+
+trace = prefixsim.download_trace("freeinference")  # 76 MB, cached by Hugging Face
+
+# blocks, as the CLI
+results = prefixsim.simulate(trace, "16k", "lru,s3fifo", cost_model="qwen3coder30b_blksz_16")
+
+# bytes: the model sets the block's size and the cost model
+model = prefixsim.ModelSpec.from_hf("Qwen/Qwen3-Coder-30B-A3B-Instruct")
+if __name__ == "__main__":  # sweep spawns worker processes
+    results = prefixsim.sweep(trace, ["lru", "s3fifo", "random_compute"],
+                              ["24GiB", "48GiB", "96GiB"], model=model, csv_path="results.csv")
+```
+
+Each result is a dict. `pandas.DataFrame(results)` gives a table.
+`prefixsim.convert("trace.jsonl", "trace.lcp.zst")` turns a JSONL trace into
+lcp, which streams instead of being loaded whole.
+
+## Metrics
+
+`block_hit_ratio` and `compute_saving_ratio` are PrefixSim's. They count every
+resident block, past a miss too (`doc/design.md`, "A block after a miss still
+counts"). `engine_hit_ratio` and `engine_compute_saving_ratio` stop at the
+request's first miss. The bindings measure them by probing each request's blocks
+just before PrefixSim serves it, which costs about 4% time
+(`engine_metrics=False` turns it off). The two can rank policies differently.
+Here is freeinference at 16k blocks with `qwen3coder30b_blksz_16`:
+
+| Algorithm | `compute_saving_ratio` | `engine_compute_saving_ratio` |
+|---|---:|---:|
+| `lru` | 0.5333 | 0.5333 |
+| `s3fifo` | 0.5491 | 0.4984 |
+| `sieve` | 0.5459 | 0.5036 |
+| `random_compute` | 0.6378 | 0.3375 |
+
+They are equal for `lru` only under the defaults, `replay_order="deepest-first"`
+and `block_id="prefix"`. In that case a request touches a block's parent after
+the block, so the parent is always newer and LRU's victim is a leaf. With
+`prefix-order` replay, or with `raw` ids where one id can sit under different
+parents, LRU leaves gaps too.
+
+## Notes
+
+- **Models.** Only standard attention (MHA/GQA/MQA) and MLA, dense or MoE, are
+  handled. Configs with sliding-window or linear-attention layers are refused
+  (`strict=False` counts them as full attention). The bundled traces were cut
+  with Qwen3-Coder's tokenizer, so another model changes a block's bytes and
+  cost, not where the blocks are.
+- **Randomized algorithms.** Their random number generators are reset before
+  every run, so a run matches the CLI whatever ran before it; `seed=` picks
+  another stream.
+- **Aborts.** PrefixSim aborts the process on some errors, for example `s3fifo`
+  below 10 blocks. `sweep` runs each simulation in its own process and reports
+  which runs were lost.
+- **Sizes.** `"64g"` is refused, because the CLI reads it as 2³⁰ × 64 blocks.
+  Write `"64GiB"`.
+- **tcmalloc** is left out: it cannot be loaded into a running Python process.
+- **License.** Apache-2.0, as PrefixSim and libCacheSim. The Linux wheels link
+  GLib (LGPL-2.1-or-later) statically; see `third_party/NOTICE.md`.
+
+## Releasing
+
+`.github/workflows/wheels.yml` builds and tests every wheel on each push.
+Running it by hand publishes to TestPyPI, and publishing a GitHub release
+publishes to PyPI, both through trusted publishing. To build locally:
+`uvx cibuildwheel --platform linux` (needs Docker), or `uv build --sdist`.

prefixsim-0.1.0/README.md

@@ -0,0 +1,92 @@
+# PrefixSim-python
+
+Python bindings for [PrefixSim](https://github.com/cacheMon/PrefixSim). The
+simulation is PrefixSim's own C++ (the `extern/PrefixSim` submodule), so results
+match its CLI. The Python layer adds:
+
+- cache sizes in bytes (`"24GiB"`), from a model's KV size and the trace's block size;
+- models from their Hugging Face config: KV bytes per token and a prefill-FLOPs cost model;
+- parallel sweeps, one process per (algorithm, cache size);
+- engine metrics: hits before each request's first miss, which is what vLLM and SGLang reuse.
+
+## Install
+
+```bash
+pip install prefixsim
+```
+
+Wheels are prebuilt for Python 3.10–3.14 on Linux (x86_64 and aarch64, glibc
+2.34+: Ubuntu 22.04+, Debian 12+, RHEL 9+) and Apple-silicon macOS, with
+PrefixSim, libCacheSim, glib and zstd inside: there is nothing to compile or
+install first. Elsewhere pip builds from source, which needs a C++17 compiler,
+glib, zstd and Python's headers.
+
+## Use
+
+```python
+import prefixsim
+
+trace = prefixsim.download_trace("freeinference")  # 76 MB, cached by Hugging Face
+
+# blocks, as the CLI
+results = prefixsim.simulate(trace, "16k", "lru,s3fifo", cost_model="qwen3coder30b_blksz_16")
+
+# bytes: the model sets the block's size and the cost model
+model = prefixsim.ModelSpec.from_hf("Qwen/Qwen3-Coder-30B-A3B-Instruct")
+if __name__ == "__main__":  # sweep spawns worker processes
+    results = prefixsim.sweep(trace, ["lru", "s3fifo", "random_compute"],
+                              ["24GiB", "48GiB", "96GiB"], model=model, csv_path="results.csv")
+```
+
+Each result is a dict. `pandas.DataFrame(results)` gives a table.
+`prefixsim.convert("trace.jsonl", "trace.lcp.zst")` turns a JSONL trace into
+lcp, which streams instead of being loaded whole.
+
+## Metrics
+
+`block_hit_ratio` and `compute_saving_ratio` are PrefixSim's. They count every
+resident block, past a miss too (`doc/design.md`, "A block after a miss still
+counts"). `engine_hit_ratio` and `engine_compute_saving_ratio` stop at the
+request's first miss. The bindings measure them by probing each request's blocks
+just before PrefixSim serves it, which costs about 4% time
+(`engine_metrics=False` turns it off). The two can rank policies differently.
+Here is freeinference at 16k blocks with `qwen3coder30b_blksz_16`:
+
+| Algorithm | `compute_saving_ratio` | `engine_compute_saving_ratio` |
+|---|---:|---:|
+| `lru` | 0.5333 | 0.5333 |
+| `s3fifo` | 0.5491 | 0.4984 |
+| `sieve` | 0.5459 | 0.5036 |
+| `random_compute` | 0.6378 | 0.3375 |
+
+They are equal for `lru` only under the defaults, `replay_order="deepest-first"`
+and `block_id="prefix"`. In that case a request touches a block's parent after
+the block, so the parent is always newer and LRU's victim is a leaf. With
+`prefix-order` replay, or with `raw` ids where one id can sit under different
+parents, LRU leaves gaps too.
+
+## Notes
+
+- **Models.** Only standard attention (MHA/GQA/MQA) and MLA, dense or MoE, are
+  handled. Configs with sliding-window or linear-attention layers are refused
+  (`strict=False` counts them as full attention). The bundled traces were cut
+  with Qwen3-Coder's tokenizer, so another model changes a block's bytes and
+  cost, not where the blocks are.
+- **Randomized algorithms.** Their random number generators are reset before
+  every run, so a run matches the CLI whatever ran before it; `seed=` picks
+  another stream.
+- **Aborts.** PrefixSim aborts the process on some errors, for example `s3fifo`
+  below 10 blocks. `sweep` runs each simulation in its own process and reports
+  which runs were lost.
+- **Sizes.** `"64g"` is refused, because the CLI reads it as 2³⁰ × 64 blocks.
+  Write `"64GiB"`.
+- **tcmalloc** is left out: it cannot be loaded into a running Python process.
+- **License.** Apache-2.0, as PrefixSim and libCacheSim. The Linux wheels link
+  GLib (LGPL-2.1-or-later) statically; see `third_party/NOTICE.md`.
+
+## Releasing
+
+`.github/workflows/wheels.yml` builds and tests every wheel on each push.
+Running it by hand publishes to TestPyPI, and publishing a GitHub release
+publishes to PyPI, both through trusted publishing. To build locally:
+`uvx cibuildwheel --platform linux` (needs Docker), or `uv build --sdist`.