@pikaa-ai/pikaa 0.3.23 → 0.3.25

package/skills/simpy/SKILL.md

@@ -1,283 +0,0 @@
----
-name: simpy
-description: Build, inspect, test, and analyze bounded process-based discrete-event simulations with SimPy, including events, resources, interrupts, monitoring, replications, warm-up, and reproducible output analysis.
-license: MIT
-compatibility: Upstream SimPy 4.1.2 supports Python 3.8+; bundled CLIs require Python 3.10+, uv, and SimPy 4.1.2. They use only SimPy and the standard library, operate on local bounded inputs, and make no network calls.
-allowed-tools: Read Write Edit Bash Glob
-metadata:
-  version: "1.2"
-  skill-author: K-Dense Inc.
----
-
-# SimPy
-
-## Scope
-
-Use this skill for process-based discrete-event models where active entities yield
-events and contend for resources: queues, production systems, logistics, networks,
-service operations, inventory, and other event-driven systems.
-
-SimPy supplies an event scheduler and modeling primitives. It does **not** choose a
-scientifically valid conceptual model, input distribution, warm-up, run length,
-replication count, estimand, or causal interpretation. Treat those as simulation-study
-methodology, not SimPy API behavior.
-
-## Current release and installation
-
-Verified **2026-07-23**:
-
-- Latest stable: **SimPy 4.1.2**, released on PyPI 2026-05-24; source tag
-  `4.1.2` points to commit `f4381649`.
-- Package metadata requires Python **>=3.8** and classifies CPython 3.8-3.14
-  plus PyPy. SimPy has no runtime dependencies.
-- 4.1.2 adds Python 3.13/3.14 support and modern-interpreter test fixes.
-- Upstream and this skill are MIT-licensed.
-
-Create a reproducible environment:
-
-```bash
-uv venv --python 3.13
-source .venv/bin/activate
-uv pip install "simpy==4.1.2"
-python -c "import importlib.metadata; print(importlib.metadata.version('simpy'))"
-```
-
-Do not silently substitute the `latest` documentation build: it may describe an
-unreleased development revision. Use the versioned 4.1.2 links in
-`references/sources.md`.
-
-## Model workflow
-
-1. **Define purpose and estimands.** State the decision/question, system boundary,
-   entities, resources, state, outputs, time units, and terminating event or
-   steady-state target.
-2. **Write a conceptual model first.** Record assumptions, distributions,
-   routing, priorities, initial conditions, and omitted mechanisms.
-3. **Implement generators.** A SimPy process is an event-yielding Python generator.
-   Register the generator object with `env.process(...)`.
-4. **Bound execution.** Give every production run explicit time, entity, event, and
-   replication caps. Never call `env.run()` on a model containing an endless process.
-5. **Separate random streams.** Use local RNG instances for logically distinct
-   stochastic sources; retain a seed manifest.
-6. **Instrument deliberately.** Observe state after the transition of interest,
-   close time-weighted intervals at the horizon, and test that monitoring does not
-   alter event order.
-7. **Verify and validate.** Test deterministic edge cases, conservation identities,
-   traces, queue discipline, and analytical benchmarks; compare against system or
-   expert evidence for the stated purpose.
-8. **Run independent replications.** Make intervals from replication-level
-   estimates, not correlated entities within one run.
-9. **Report limitations.** Include initialization, unfinished entities, run length,
-   seeds/streams, precision, sensitivity, and validation evidence. Never convert
-   simulation association into a causal claim.
-
-Read `references/simulation-methodology.md` before making inferential claims.
-
-## Minimal bounded model
-
-```python
-import random
-import simpy
-
-HORIZON = 480.0
-arrival_rng = random.Random(101)
-service_rng = random.Random(202)
-env = simpy.Environment()
-server = simpy.Resource(env, capacity=2)
-completed = []
-
-def customer(arrival):
-    with server.request() as request:
-        yield request
-        wait = env.now - arrival
-        yield env.timeout(service_rng.expovariate(1 / 6.0))
-    completed.append((env.now, wait))
-
-def arrivals():
-    for _ in range(10_000):  # Entity cap.
-        delay = arrival_rng.expovariate(1 / 4.0)
-        if env.now + delay >= HORIZON:
-            return
-        yield env.timeout(delay)
-        env.process(customer(env.now))
-
-env.process(arrivals())
-env.run(until=HORIZON)
-```
-
-The numeric horizon is half-open: normal events scheduled exactly at `480.0` are
-not processed. Report unfinished entities rather than silently treating them as
-completed observations.
-
-## Core semantics
-
-### Environment and deterministic ordering
-
-`Environment` is single-threaded. The queue is ordered by simulation time, event
-priority, then a strictly increasing event ID. Same-time, same-priority events are
-therefore processed FIFO in scheduling order. Model processes may represent
-concurrency, but callbacks execute sequentially and deterministically.
-
-- `env.now`: unitless simulation clock; choose and document one unit.
-- `env.peek()`: next event time or infinity.
-- `env.step()`: process one event; raises `EmptySchedule` when empty.
-- `env.active_process`: currently executing process, otherwise `None`.
-- `env.run()`: drain the queue; unsafe with recurring or endless processes.
-
-`env.run(until=number)` and `env.run(until=event)` are not interchangeable at
-boundaries:
-
-- A numeric value schedules an urgent stop event and excludes ordinary events at
-  that exact time.
-- An Event criterion returns that event's value when its stop callback fires.
-  Other same-time ordering depends on priority and scheduling order.
-- In 4.1.2, `Environment.step()` preserves callbacks remaining after
-  `StopSimulation` by rescheduling the target. Consequently, after
-  `env.run(until=target)`, `target.processed` can remain `False` until one more
-  `step()`/`run()` even though its value was returned. Do not use `processed` as the
-  sole post-run completion test.
-
-See `references/events.md` and `references/monitoring.md`.
-
-### Event, Timeout, Process, and Condition
-
-- An `Event` moves once through not-triggered -> triggered/scheduled -> processed.
-  `succeed(value)` or `fail(exception)` triggers it once.
-- A `Timeout` triggers when created, is scheduled for `now + delay`, and cannot be
-  manually succeeded again.
-- `env.process(generator)` creates a `Process`; the generator resumes with the
-  yielded event value. Returning from the generator succeeds the Process with that
-  return value. Uncaught exceptions fail it.
-- `AnyOf` / `a | b` and `AllOf` / `a & b` yield a `ConditionValue`: an ordered,
-  dict-like mapping from **event objects** to their values. Test membership using
-  the original event objects; do not assume a scalar result.
-- `AnyOf` does not cancel losing events. Explicitly cancel pending resource
-  requests when abandoning them; ordinary timeouts remain scheduled.
-
-### Interrupts
-
-`process.interrupt(cause)` schedules an urgent interruption that throws
-`simpy.Interrupt` into the target generator. Catch it around the yielded work that
-may be interrupted, inspect `interrupt.cause`, update remaining work, then either
-resume, re-yield the original event, or terminate.
-
-Interrupting a process removes its resume callback from its current target; it does
-not cancel that target event. A process cannot interrupt itself or a terminated
-process. See `references/process-interaction.md`.
-
-## Shared resources
-
-| Type | Semantics |
-|---|---|
-| `Resource` | FIFO semaphore-like usage slots |
-| `PriorityResource` | Queued requests sorted by lower numeric priority first |
-| `PreemptiveResource` | Priority queue plus optional preemption of a current user |
-| `Container` | Homogeneous numeric level; `put`/`get` wait for capacity/material |
-| `Store` | FIFO Python objects |
-| `FilterStore` | First available item satisfying the request's predicate |
-| `PriorityStore` | Comparable items returned in priority order |
-
-Use a request context manager:
-
-```python
-def job(env, resource):
-    with resource.request() as request:
-        yield request
-        yield env.timeout(3)
-```
-
-On exit it releases an acquired request or cancels a still-pending one, including
-during exception unwinding. For a manually retained pending `put`/`get`/request,
-call `cancel()` if an interrupt or timeout makes the process abandon it.
-
-`PreemptiveResource.request(priority=..., preempt=True)` uses lower numbers as
-higher priority. The preempted process receives an `Interrupt` whose cause is a
-`Preempted` object: `cause.by` is the preempting Process,
-`cause.usage_since` is when use began, and `cause.resource` is the resource.
-Queued priority takes precedence over the `preempt` flag; mixing preempting and
-non-preempting requests needs explicit tests.
-
-Read `references/resources.md` for blocked operations, queue rules, and examples.
-
-## Monitoring and stepping
-
-Prefer explicit domain observations at state transitions. For generic resource
-monitoring, wrappers or subclasses can inspect `count`, `queue`, `level`, `items`,
-`put_queue`, and `get_queue`. For event tracing, `schedule()` and `step()` are the
-central hooks.
-
-Queue measurements are timing-sensitive:
-
-- A request method's pre-state, post-call state, grant callback, and release
-  callback can all differ at the same simulation timestamp.
-- Sample averages weight event observations, not time. Compute area under the
-  left-continuous state path and divide by elapsed time.
-- Add initial and final samples; close the last interval at the analysis horizon.
-- `env._queue`, resource `_env`, and monkey-patching are implementation details.
-  Pin SimPy, isolate the instrumentation, and regression-test after upgrades.
-- Tracing every event changes runtime and memory use; cap trace records.
-
-Use `scripts/resource_monitor.py` and `references/monitoring.md`.
-
-## Real-time execution
-
-`simpy.rt.RealtimeEnvironment(initial_time=0, factor=1.0, strict=True)` maps one
-simulation unit to `factor` wall-clock seconds. In strict mode, `step()`/`run()`
-raises `RuntimeError` when computation falls behind. `strict=False` tolerates lag;
-it does not restore timing accuracy. Develop logic with `Environment`, then run
-separate timing tests with generous platform-aware tolerances. See
-`references/real-time.md`.
-
-## Bundled safe CLIs
-
-All CLIs use a fixed built-in queue model or summarize local artifacts. They reject
-unknown JSON keys, URLs, symlinks, non-finite numbers, oversized inputs, and
-unbounded time/events/entities/replications. They never evaluate config text,
-execute user Python, import plugins, or call a network service.
-
-```bash
-# Inspect all options.
-python skills/simpy/scripts/bounded_queue_scenario.py --help
-python skills/simpy/scripts/replication_runner.py --help
-python skills/simpy/scripts/event_trace_summary.py --help
-python skills/simpy/scripts/validate_simulation_config.py --help
-
-# Deterministic built-in scenario.
-python skills/simpy/scripts/bounded_queue_scenario.py
-
-# Independent replications with replication-level Student-t intervals.
-python skills/simpy/scripts/replication_runner.py
-
-# Validate only; no simulation runs.
-python skills/simpy/scripts/validate_simulation_config.py config.json
-```
-
-The replication runner refuses one-replication intervals. Its intervals quantify
-Monte Carlo uncertainty under the configured model; they neither validate the model
-nor identify causal effects. See `references/cli-guide.md`.
-
-## Testing
-
-Use deterministic unit tests for ordering, boundary times, conditions, interrupts,
-all resource disciplines, conservation, event/entity limits, seed reproducibility,
-and monitor non-interference. Add stochastic tests only as broad distributional
-checks with fixed seeds; avoid brittle exact sample estimates.
-
-Run the skill's suite in the exact pinned environment without bytecode artifacts:
-
-```bash
-PYTHONDONTWRITEBYTECODE=1 uv run --isolated --no-project \
-  --python 3.13 --with "simpy==4.1.2" \
-  python -m unittest discover -s tests/simpy -v
-```
-
-## References
-
-- `references/events.md` — scheduler, lifecycle, run boundaries, conditions
-- `references/process-interaction.md` — generators, shared events, interrupts
-- `references/resources.md` — all Resource, Container, and Store variants
-- `references/monitoring.md` — time weighting, queue timing, tracing, stepping
-- `references/real-time.md` — factor, strict mode, drift, timing tests
-- `references/simulation-methodology.md` — replications, warm-up, validation, CI
-- `references/cli-guide.md` — schemas, bounds, outputs, and safe CLI examples
-- `references/sources.md` — dated official and primary-method sources

package/skills/stable-baselines3/SKILL.md

@@ -1,325 +0,0 @@
----
-name: stable-baselines3
-description: Production-ready reinforcement learning algorithms (PPO, SAC, DQN, TD3, DDPG, A2C) with scikit-learn-like API. Use for standard RL experiments, quick prototyping, and well-documented algorithm implementations. Best for single-agent RL with Gymnasium environments. For high-performance parallel training, multi-agent systems, or custom vectorized environments, use pufferlib instead.
-license: MIT license
-allowed-tools: Read Write Edit Bash
-compatibility: Requires Python 3.10+, PyTorch >= 2.3, and stable-baselines3 2.8+. Gymnasium environments; optional extras for TensorBoard and Atari (ale-py).
-metadata:
-  version: "1.2"
-  skill-author: K-Dense Inc.
----
-
-# Stable Baselines3
-
-## Overview
-
-Stable Baselines3 (SB3) is a PyTorch-based library providing reliable implementations of reinforcement learning algorithms. This skill provides comprehensive guidance for training RL agents, creating custom environments, implementing callbacks, and optimizing training workflows using SB3's unified API.
-
-**Current upstream:** SB3 **2.8.0** (April 2026). Docs: [stable-baselines3.readthedocs.io](https://stable-baselines3.readthedocs.io/en/master/).
-
-## Installation
-
-Tested against **stable-baselines3 2.8.0**. Requires **Python 3.10+** (3.9 dropped in 2.8.0) and **PyTorch >= 2.3**.
-
-```bash
-# Basic installation
-uv pip install "stable-baselines3>=2.8"
-
-# With extra dependencies (TensorBoard, ale-py for Atari, etc.)
-uv pip install "stable-baselines3[extra]>=2.8"
-```
-
-On zsh, quote brackets: `uv pip install 'stable-baselines3[extra]>=2.8'`.
-
-For MuJoCo continuous-control benchmarks:
-
-```bash
-uv pip install "gymnasium[mujoco]"
-```
-
-Check your version:
-
-```python
-import stable_baselines3
-print(stable_baselines3.__version__)
-```
-
-## Related Projects
-
-- **[SB3-Contrib](https://github.com/Stable-Baselines-Team/stable-baselines3-contrib)**: experimental algorithms (MaskablePPO, CrossQ, QR-DQN, RecurrentPPO) — separate `sb3-contrib` package
-- **[RL Baselines3 Zoo](https://github.com/DLR-RM/rl-baselines3-zoo)**: pre-trained agents, hyperparameters, training scripts
-- **[SBX](https://github.com/araffin/sbx)**: SB3 + JAX implementations for users who prefer JAX over PyTorch
-
-## Core Capabilities
-
-### 1. Training RL Agents
-
-**Basic Training Pattern:**
-
-```python
-import gymnasium as gym
-from stable_baselines3 import PPO
-
-# Create environment
-env = gym.make("CartPole-v1")
-
-# Initialize agent (device="cpu" is often faster for MlpPolicy on small envs)
-model = PPO("MlpPolicy", env, verbose=1)
-
-# Train the agent
-model.learn(total_timesteps=10000)
-
-# Save the model
-model.save("ppo_cartpole")
-
-# Load the model (without prior instantiation)
-model = PPO.load("ppo_cartpole", env=env)
-```
-
-**Important Notes:**
-- `total_timesteps` is a lower bound; actual training may exceed this due to batch collection
-- Use `model.load()` as a static method, not on an existing instance
-- The replay buffer is NOT saved with the model to save space
-
-**Algorithm Selection:**
-Use `references/algorithms.md` for detailed algorithm characteristics and selection guidance. Quick reference:
-- **PPO/A2C**: General-purpose, supports all action space types, good for multiprocessing
-- **SAC/TD3**: Continuous control, off-policy, sample-efficient
-- **DQN**: Discrete actions, off-policy
-- **HER**: Goal-conditioned tasks
-
-See `scripts/train_rl_agent.py` for a complete training template with best practices.
-
-### 2. Custom Environments
-
-**Requirements:**
-Custom environments must inherit from `gymnasium.Env` and implement:
-- `__init__()`: Define action_space and observation_space
-- `reset(seed, options)`: Return initial observation and info dict
-- `step(action)`: Return observation, reward, terminated, truncated, info
-- `render()`: Visualization (optional)
-- `close()`: Cleanup resources
-
-**Key Constraints:**
-- Image observations must be `np.uint8` in range [0, 255]
-- Use channel-first format when possible (channels, height, width)
-- SB3 normalizes images automatically by dividing by 255
-- Set `normalize_images=False` in policy_kwargs if pre-normalized
-- SB3 does NOT support `Discrete` or `MultiDiscrete` spaces with `start!=0`
-
-**Validation:**
-```python
-from stable_baselines3.common.env_checker import check_env
-
-check_env(env, warn=True)
-```
-
-See `scripts/custom_env_template.py` for a complete custom environment template and `references/custom_environments.md` for comprehensive guidance.
-
-### 3. Vectorized Environments
-
-**Purpose:**
-Vectorized environments run multiple environment instances in parallel, accelerating training and enabling certain wrappers (frame-stacking, normalization).
-
-**Types:**
-- **DummyVecEnv**: Sequential execution on current process (for lightweight environments)
-- **SubprocVecEnv**: Parallel execution across processes (for compute-heavy environments)
-
-**Quick Setup:**
-```python
-from stable_baselines3.common.env_util import make_vec_env
-
-# Create 4 parallel environments
-env = make_vec_env("CartPole-v1", n_envs=4, vec_env_cls=SubprocVecEnv)
-
-model = PPO("MlpPolicy", env, verbose=1)
-model.learn(total_timesteps=25000)
-```
-
-**Off-Policy Optimization:**
-When using multiple environments with off-policy algorithms (SAC, TD3, DQN), set `gradient_steps=-1` to perform one gradient update per environment step, balancing wall-clock time and sample efficiency.
-
-**API Differences:**
-- `reset()` returns only observations (info available in `vec_env.reset_infos`)
-- `step()` returns 4-tuple: `(obs, rewards, dones, infos)` not 5-tuple
-- Environments auto-reset after episodes
-- Terminal observations available via `infos[env_idx]["terminal_observation"]`
-
-See `references/vectorized_envs.md` for detailed information on wrappers and advanced usage.
-
-### 4. Callbacks for Monitoring and Control
-
-**Purpose:**
-Callbacks enable monitoring metrics, saving checkpoints, implementing early stopping, and custom training logic without modifying core algorithms.
-
-**Common Callbacks:**
-- **EvalCallback**: Evaluate periodically and save best model
-- **CheckpointCallback**: Save model checkpoints at intervals
-- **StopTrainingOnRewardThreshold**: Stop when target reward reached
-- **ProgressBarCallback**: Display training progress with timing
-
-**Custom Callback Structure:**
-```python
-from stable_baselines3.common.callbacks import BaseCallback
-
-class CustomCallback(BaseCallback):
-    def _on_training_start(self):
-        # Called before first rollout
-        pass
-
-    def _on_step(self):
-        # Called after each environment step
-        # Return False to stop training
-        return True
-
-    def _on_rollout_end(self):
-        # Called at end of rollout
-        pass
-```
-
-**Available Attributes:**
-- `self.model`: The RL algorithm instance
-- `self.num_timesteps`: Total environment steps
-- `self.training_env`: The training environment
-
-**Chaining Callbacks:**
-```python
-from stable_baselines3.common.callbacks import CallbackList
-
-callback = CallbackList([eval_callback, checkpoint_callback, custom_callback])
-model.learn(total_timesteps=10000, callback=callback)
-```
-
-See `references/callbacks.md` for comprehensive callback documentation.
-
-### 5. Model Persistence and Inspection
-
-**Saving and Loading:**
-```python
-# Save model
-model.save("model_name")
-
-# Save normalization statistics (if using VecNormalize)
-vec_env.save("vec_normalize.pkl")
-
-# Load model
-model = PPO.load("model_name", env=env)
-
-# Load normalization statistics
-vec_env = VecNormalize.load("vec_normalize.pkl", vec_env)
-```
-
-**Parameter Access:**
-```python
-# Get parameters
-params = model.get_parameters()
-
-# Set parameters
-model.set_parameters(params)
-
-# Access PyTorch state dict
-state_dict = model.policy.state_dict()
-```
-
-### 6. Evaluation and Recording
-
-**Evaluation:**
-```python
-from stable_baselines3.common.evaluation import evaluate_policy
-
-mean_reward, std_reward = evaluate_policy(
-    model,
-    env,
-    n_eval_episodes=10,
-    deterministic=True
-)
-```
-
-**Video Recording:**
-```python
-from stable_baselines3.common.vec_env import VecVideoRecorder
-
-# Wrap environment with video recorder
-env = VecVideoRecorder(
-    env,
-    "videos/",
-    record_video_trigger=lambda x: x % 2000 == 0,
-    video_length=200
-)
-```
-
-See `scripts/evaluate_agent.py` for a complete evaluation and recording template.
-
-### 7. Advanced Features
-
-**Learning Rate Schedules:**
-```python
-def linear_schedule(initial_value):
-    def func(progress_remaining):
-        # progress_remaining goes from 1 to 0
-        return progress_remaining * initial_value
-    return func
-
-model = PPO("MlpPolicy", env, learning_rate=linear_schedule(0.001))
-```
-
-**Multi-Input Policies (Dict Observations):**
-```python
-model = PPO("MultiInputPolicy", env, verbose=1)
-```
-Use when observations are dictionaries (e.g., combining images with sensor data).
-
-**Hindsight Experience Replay:**
-```python
-from stable_baselines3 import SAC, HerReplayBuffer
-
-model = SAC(
-    "MultiInputPolicy",
-    env,
-    replay_buffer_class=HerReplayBuffer,
-    replay_buffer_kwargs=dict(
-        n_sampled_goal=4,
-        goal_selection_strategy="future",
-    ),
-)
-```
-
-**TensorBoard Integration:**
-```python
-model = PPO("MlpPolicy", env, tensorboard_log="./tensorboard/")
-model.learn(total_timesteps=10000)
-```
-
-## Workflow Guidance
-
-**Starting a New RL Project:**
-
-1. **Define the problem**: Identify observation space, action space, and reward structure
-2. **Choose algorithm**: Use `references/algorithms.md` for selection guidance
-3. **Create/adapt environment**: Use `scripts/custom_env_template.py` if needed
-4. **Validate environment**: Always run `check_env()` before training
-5. **Set up training**: Use `scripts/train_rl_agent.py` as starting template
-6. **Add monitoring**: Implement callbacks for evaluation and checkpointing
-7. **Optimize performance**: Consider vectorized environments for speed
-8. **Evaluate and iterate**: Use `scripts/evaluate_agent.py` for assessment
-
-**Common Issues:**
-
-- **Memory errors**: Reduce `buffer_size` for off-policy algorithms or use fewer parallel environments
-- **Slow training**: Consider SubprocVecEnv for parallel environments
-- **Unstable training**: Try different algorithms, tune hyperparameters, or check reward scaling
-- **Import errors**: Ensure `stable_baselines3` is installed: `uv pip install 'stable-baselines3[extra]>=2.8'`
-
-## Resources
-
-### scripts/
-- `train_rl_agent.py`: Complete training script template with best practices
-- `evaluate_agent.py`: Agent evaluation and video recording template
-- `custom_env_template.py`: Custom Gym environment template
-
-### references/
-- `algorithms.md`: Detailed algorithm comparison and selection guide
-- `custom_environments.md`: Comprehensive custom environment creation guide
-- `callbacks.md`: Complete callback system reference
-- `vectorized_envs.md`: Vectorized environment usage and wrappers
-