foretoken 0.0.1a1__tar.gz

foretoken-0.0.1a1/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.

foretoken-0.0.1a1/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: foretoken
+Version: 0.0.1a1
+Summary: Command-line tools for installing and operating Foretoken
+Author: Foretoken contributors
+License-Expression: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: packaging>=24.0
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: bench
+Requires-Dist: datasets>=2.14; extra == "bench"
+Requires-Dist: evalscope>=1.10; extra == "bench"
+Requires-Dist: httpx>=0.27; extra == "bench"
+Requires-Dist: huggingface_hub>=0.23; extra == "bench"
+Requires-Dist: matplotlib>=3.7; extra == "bench"
+Requires-Dist: numpy>=1.24; extra == "bench"
+Requires-Dist: openai>=1.40; extra == "bench"
+Requires-Dist: tqdm>=4.65; extra == "bench"
+Requires-Dist: transformers>=4.40; extra == "bench"
+Requires-Dist: vllm>=0.18; extra == "bench"
+Requires-Dist: wandb>=0.16; extra == "bench"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+<!--
+SPDX-License-Identifier: Apache-2.0
+SPDX-FileCopyrightText: Copyright contributors to the Foretoken project
+-->
+
+# Foretoken command-line tool
+
+English | [简体中文](README_zh.md)
+
+The Foretoken command-line tool installs the shared Kubernetes platform, deploys model services from Kustomize configurations, reports serving readiness, resolves frontend endpoints, and runs benchmarks through one `foretoken` entry point.
+
+For a new cluster, start by installing the command-line tool. If `foretoken --version` already works, go straight to platform installation. If the cluster already has the Foretoken platform, start with model deployment.
+
+## Before you start
+
+You need Python 3.10 or later, an active Kubernetes context, `kubectl`, and Helm. GPU nodes must already have their vendor driver and Kubernetes device plugin. Source installation also requires Docker and Make, plus either a local kind/k3d cluster or an OCI registry reachable by every target node.
+
+## Install the command-line tool
+
+Install the published Foretoken command-line tool package with pip:
+
+```bash
+pip install foretoken
+
+# For source installation from the repository:
+# pip install -e .
+```
+
+Or create and activate a virtual environment with uv:
+
+```bash
+uv venv
+source .venv/bin/activate
+uv pip install foretoken
+```
+
+This step only installs the `foretoken` command in the current Python environment; it does not change the Kubernetes cluster. Run `foretoken --version` to see the command-line tool and corresponding platform version.
+
+## Install the Kubernetes platform
+
+`foretoken install` installs the Foretoken CRDs and controller in the active Kubernetes context. Platform resources use the `foretoken-platform` namespace. The command also configures monitoring and, in Gateway mode, the Gateway resources. Deploy model services separately with `foretoken deploy`.
+
+### Default installation
+
+The default uses release images and local access through a `LoadBalancer` Service:
+
+```bash
+foretoken install
+```
+
+During installation, the command-line tool discovers Prometheus and accelerator metric exporters. It reuses compatible shared instances, installs managed Prometheus and NVIDIA DCGM Exporter releases when needed, and connects to the mxExporter already provided by a MetaX cluster. It never installs GPU drivers, device plugins, or vendor operators. Ambiguous or incomplete monitoring stops installation with an actionable error; see [Observability](../observability/README.md) for the selection rules.
+
+### Gateway mode
+
+The command-line tool creates a dedicated `GatewayClass` and `Gateway` only when the cluster runs Envoy Gateway:
+
+```bash
+foretoken install --frontend-mode gateway
+```
+
+With another Gateway Controller, reuse a Gateway managed by that controller:
+
+```bash
+foretoken install \
+  --frontend-mode gateway \
+  --gateway-name inference-gateway \
+  --gateway-namespace gateway-system
+```
+
+Add `--gateway-section-name LISTENER` only when more than one listener matches.
+
+### Current source
+
+Build Foretoken images from the current source tree and configure the platform to use them:
+
+```bash
+foretoken install -e .
+```
+
+A standard active kind or k3d context imports the built images locally. Other Kubernetes contexts need a registry reachable by their nodes. Sign in to the registry host with an account that can push the target repository before installation:
+
+```bash
+docker login ghcr.io
+foretoken install -e . --registry ghcr.io/example/foretoken
+```
+
+Registry login authorizes the local image push. Private registries also need `imagePullSecrets` and `workload.imagePullSecrets` through `--values` so nodes can pull the images; see [Deploy Foretoken from Source](../docs/custom-deployment.md).
+
+### Installation options
+
+Repeatable `--values` files provide platform image, runtime, and hardware settings. Release and source installs record their mode in Helm metadata and cannot switch silently. Releases originally installed directly with Helm remain under their existing Helm lifecycle and are not adopted automatically.
+
+## Deploy and operate model services
+
+Deploy one frontend and all models rendered by a Kustomize root:
+
+```bash
+foretoken deploy examples/multi-model-quickstart
+```
+
+The command applies the configuration, reports each `FrontendService` and `ModelService` state when it changes, and exits when every resource is Ready for its current generation. Change the default ten-minute deadline with `--timeout`.
+
+Delete the resources rendered by the same configuration:
+
+```bash
+foretoken delete examples/multi-model-quickstart
+```
+
+The command waits for deletion and ignores resources that are already absent. After deleting all Foretoken services, remove the platform release:
+
+```bash
+foretoken uninstall
+```
+
+The command preserves Foretoken CRDs and refuses to uninstall while user-owned services remain. It removes monitoring and Gateway resources managed by the command-line tool with the platform, while reused cluster components remain unchanged.
+
+Inspect the same deployment without applying it:
+
+```bash
+foretoken status examples/multi-model-quickstart
+```
+
+Inspect every Foretoken service in a namespace, or continue watching state changes:
+
+```bash
+foretoken status -n foretoken-multi-model-demo
+foretoken status -n foretoken-multi-model-demo --watch
+```
+
+Resolve the public frontend URL after deployment:
+
+```bash
+FORETOKEN_FRONTEND_URL="$(foretoken endpoint examples/multi-model-quickstart)"
+```
+
+For an HTTP Gateway, resolve its request `Host` separately:
+
+```bash
+FORETOKEN_FRONTEND_URL="$(foretoken endpoint examples/quickstart)"
+FORETOKEN_REQUEST_HOST="$(foretoken endpoint examples/quickstart --host)"
+```
+
+The host value is the URL authority for direct access or the configured routing hostname for an HTTP Gateway. The command waits for the LoadBalancer or Gateway address, but serving readiness remains owned by `foretoken deploy`.
+
+## Run benchmarks
+
+Install the optional benchmark dependencies with pip:
+
+```bash
+pip install 'foretoken[bench]'
+
+# For source installation from the repository:
+# pip install -e .
+# pip install -e '.[bench]'
+```
+
+Or install the benchmark dependencies in the activated uv environment:
+
+```bash
+uv pip install 'foretoken[bench]'
+```
+
+Then run the benchmark:
+
+```bash
+foretoken bench examples/quickstart
+```
+
+The command-line tool uses the active `kubectl` context and honors standard Kubernetes configuration such as `KUBECONFIG`.

foretoken-0.0.1a1/README.md

@@ -0,0 +1,168 @@
+# Foretoken
+
+English | [简体中文](README_zh.md)
+
+Foretoken is a generative inference orchestration framework built for SLO/SLA targets and heterogeneous accelerators.
+
+Built on inference engines such as vLLM and SGLang, Foretoken organizes multiple generation instances into a cluster service for request routing, autoscaling, instance management, and benchmarking.
+We aim to turn an inference cluster into a token factory that continuously converts compute into tokens while meeting latency and quality requirements.
+
+## When to Use Foretoken
+
+- Serve one or more models across multiple GPUs or nodes.
+- Route requests based on load, queue depth, or KV cache state.
+- Autoscale inference instances based on traffic and SLO targets.
+- Compare aggregated serving, Prefill/Decode disaggregation, and different parallelism strategies.
+- Use the same orchestration stack across NVIDIA and MetaX accelerators.
+
+If you only need to serve a single model on one GPU, using an inference engine such as vLLM directly is usually enough.
+
+## Features and Status
+
+| Feature | Description | Status |
+|---|---|---|
+| Benchmarking | Performance benchmarks and parameter sweeps, correctness evaluation, and SLO simulation | In development |
+| Profiling | Use PyTorch Profiler and Nsight to identify compute, communication, and CPU/GPU bottlenecks | Planned |
+| Hardware support | Common interfaces for device capabilities, runtimes, communication, and metrics | In development |
+| Request routing | Select instances based on load, queues, KV reuse, and service levels | Research |
+| Distributed inference | Aggregated serving, Prefill/Decode disaggregation, and WideEP parallelism | Research |
+| Control plane | Model services, instance groups, autoscaling, updates, and failure recovery | In development |
+| [Observability](observability/README.md) | Collect runtime metrics, evaluate alerts, and profile CPU/GPU bottlenecks | In development |
+
+## Quick Start
+
+This Quick Start requires Python 3.10 or later, a Kubernetes cluster, `kubectl`, Helm, and at least one available GPU. See the [k3d guide](docs/k3d-deployment.md) to prepare a single-machine test cluster.
+
+### 1. Install the command-line tool
+
+Install the published command-line tool package:
+
+```bash
+pip install foretoken
+
+# For source installation from the repository:
+# pip install -e .
+```
+
+### 2. Install the Kubernetes platform
+
+By default, installation uses the Foretoken images published on GHCR:
+
+```bash
+# Release images:
+foretoken install
+
+# Source installation from the repository:
+# foretoken install -e .
+```
+
+This installs the Foretoken CRDs and controller in the `foretoken-platform` namespace and waits for the controller to become ready. The default mode exposes the frontend through a `LoadBalancer` Service. Source installation rebuilds the images and updates the cluster; to deploy the current source to a remote cluster, see the [source deployment guide](docs/custom-deployment.md).
+
+### 3. Deploy the Quick Start
+
+```bash
+foretoken deploy examples/quickstart
+```
+
+This example deploys one frontend service and one `Qwen/Qwen3-0.6B` model replica. The workload requests one GPU, 8 CPU, and 52 GiB memory; allow additional capacity for the platform. See the [single-model example](examples/quickstart/README.md) for its resource configuration and [`examples/`](examples/) for more deployments.
+
+### 4. Send a test request
+
+```bash
+FORETOKEN_FRONTEND_URL="$(foretoken endpoint examples/quickstart)"
+
+curl --fail-with-body --no-buffer \
+  "$FORETOKEN_FRONTEND_URL/v1/chat/completions" \
+  -H "Content-Type: application/json" \
+  -d '{"model":"Qwen/Qwen3-0.6B","messages":[{"role":"user","content":"Hello"}],"stream":true}'
+```
+
+### 5. Run a benchmark
+
+```bash
+pip install 'foretoken[bench]'
+
+# For source installation from the repository:
+# pip install -e .
+# pip install -e '.[bench]'
+foretoken bench examples/quickstart
+```
+
+See [Benchmarking](benchmarks/README.md) for datasets, remote endpoints, result storage, and parameter sweeps.
+
+## Gateway Mode
+
+Gateway mode provides a shared entry point through Kubernetes Gateway and a hostname. It suits clusters that already use Gateway or manage external traffic centrally.
+
+Foretoken creates its default Gateway for Envoy Gateway. Install Envoy Gateway, then add the public hostname under `spec` in `examples/quickstart/frontend.yaml`:
+
+```yaml
+spec:
+  hostname: foretoken.example.com
+```
+
+Then run:
+
+```bash
+# Install Envoy Gateway
+helm upgrade --install envoy-gateway \
+  oci://docker.io/envoyproxy/gateway-helm \
+  --namespace envoy-gateway-system \
+  --create-namespace \
+  --wait
+
+# Install the platform in Gateway mode
+foretoken install --frontend-mode gateway
+
+# Deploy the Quick Start
+foretoken deploy examples/quickstart
+
+# Resolve the Gateway address and request hostname
+FORETOKEN_FRONTEND_URL="$(foretoken endpoint examples/quickstart)"
+FORETOKEN_REQUEST_HOST="$(foretoken endpoint examples/quickstart --host)"
+
+# Send a test request
+curl --fail-with-body --no-buffer \
+  "$FORETOKEN_FRONTEND_URL/v1/chat/completions" \
+  -H "Host: $FORETOKEN_REQUEST_HOST" \
+  -H "Content-Type: application/json" \
+  -d '{"model":"Qwen/Qwen3-0.6B","messages":[{"role":"user","content":"Hello"}],"stream":true}'
+```
+
+See the [command-line tool guide](cli/README.md) to reuse a Gateway from another controller, select a listener, or configure TLS.
+
+## Stop and Uninstall
+
+```bash
+# Delete the frontend and model service deployed by the Quick Start
+foretoken delete examples/quickstart
+
+# Uninstall the Foretoken platform
+foretoken uninstall
+```
+
+The uninstall command preserves Foretoken CRDs and reused cluster components. It removes the platform and the monitoring or Gateway resources managed by the command-line tool.
+
+## Related Projects
+
+- [vLLM](https://github.com/vllm-project/vllm)
+- [NVIDIA Dynamo](https://github.com/ai-dynamo/dynamo)
+- [llm-d](https://github.com/llm-d/llm-d)
+- [AIBrix](https://github.com/vllm-project/aibrix)
+- [vLLM Production Stack](https://github.com/vllm-project/production-stack)
+
+## Contributing
+
+Contributions of all kinds are welcome, including code, documentation, tests, design discussions, issue reports, and improvements to deployment, hardware, benchmarking, routing, and autoscaling.
+Performance-related changes should include the test setup, raw results, and reproducible commands.
+See [Contributing to Foretoken](CONTRIBUTING.md) for development principles, collaboration expectations, and the pull request workflow.
+
+Thank you to everyone who has contributed to Foretoken.
+
+<a href="https://github.com/shiweijiezero/foretoken/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=shiweijiezero/foretoken" alt="Foretoken contributors" />
+</a>
+
+## License
+
+This project is licensed under the [Apache License 2.0](LICENSE).

foretoken-0.0.1a1/benchmarks/__init__.py

@@ -0,0 +1,2 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright contributors to the Foretoken project