shared-tensor 0.1.0__tar.gz

shared_tensor-0.1.0/LICENSE

@@ -0,0 +1,181 @@
+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 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
+(which shall not include communications that are clearly marked or
+otherwise designated in writing by the copyright owner as "Not a Contribution").
+
+"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."
+
+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 use, reproduce, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Work, and to
+permit persons to whom the Work is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Work.
+
+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, trademark, patent, 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 notice 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 Support. You may choose to offer,
+and charge a fee for, warranty, support, 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 support.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2024 Athena Team
+
+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.

shared_tensor-0.1.0/MANIFEST.in

@@ -0,0 +1,30 @@
+# Include the README and LICENSE files
+include README.md
+include LICENSE
+
+# Include all files in the shared_tensor package
+recursive-include shared_tensor *.py
+recursive-include shared_tensor *.so *.dll *.dylib
+
+# Include scripts
+include scripts/start_server.sh
+
+# Exclude test files and examples from the distribution
+exclude tests/*
+exclude examples/*
+recursive-exclude tests *
+recursive-exclude examples *
+
+# Exclude development files
+exclude .gitignore
+exclude .git/*
+exclude __pycache__/*
+recursive-exclude * __pycache__
+recursive-exclude * *.pyc
+recursive-exclude * *.pyo
+recursive-exclude * .DS_Store
+
+# Exclude build artifacts
+exclude build/*
+exclude dist/*
+exclude *.egg-info/*

shared_tensor-0.1.0/PKG-INFO

@@ -0,0 +1,420 @@
+Metadata-Version: 2.4
+Name: shared-tensor
+Version: 0.1.0
+Summary: A library for sharing GPU memory objects across processes using IPC mechanisms
+Author-email: Athena Team <contact@world-sim-dev.org>
+Maintainer-email: Athena Team <contact@world-sim-dev.org>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/world-sim-dev/shared-tensor
+Project-URL: Repository, https://github.com/world-sim-dev/shared-tensor
+Project-URL: Documentation, https://github.com/world-sim-dev/shared-tensor/wiki
+Project-URL: Bug Reports, https://github.com/world-sim-dev/shared-tensor/issues
+Project-URL: Changelog, https://github.com/world-sim-dev/shared-tensor/releases
+Keywords: gpu,memory,sharing,ipc,inter-process-communication,pytorch,tensorflow,cuda,model-serving,inference,distributed-computing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Hardware :: Symmetric Multi-processing
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch>=1.12.0
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: requests>=2.25.0
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.0; extra == "dev"
+Requires-Dist: black>=22.0; extra == "dev"
+Requires-Dist: flake8>=4.0; extra == "dev"
+Requires-Dist: isort>=5.0; extra == "dev"
+Requires-Dist: mypy>=0.950; extra == "dev"
+Requires-Dist: pre-commit>=2.0.0; extra == "dev"
+Requires-Dist: build>=0.8.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest>=6.0; extra == "test"
+Requires-Dist: pytest-cov>=2.0; extra == "test"
+Requires-Dist: pytest-benchmark>=3.0; extra == "test"
+Requires-Dist: pytest-asyncio>=0.20.0; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx>=4.0.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "docs"
+Requires-Dist: myst-parser>=0.18.0; extra == "docs"
+Dynamic: license-file
+
+# Shared Tensor
+
+[![Python Version](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://python.org)
+[![PyTorch](https://img.shields.io/badge/PyTorch-1.12%2B-orange.svg)](https://pytorch.org)
+[![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](LICENSE)
+
+A high-performance library for sharing GPU memory objects across processes using IPC mechanisms with JSON-RPC 2.0 protocol, enabling model and inference engine separation architecture.
+
+## 🚀 Project Overview
+
+Shared Tensor is a cross-process communication library designed specifically for deep learning and AI applications, utilizing IPC mechanisms and JSON-RPC protocol to achieve:
+
+- **Efficient GPU Memory Sharing**: Cross-process sharing of PyTorch tensors and models
+- **Remote Function Execution**: Easy remote function calls through decorators
+- **Async/Sync Support**: Flexible execution modes for different scenarios
+- **Model Serving**: Deploy machine learning models as independent services
+- **Distributed Inference**: Support for distributed computing in multi-GPU environments
+
+## 📋 Core Features
+
+### 🔄 Cross-Process Communication
+- **JSON-RPC 2.0 Protocol**: Standardized remote procedure calls
+- **HTTP Transport**: Reliable HTTP-based communication mechanism
+- **Serialization Optimization**: Efficient PyTorch object serialization/deserialization
+
+### 🎯 Function Sharing
+- **Decorator Pattern**: Easy function sharing using `@provider.share`
+- **Auto Discovery**: Smart function path resolution and import
+- **Parameter Passing**: Support for complex data type parameters
+
+### ⚡ Async Support
+- **Async Execution**: `AsyncSharedTensorProvider` supports non-blocking calls
+- **Task Management**: Complete async task status tracking
+- **Concurrent Processing**: Efficient concurrent request handling
+
+### 🖥️ GPU Compatibility
+- **CUDA Support**: Native CUDA tensor sharing support
+- **Device Management**: Smart data migration between devices
+- **Memory Optimization**: Efficient GPU memory usage
+
+## 🛠️ Installation Guide
+
+### Requirements
+
+- **Python**: 3.8+
+- **Operating System**: Linux (recommended)
+- **PyTorch**: 1.12.0+
+- **CUDA**: Optional, for GPU support
+
+### Installation Methods
+
+#### Install from Source
+
+```bash
+# Clone the repository
+git clone https://github.com/world-sim-dev/shared-tensor.git
+cd shared-tensor
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Install the package
+pip install -e .
+```
+
+#### Development Installation
+
+```bash
+# Install with development dependencies
+pip install -e ".[dev]"
+
+# Install with test dependencies
+pip install -e ".[test]"
+```
+
+### Verify Installation
+
+```bash
+# Check core functionality
+python -c "import shared_tensor; print('✓ Shared Tensor installed successfully')"
+```
+
+## 🎯 Quick Start
+
+### 1. Basic Function Sharing
+
+```python
+from shared_tensor.async_provider import AsyncSharedTensorProvider
+
+# Create provider
+provider = AsyncSharedTensorProvider()
+
+# Share simple function
+@provider.share()
+def add_numbers(a, b):
+    return a + b
+
+# Share PyTorch function
+@provider.share()
+def create_tensor(shape):
+    import torch
+    return torch.zeros(shape)
+
+# Load PyTorch model
+@provider.share()
+def load_model():
+    ...
+
+```
+
+### 2. Start Server
+
+```bash
+# Method 1: Use command line tool, single server
+shared-tensor-server
+
+# Method 2: Use torchrun
+torchrun --nproc_per_node=4 --no-python shared-tensor-server
+
+# Method 3: Custom configuration
+python shared_tensor/server.py
+```
+
+
+## 📖 Detailed Usage
+
+### Model Sharing Example
+
+```python
+import torch
+import torch.nn as nn
+
+from shared_tensor.async_provider import AsyncSharedTensorProvider
+
+# Create provider
+provider = AsyncSharedTensorProvider()
+
+# Define model
+class SimpleNet(nn.Module):
+    def __init__(self, input_size, hidden_size, output_size):
+        super().__init__()
+        self.fc1 = nn.Linear(input_size, hidden_size)
+        self.relu = nn.ReLU()
+        self.fc2 = nn.Linear(hidden_size, output_size)
+    
+    def forward(self, x):
+        x = self.fc1(x)
+        x = self.relu(x)
+        x = self.fc2(x)
+        return x
+
+# Share model creation function
+@provider.share(name="create_model")
+def create_model(input_size=784, hidden_size=128, output_size=10):
+    model = SimpleNet(input_size, hidden_size, output_size)
+    return model
+
+# Share inference function
+model = create_model()
+with torch.no_grad():
+    model(input_data)
+```
+
+## 🔧 Configuration Options
+
+### Server Configuration
+
+```python
+from shared_tensor.server import SharedTensorServer
+
+server = SharedTensorServer(
+    host="0.0.0.0",           # Listen address
+    port=2537,                # Port number
+    timeout=30,               # Request timeout
+    max_workers=4,            # Maximum worker threads
+    enable_cache=True,        # Enable result caching
+    debug=False               # Debug mode
+)
+```
+
+## 🧪 Testing
+
+### Run Test Suite
+
+```bash
+# Run all tests
+python tests/run_tests.py
+
+# Run specific category tests
+python tests/run_tests.py --category unit
+python tests/run_tests.py --category integration
+python tests/run_tests.py --category pytorch
+
+# Run only PyTorch related tests
+python tests/run_tests.py --torch-only
+
+# Verbose output
+python tests/run_tests.py --verbose
+```
+
+### Test Environment Info
+
+```bash
+# Check test environment
+python tests/run_tests.py --env-info
+```
+
+### Individual Test Files
+
+```bash
+# Test tensor serialization
+python tests/pytorch_tests/test_tensor_serialization.py
+
+# Test async system
+python tests/integration/test_async_system.py
+
+# Test client
+python tests/integration/test_client.py
+```
+
+## 🏗️ Architecture Design
+
+### Core Components
+
+```
+shared-tensor/
+├── shared_tensor/              # Core modules
+│   ├── server.py              # JSON-RPC server
+│   ├── client.py              # Sync client
+│   ├── provider.py            # Sync provider
+│   ├── async_client.py        # Async client
+│   ├── async_provider.py      # Async provider
+│   ├── async_task.py          # Async task management
+│   ├── jsonrpc.py            # JSON-RPC protocol implementation
+│   ├── utils.py              # Utility functions
+│   └── errors.py             # Exception definitions
+├── examples/                  # Usage examples
+└── tests/                     # Test suite
+```
+
+### Communication Flow
+
+```mermaid
+sequenceDiagram
+    participant CA as Client App
+    participant SC as SharedTensorClient
+    participant SS as SharedTensorServer
+    participant FE as Function Executor
+    
+    Note over CA, FE: Client-Server Communication Flow
+    
+    CA->>SC: call_function("model_inference", args)
+    SC->>SC: Serialize parameters
+    SC->>SS: HTTP POST /jsonrpc<br/>JSON-RPC Request
+    
+    Note over SS: Server Processing
+    SS->>SS: Parse JSON-RPC request
+    SS->>SS: Resolve function path
+    SS->>FE: Import & execute function
+    FE->>FE: Deserialize parameters
+    FE->>FE: Execute function logic
+    FE->>SS: Return execution result
+    
+    Note over SS: Response Preparation
+    SS->>SS: Serialize result
+    SS->>SS: Create JSON-RPC response
+    SS->>SC: HTTP Response<br/>JSON-RPC Result
+    
+    Note over SC: Client Processing
+    SC->>SC: Parse response
+    SC->>SC: Deserialize result
+    SC->>CA: Return final result
+    
+    Note over CA, FE: End-to-End Process Complete
+```
+
+### Debug Tips
+
+1. **Enable verbose logging**:
+```python
+import logging
+logging.basicConfig(level=logging.DEBUG)
+```
+
+2. **Use debug mode**:
+```python
+provider = SharedTensorProvider(verbose_debug=True)
+```
+
+3. **Check function paths**:
+```python
+provider = SharedTensorProvider()
+print(provider._registered_functions)
+```
+
+## 🤝 Contributing
+
+We welcome community contributions! Please follow these steps:
+
+### Development Environment Setup
+
+```bash
+# Clone repository
+git clone https://github.com/world-sim-dev/shared-tensor.git
+cd shared-tensor
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate
+
+# Install development dependencies
+pip install -e ".[dev]"
+
+# Install pre-commit hooks
+pre-commit install
+
+# Package & Publish
+python setup.py sdist bdist_wheel
+python -m twine upload --repository testpypi dist/*
+python -m twine upload dist/*
+```
+
+### Code Standards
+
+```bash
+# Code formatting
+black shared_tensor/ tests/ examples/
+
+# Import sorting
+isort shared_tensor/ tests/ examples/
+
+# Static checking
+flake8 shared_tensor/
+mypy shared_tensor/
+```
+
+### Submission Process
+
+1. Fork the project and create a feature branch
+2. Write code and tests
+3. Run the complete test suite
+4. Submit a Pull Request
+
+### Test Requirements
+
+- New features must include tests
+- Maintain test coverage > 90%
+- All tests must pass
+
+## 📄 License
+
+This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details
+
+## 🙏 Acknowledgments
+
+- [PyTorch](https://pytorch.org/) - Deep learning framework
+- [JSON-RPC 2.0](https://www.jsonrpc.org/) - Remote procedure call protocol
+
+## 📞 Contact Us
+
+- **Issues**: [GitHub Issues](https://github.com/world-sim-dev/shared-tensor/issues)
+- **Documentation**: [Shared Tensor Documentation](https://github.com/world-sim-dev/shared-tensor/wiki)
+- **Source**: [GitHub Repository](https://github.com/world-sim-dev/shared-tensor)
+
+---
+
+**Shared Tensor** - Making GPU memory sharing simple and efficient 🚀