isagellm-core 0.1.0.2__cp311-none-any.whl → 0.1.0.3__cp311-none-any.whl

{isagellm_core-0.1.0.2.dist-info → isagellm_core-0.1.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: isagellm-core
-Version: 0.1.0.2
+Version: 0.1.0.3
 Summary: sageLLM core runtime (config/observability/registries), plugin-ready
 Author: IntelliStream Team
 License: Proprietary - IntelliStream
@@ -32,23 +32,15 @@ Requires-Dist: pre-commit>=3.0.0; extra == "dev"
 [![License](https://img.shields.io/github/license/intellistream/sagellm-core.svg)](https://github.com/intellistream/sagellm-core/blob/main/LICENSE)
 [![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
 
-core 只依赖协议与抽象，不直接 import 硬件 SDK。
+sageLLM Core - Engine runtime and configuration system for LLM inference.
 
-- 仓库名：`sagellm-core`
-- PyPI 包名：`isagellm-core`
-- import 名：`sagellm_core`
+## Features
 
-## 架构层级
-
-sagellm-core 位于 **Level 2**，依赖：
-- **Level 0**: `isagellm-protocol` (协议定义)
-- **Level 1**: `isagellm-backend` (后端抽象，包含 BackendProvider)
-
-为下游提供：
-- 配置体系（config.py）
-- Engine 抽象接口（engine.py）
-- 插件发现机制（plugins.py）
-- 工厂函数（factory.py）
+- 🔧 Flexible configuration system (YAML/JSON)
+- 🔌 Plugin-based backend and engine discovery
+- 🎯 Mock mode for development and testing
+- 📊 Built-in demo runner for benchmarking
+- ✅ Type-safe with Pydantic v2
 
 ## 安装
 
@@ -85,14 +77,7 @@ python -m sagellm_core.demo --mock --segments short
 > pip install -e ../sagellm-backend
 > ```
 
-## 插件发现（entry points）
-
-- backends：`sagellm.backends`（由 sagellm-backend 提供基础实现）
-- engines：`sagellm.engines`（由各 engine 包提供实现）
-
-core 在运行时扫描 entry points；当配置指定 kind 但未安装插件时必须 fail-fast，并给出安装提示。
-
-## 配置系统（Task0.02）
+## Configuration System
 
 ### 使用方法
 
@@ -107,20 +92,15 @@ backend = create_backend(config.backend)
 engine = create_engine(config.engine, backend)
 ```
 
-### 配置结构
+### Configuration Structure
 
-所有配置类均使用 pydantic v2 实现严格校验：
-- 缺失必填字段立即抛出 `ValidationError`
-- 未知字段被拒绝（`extra="forbid"`）
-- 数值约束被强制执行
-
-主要配置类：
-- `BackendConfig`: 后端设备配置（kind, device, device_ids）
-- `EngineConfig`: 推理引擎配置（kind, model, model_path, 等）
-- `WorkloadConfig`: 工作负载配置（segments, concurrency, kv_budget_tokens, 等）
-- `OutputConfig`: 输出配置（metrics_path, report_path, log_path, log_level）
-- `MockConfig`: 模拟模式配置（enable, fixed_latency_ms, jitter_ms, error_rate）
-- `DemoConfig`: 顶层配置（包含以上所有配置 + 特性开关）
+Main configuration components:
+- `BackendConfig`: Device and backend settings
+- `EngineConfig`: Inference engine configuration
+- `WorkloadConfig`: Workload parameters
+- `OutputConfig`: Output paths and logging
+- `MockConfig`: Mock mode settings for testing
+- `DemoConfig`: Top-level demo configuration
 
 ### 配置示例
 
@@ -224,18 +204,7 @@ output:
   report_path: ./output/report.md
 ```
 
-### 验收标准（Task0.08）
-
-- [x] `python -m sagellm_core.demo --help` 输出帮助信息
-- [x] `python -m sagellm_core.demo --config examples/demo_config.yaml --mock` 可运行
-- [x] 缺少 --config 参数时报错
-- [x] 配置文件不存在时报错
-- [x] 无效的 segment 值时报错
-- [x] `ruff check` 和 `mypy` 通过
-
-**注意**：实际 workload 执行逻辑在 task0_10 实现，当前阶段运行会输出 `NotImplementedError`。
-
-## 开发指南
+## Development Guide
 
 ### 快速开始
 
@@ -254,11 +223,9 @@ pre-commit install
 pytest tests/ -v
 ```
 
-### 质量保证体系
+### Testing and Quality
 
-sageLLM 实施三层质量保证：
-
-#### 1. Pre-commit Hooks（提交前自动检查）
+#### Pre-commit Hooks
 
 安装后，每次 `git commit` 会自动运行：
 - **Ruff**: 代码格式化 + Lint 检查
@@ -273,57 +240,34 @@ pre-commit run --all-files
 git commit --no-verify
 ```
 
-#### 2. 单元测试（本地验证）
+#### Running Tests
 
 ```bash
-# 运行所有测试
+# Run all tests
 pytest tests/ -v
 
-# 运行特定模块测试
+# Run specific test module
 pytest tests/unit/test_demo.py -v
-pytest tests/unit/test_config.py -v
 
-# 生成覆盖率报告
+# Generate coverage report
 pytest tests/ --cov=sagellm_core --cov-report=html
-open htmlcov/index.html
 ```
 
-测试要求：
-- ✅ 新功能必须有对应单元测试
-- ✅ 覆盖率不低于现有水平
-- ✅ 所有测试必须支持 mock 模式（无需 GPU）
-
-#### 3. CI/CD（自动化验证）
-
-每次 PR 触发 GitHub Actions 自动运行：
-- **Lint Job**: Ruff + Mypy 检查
-- **Test Job**: 多 Python 版本矩阵测试（3.10, 3.11, 3.12）
-- **Protocol Job**: 验证与 Protocol v0.1 对齐
-- **Build Job**: 验证包构建
+#### Continuous Integration
 
-查看 CI 状态：`.github/workflows/ci.yml`
+GitHub Actions automatically runs on each PR:
+- Code linting and formatting checks
+- Tests across Python 3.10, 3.11, 3.12
+- Package build verification
 
-### 代码规范
+### Code Style
 
-**核心原则**：
-1. **Protocol-first** - 修改接口前先升级 Protocol
-2. **Mock-first** - 所有模块支持 mock 模式
-3. **Fail-fast** - 禁止隐式默认值，配置错误立即报错
-4. **Type-safe** - 所有函数必须有类型注解
+This project uses:
+- **Ruff** for formatting and linting
+- **Mypy** for type checking
+- **Type hints** are required for all functions
 
-```python
-# ✅ 正确示例
-def create_backend(config: BackendConfig) -> BaseBackend:
-    if config.kind == "mock":
-        return MockBackend(config)
-    raise PluginResolutionError(f"Unknown backend: {config.kind}")
-
-# ❌ 错误示例
-def create_backend(config):  # 缺少类型注解
-    return MockBackend(config.get("kind", "mock"))  # 隐式默认值
-```
-
-详细规范参见 [CONTRIBUTING.md](CONTRIBUTING.md)
+For detailed guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md)
 
 ### 代码检查
 
@@ -348,19 +292,10 @@ pre-commit run --all-files
 - `isagellm-protocol>=0.1.0,<0.2.0`: 协议定义（Level 0）
 - `isagellm-backend>=0.1.0,<0.2.0`: 后端抽象（Level 1）
 
-## 依赖层级说明
+## Related Packages
 
-```
-Level 0: isagellm-protocol (最基础，无依赖)
-    ↓
-Level 1: isagellm-backend (依赖 protocol)
-    ↓
-Level 2: isagellm-core (依赖 protocol + backend) ← 当前包
-    ↓
-Level 3: 功能模块（依赖 protocol + backend + core）
-    ├─ isagellm-kv-cache
-    ├─ isagellm-comm
-    └─ isagellm-compression
-    ↓
-Level 4: isagellm-demo (依赖所有模块)
-```
+- `isagellm-protocol` - Protocol definitions
+- `isagellm-backend` - Backend abstraction layer
+- `isagellm` - Main package with CLI
+
+For more packages, see the [sageLLM ecosystem](https://github.com/intellistream/sagellm)

{isagellm_core-0.1.0.2.dist-info → isagellm_core-0.1.0.3.dist-info}/RECORD

@@ -1,5 +1,5 @@
-sagellm_core/__init__.py,sha256=LpmwcJlxM8ykr8CiVjF1P3KfjQnX-DlWC0z6cBdFbII,1318
-sagellm_core/__init__.pyc,sha256=Udt8y0HGtcHO-8ELYg_qX-FmAlhiJe__5RCursK7wCE,1462
+sagellm_core/__init__.py,sha256=tCd-s6qtnmcAlkTPIAPI6eVAv2VDpTv1x3BTIPmJksc,1318
+sagellm_core/__init__.pyc,sha256=1gOLrD7tMlJWBJfli9YCkaCz3ARTW6TOF1BV6sC9vjc,1462
 sagellm_core/__main__.pyc,sha256=4wEXHFB0JVZaI6wLACU59_b-LfEbujTQZyzONaalAYA,384
 sagellm_core/config.pyc,sha256=8gGOOBcHRSSv883bDIJNXzB069ntBc0yYEf-PFAeWdU,9617
 sagellm_core/demo.pyc,sha256=MAeTgokTW8kW906wjvTLN1yNLfOOl3_hokpVzJ-Lt4I,6377
@@ -11,7 +11,7 @@ sagellm_core/plugins.pyc,sha256=rhdewQ_zJxnmRFBjUozBlhQtIwFg0C1rFD8zMT7ZeKI,2618
 sagellm_core/py.typed,sha256=ixa8YukDZ3kLo0WsFJRGohLMyHzbMur1ALmmASML2cs,64
 sagellm_core/runner.pyc,sha256=kUPITl68dX1rOY5Fg5o6KRBMjMhMAQFNizEuRF44PgM,14248
 sagellm_core/workload.pyc,sha256=LDuZAdimFAd3pHn8E9WG7LjwU_1IKABZ-gaMCMjOTus,4118
-sagellm_core/__pycache__/__init__.cpython-311.pyc,sha256=R2nIc2MOizHOtAi3qteyJyfWIPxXbBQgZtp2jvYiJhg,1492
+sagellm_core/__pycache__/__init__.cpython-311.pyc,sha256=rD-1rR4IMX4lKJKlNtTrMkPLHY-rWF-S06ZjtGu1pQU,1492
 sagellm_core/__pycache__/config.cpython-311.pyc,sha256=4c_gjzVmxIRApzmUq8LCboOG3wPqmmwWVFxZS3JOHOg,9647
 sagellm_core/__pycache__/demo.cpython-311.pyc,sha256=yOMGCRRQigl8sclMTcg-iHThQoxrRTPWSUdgDYJ3hgU,6407
 sagellm_core/__pycache__/engine.cpython-311.pyc,sha256=6wUoB2Rz8YqoVpefE28b_vqxAozdXFiCYJZ_gn5Vi9A,614
@@ -26,7 +26,7 @@ sagellm_core/engines/__init__.pyc,sha256=F8_ZNvo0w79MF136pvCmRArLhPjae6uGsds7v9O
 sagellm_core/engines/mock.pyc,sha256=D0kWj50DsPdaZAM_2W-vyTW11ofNsSF02knRGtfKEJA,586
 sagellm_core/engines/__pycache__/__init__.cpython-311.pyc,sha256=Y36wU_L1T0NqaGBb-oqt38qVk38lunfTWTv5n-TkCLI,361
 sagellm_core/engines/__pycache__/mock.cpython-311.pyc,sha256=bt1MKmriqKcL_HF2gvQQ5JfxI-ij24G4fZvgFXjBAmM,616
-isagellm_core-0.1.0.2.dist-info/METADATA,sha256=nSW2I1mm63Y-KwzgrnbQmzglGjtRR3NcIHzehUZGj1w,9949
-isagellm_core-0.1.0.2.dist-info/WHEEL,sha256=ZJeWpR6hcCRGwxVKXlDk-HsGwijNyTq4fszaDj4Ycyo,93
-isagellm_core-0.1.0.2.dist-info/top_level.txt,sha256=wcgdWrvkaoYYh_dWSFI5Toi8PZsHutVqfhTB2tb0K6g,13
-isagellm_core-0.1.0.2.dist-info/RECORD,,
+isagellm_core-0.1.0.3.dist-info/METADATA,sha256=wKlVRTDAi3oqLa6FMZsxPRpjaU2j_O9DivkGDzqzjy0,7558
+isagellm_core-0.1.0.3.dist-info/WHEEL,sha256=ZJeWpR6hcCRGwxVKXlDk-HsGwijNyTq4fszaDj4Ycyo,93
+isagellm_core-0.1.0.3.dist-info/top_level.txt,sha256=wcgdWrvkaoYYh_dWSFI5Toi8PZsHutVqfhTB2tb0K6g,13
+isagellm_core-0.1.0.3.dist-info/RECORD,,

sagellm_core/__init__.py

@@ -27,7 +27,7 @@ from sagellm_core.health import HealthStatus
 from sagellm_core.plugins import PluginResolutionError, list_entry_points, resolve_kind
 from sagellm_core.runner import DemoRunner, RunnerContext
 
-__version__ = "0.1.0.2"
+__version__ = "0.1.0.3"
 
 __all__ = [
     # Version