flowmesh 0.1.0__py3-none-any.whl

flowmesh-0.1.0.dist-info/METADATA

@@ -0,0 +1,212 @@
+Metadata-Version: 2.4
+Name: flowmesh
+Version: 0.1.0
+Summary: FlowMesh: A Multi-tenant Service Fabric for LLM Agentic Workflows
+License-Expression: Apache-2.0
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: sdk
+Requires-Dist: flowmesh-sdk==0.1.0; extra == "sdk"
+Provides-Extra: cli
+Requires-Dist: flowmesh-cli[stack]==0.1.0; extra == "cli"
+Provides-Extra: hook
+Requires-Dist: flowmesh-hook==0.1.0; extra == "hook"
+Provides-Extra: all
+Requires-Dist: flowmesh-cli[stack]==0.1.0; extra == "all"
+Requires-Dist: flowmesh-hook==0.1.0; extra == "all"
+Requires-Dist: flowmesh-sdk==0.1.0; extra == "all"
+Dynamic: license-file
+
+# FlowMesh
+
+[![arXiv](https://img.shields.io/badge/arXiv-2510.26913-b31b1b.svg)](https://arxiv.org/abs/2510.26913)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![Lint](https://github.com/mlsys-io/FlowMesh/actions/workflows/lint-typecheck.yml/badge.svg)](https://github.com/mlsys-io/FlowMesh/actions/workflows/lint-typecheck.yml)
+[![Tests](https://github.com/mlsys-io/FlowMesh/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/mlsys-io/FlowMesh/actions/workflows/unit-tests.yml)
+
+A service fabric for running LLM agentic workflows on distributed GPU workers.
+
+FlowMesh accepts workflow definitions (YAML, JSON, or n8n graph format), parses
+them into a DAG of tasks, schedules and dispatches each task to a suitable
+worker, and collects results and artifacts. It supports inference (vLLM, HF
+transformers, diffusers), training (SFT, LoRA, DPO, PPO), retrieval-augmented
+generation, agent execution, SSH-style interactive sessions, and arbitrary
+container jobs.
+
+## Architecture
+
+```
+Client (CLI / SDK / HTTP)
+    │
+    ▼  HTTP (default 8000)
+┌─────────────────────────────────────────────────┐
+│ Server  (FastAPI orchestrator)                  │
+│   • workflow parsing, DAG resolution            │
+│   • task scheduling and dispatch                │
+│   • result and artifact collection              │
+│   • REST API + SSE log streaming                │
+└──────────────┬──────────────────────────────────┘
+               │  Redis pub/sub  (control + telemetry)
+               ▼
+┌─────────────────────────────────────────────────┐
+│ Supervisor  (per-node agent)                    │
+│   • registers node, manages worker containers   │
+│   • relays tasks/events via gRPC streams        │
+└──────────────┬──────────────────────────────────┘
+               │  gRPC (default 50051)
+               ▼
+┌─────────────────────────────────────────────────┐
+│ Worker  (executor process)                      │
+│   • vllm, transformers, diffusers, training,    │
+│     RAG, agent, SSH, echo, data profiling       │
+│   • streams logs and events back via gRPC       │
+└─────────────────────────────────────────────────┘
+```
+
+Server and Worker are the two top-level processes. The **Supervisor** is a
+subsystem that lives under `src/server/` and runs as a child process spawned
+from the server (`multiprocessing.Process`); single-node deployments spawn
+one supervisor child alongside the server, multi-node deployments run a root
+server plus one supervisor-only server process per worker node.
+
+## Quick start
+
+Requires Docker, Docker Compose, and Python 3.12+. If you want to use GPU
+workers, ensure the NVIDIA Container Toolkit is also installed.
+
+```bash
+# 1. Install
+git clone https://github.com/mlsys-io/FlowMesh.git
+cd FlowMesh
+pip install uv
+uv sync --all-packages --group ci
+
+# 2. Bring up the local stack (Server + Redis + Supervisor)
+uv run flowmesh stack up
+
+# 3. Start one CPU worker
+uv run flowmesh stack worker up cpu 1
+
+# 4. Submit a workflow
+uv run flowmesh workflow submit examples/templates/echo_local.yaml
+
+# 5. Watch it run
+uv run flowmesh workflow list
+uv run flowmesh workflow watch <workflow_id>
+```
+
+For a GPU worker:
+
+```bash
+# Pin to specific GPUs (or 'all')
+uv run flowmesh stack worker up gpu --targets 0
+```
+
+For inference templates:
+
+```bash
+uv run flowmesh workflow submit examples/templates/inference_vllm_chat.yaml
+uv run flowmesh workflow submit examples/templates/inference_hf_chat.yaml
+```
+
+Tear down:
+
+```bash
+uv run flowmesh stack worker down all
+uv run flowmesh stack down
+```
+
+## Workflow format
+
+A minimal single-task workflow:
+
+```yaml
+apiVersion: flowmesh/v1
+kind: InferenceTask
+metadata:
+  name: hello-inference
+spec:
+  taskType: inference
+  resources:
+    hardware: { gpu: { type: any, count: 1 } }
+  model:
+    source: { type: huggingface, identifier: TinyLlama/TinyLlama-1.1B-Chat-v1.0 }
+    vllm: { gpu_memory_utilization: 0.5 }
+  data:
+    type: list
+    items:
+      - - role: user
+          content: What is the capital of France?
+  inference: { max_tokens: 64, temperature: 0.0 }
+  output:
+    destination: { type: http }
+```
+
+Multi-stage DAGs, conditional execution, graph-template prompts, task merging,
+and SSH sessions are all supported. See `examples/templates/` for end-to-end examples
+and `AGENTS.md` for the full schema reference.
+
+## Extending FlowMesh
+
+FlowMesh exposes plugin hooks for organisations that want to layer additional
+auth, submission policy, usage tracking, authorisation, supplier attribution,
+or resource lifecycle behaviour on top of the core server. Install the
+standalone hook contract with:
+
+```bash
+pip install "flowmesh[hook]"
+```
+
+A plugin is any Python module that exposes `install()` returning
+`flowmesh_hook.HookBindings`. Plugins are loaded by setting
+`FLOWMESH_PLUGINS` to a comma-separated list of importable module names.
+Plugins can ship as in-tree modules, sibling-mounted packages, or
+pip-installable wheels — the core never references plugin names.
+
+See [`docs/PLUGINS.md`](docs/PLUGINS.md) for the full plugin contract.
+
+## Development
+
+```bash
+# Install dev tooling
+uv sync --all-packages --group ci
+
+# Format / lint / type-check
+uv run pre-commit run --all-files
+
+# Tests — skip the multiprocessing GPU-cleanup test because it requires a
+# real CUDA device and isolated processes; CI also skips it.
+uv run pytest tests/ --ignore=tests/worker/test_mp_executor_cleanup_gpu.py
+```
+
+Detailed contributor docs (project layout, env vars, dispatch internals,
+executor registry, commit-message conventions) live in `AGENTS.md`.
+
+## Contributing
+
+We welcome bug fixes, new features, documentation improvements, and feedback.
+Please read [`CONTRIBUTING.md`](CONTRIBUTING.md) for the contributor setup,
+code style, testing, dependency-pin, and DCO sign-off conventions, and
+[`AGENTS.md`](AGENTS.md) for a deeper architecture and source-layout tour.
+
+## Citation
+
+If you use FlowMesh in your research, please cite:
+
+```bibtex
+@misc{shen2025flowmesh,
+      title={FlowMesh: A Service Fabric for Composable LLM Workflows}, 
+      author={Junyi Shen and Noppanat Wadlom and Lingfeng Zhou and Dequan Wang and Xu Miao and Lei Fang and Yao Lu},
+      year={2025},
+      eprint={2510.26913},
+      archivePrefix={arXiv},
+      primaryClass={cs.DC},
+      url={https://arxiv.org/abs/2510.26913}, 
+}
+```
+
+## License
+
+Apache License 2.0. See [`LICENSE`](LICENSE).

flowmesh-0.1.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+flowmesh-0.1.0.dist-info/licenses/LICENSE,sha256=2EOx4I-Cg1n3uvZXvAloS16odfAVttXTP2QInPjb5og,11351
+flowmesh-0.1.0.dist-info/METADATA,sha256=H5IzX7iMJtVcoLOUPqTkgWXHbTA8d4Sl9qaExWPiMYY,7878
+flowmesh-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+flowmesh-0.1.0.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+flowmesh-0.1.0.dist-info/RECORD,,

flowmesh-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

flowmesh-0.1.0.dist-info/licenses/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 2026 The FlowMesh Authors
+
+   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.

flowmesh-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+