swarm-engine-core 0.1.6

Core types and orchestration for SwarmEngine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

//! # SwarmEngine Core
//!
//! A general-purpose foundation for high-throughput, low-latency agent swarm processing.
//!
//! ## Design Philosophy
//!
//! - Game engine-like architecture, specialized for agent swarms
//! - Tick-driven execution (10ms intervals) for stable operation
//! - Long-running support (24+ hours)
//! - Zero-copy, lock-free design
//!
//! ## Core Concepts
//!
//! ### Two-Tier Memory Model
//!
//! - **SharedState**: Read-only shared region accessed by all workers
//! - **WorkerStates**: Per-worker persistent state (optimized for parallel access)
//!
//! ### Tick Lifecycle
//!
//! ```text
//! Tick N
//! ├─ 1. Collect Async Results
//! ├─ 2. Read Phase (Scheduler)
//! ├─ 3. Execute Phase (Workers)
//! ├─ 4. Merge Phase
//! ├─ 5. Tick++
//! └─ 6. Wait for next tick
//! ```
//!
//! ## SwarmApp
//!
//! `SwarmApp` is an integrated application container providing:
//!
//! - **Unified Runtime**: Easy-to-use interface wrapping the Orchestrator
//! - **External Control**: Control from outside via `tick()` / `inject_state()` etc.
//! - **Hierarchical Hook System**: 4-layer intervention at Tick / Manager / Worker / Action
//! - **Effect System**: Declarative expression of hook side effects
//! - **Extensions**: Bevy-style dynamic resource management
//!
//! ```ignore
//! use swarm_engine_core::app::prelude::*;
//!
//! let app = SwarmApp::<()>::builder()
//!     .config(AppConfig::default())
//!     .workers(workers)
//!     .tick_hook(LoggingTickHook::new())
//!     .build(runtime.handle().clone())?;
//!
//! let outcome = app.run();
//! ```

pub mod actions;
pub mod agent;
pub mod analysis;
// pub mod app;  // TODO: Orchestrator 安定後に再統合
pub mod async_task;
pub mod config;
pub mod context;
pub mod debug;
pub mod environment;
pub mod error;
pub mod events;
pub mod exploration;
pub mod extensions;
pub mod learn;
pub mod online_stats;
pub mod orchestrator;
pub mod pipeline;
pub mod snapshot;
pub mod state;
pub mod telemetry;
pub mod types;
pub mod util;
pub mod validation;

/// Prelude - commonly used types for convenient import
pub mod prelude {
    pub use crate::actions::{
        ActionDef, ActionGroup, ActionValidationError, ActionsConfig, ParamDef,
    };
    pub use crate::agent::{
        BatchDecisionRequest, DecisionResponse, Guidance, ManagementDecision, ManagementStrategy,
        ManagerAgent, ManagerId, Priority, ScheduledAction, TaskContext, WorkResult, WorkerAgent,
        WorkerDecisionRequest,
    };
    pub use crate::async_task::{AsyncTask, AsyncTaskResult, AsyncTaskSystem, TaskStatus};
    pub use crate::config::{GlobalConfig, PathResolver};
    pub use crate::environment::{DefaultEnvironment, Environment, EnvironmentBox};
    pub use crate::error::SwarmError;
    pub use crate::events::{
        create_action_event_publisher, ActionContext, ActionEvent, ActionEventBuilder,
        ActionEventId, ActionEventPublisher, ActionEventResult, JsonlWriter,
    };
    pub use crate::extensions::Extensions;
    pub use crate::online_stats::{
        ActionStats, DumpableStats, GlobalStats, StatsSubscriber, SwarmStats,
    };
    pub use crate::orchestrator::{Orchestrator, OrchestratorBuilder, SwarmConfig, SwarmResult};
    pub use crate::snapshot::{
        CompactFormatter, ConsoleFormatter, JsonFormatter, SnapshotFormatter, SnapshotOutput,
    };
    pub use crate::state::{
        ActionResultSnapshot, Escalation, EscalationReason, ManagerPhaseSnapshot, SharedState,
        SwarmState, TickSnapshot, WorkResultSnapshot, WorkerResultSnapshot, WorkerState,
        WorkerStates,
    };
    pub use crate::types::{
        Action, ActionParams, ActionResult, AgentId, GroupId, SwarmTask, TaskId, WorkerId,
    };

    // Debug
    pub use crate::debug::{DebugSnapshot, Dumpable, StderrDumpSubscriber, TickDumper};

    // Pipeline
    pub use crate::pipeline::{
        DebounceTransform, EventSink, EventSource, EventTransform, LearningSink,
        LocalFileWatcherSource, PassthroughTransform, Pipeline, WatchEvent,
    };

    // Validation
    pub use crate::validation::{
        Absolute, Improvement, NoRegression, ValidationResult, ValidationStrategy, Validator,
    };
}