Spaces:
Sleeping
Sleeping
File size: 32,844 Bytes
aab74bd 061655d aab74bd 751a180 aab74bd 061655d aab74bd efdf6de aab74bd efdf6de aab74bd efdf6de aab74bd efdf6de aab74bd 751a180 aab74bd | 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 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 | # Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
"""
Store Manager Environment Implementation.
A retail store simulator where an LLM agent acts as the store manager.
The agent can apply discounts, restock inventory, or move products between
shelf zones each step to maximise cumulative profit over a fixed episode horizon.
Episode dynamics:
- N products, each with a cost price, selling price, stock quantity,
expiry step, a base pick-probability weight, a shelf zone, and restock params.
- Each step the agent chooses one action:
- "discount": apply a discount (0/10/20/50%) to one product
- "restock": place a reorder for a product (delivered after lead_time steps)
- "place": move a product to a different shelf zone (1/2/3)
- Discounts are ephemeral β they apply only for the current step.
- Zone multiplier scales pick probability: zone 1 = 1.5x, 2 = 1.0x, 3 = 0.6x.
- 10 customers sample products per step; probabilities incorporate zone + discount.
- Holding cost is charged every step based on quantity on hand.
- Restock cost is charged upfront; stock arrives after lead_time steps.
- Placement cost is a flat labor fee per move.
- Reward = step_revenue - step_cost - expiry_penalty - holding_cost
- placement_cost - restock_cost.
- Expiry penalty = remaining_quantity * cost_price for each expired product.
- Episode ends after max_steps steps, or when all products are inactive.
"""
from __future__ import annotations
import sys
import os
# Ensure the project root (parent of server/) is on sys.path so that
# models.py and tasks.py are importable whether this file is run directly
# or imported as part of the package.
_ROOT = os.path.join(os.path.dirname(__file__), "..")
if _ROOT not in sys.path:
sys.path.insert(0, _ROOT)
import math
from typing import Any, Dict, List, Optional
from uuid import uuid4
import numpy as np
from openenv.core.env_server.interfaces import Environment
from models import (
ProductState,
StoremanagerAction,
StoremanagerObservation,
StoremanagerState,
)
try:
from tasks import TaskConfig
except ImportError:
TaskConfig = None # type: ignore[assignment,misc]
# ββ Curated product catalogue ββββββββββββββββββββββββββββββββββββββββββββββββββ
_PRODUCT_NAMES: List[str] = [
"Milk", "Bread", "Cheese", "Yogurt", "Juice", "Butter",
"Eggs", "Cream", "Honey", "Jam", "Soda", "Water",
"Tea", "Coffee", "Flour", "Rice",
]
# ββ Zone constants βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
ZONE_MULTIPLIERS: Dict[int, float] = {1: 1.5, 2: 1.0, 3: 0.6}
ZONE_CAPACITY: Dict[int, int] = {1: 2, 2: 4, 3: 99}
PLACEMENT_COST: float = 3.0 # flat labor fee per zone move
class StoremanagerEnvironment(Environment):
"""
Retail store manager RL environment.
The agent observes full inventory state and chooses one action per step:
apply a discount, place a restock order, or move a product to a better zone.
Args:
num_products: Number of distinct products in the store (default 8).
max_steps: Episode length in steps (default 30).
num_customers: Customers simulated per step (default 10).
seed: Optional base random seed for reproducible episodes.
"""
SUPPORTS_CONCURRENT_SESSIONS: bool = True
def __init__(
self,
task_config: Optional["TaskConfig"] = None, # type: ignore[name-defined]
num_products: int = 8,
max_steps: int = 30,
num_customers: int = 10,
seed: Optional[int] = None,
) -> None:
super().__init__()
if task_config is not None:
num_products = task_config.num_products
max_steps = task_config.max_steps
num_customers = task_config.num_customers
self._expiry_offset_min = task_config.expiry_offset_min
self._expiry_offset_max = task_config.expiry_offset_max
self._task_name = task_config.name
self._profit_target = task_config.profit_target
else:
self._expiry_offset_min = 8
self._expiry_offset_max = 25
self._task_name = "custom"
# Default: assume ~$8 average profit per step for custom configs
self._profit_target = 8.0 * max_steps
self._num_products = min(num_products, len(_PRODUCT_NAMES))
self._max_steps = max_steps
self._num_customers = num_customers
self._base_seed = seed
self._rng: np.random.Generator = np.random.default_rng(seed)
self._inventory: List[ProductState] = []
self._pending_orders: List[Dict[str, Any]] = []
self._current_step: int = 0
self._cumulative_profit: float = 0.0
self._state = StoremanagerState(
num_products=self._num_products,
max_steps=self._max_steps,
)
# ββ OpenEnv API βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def reset(
self,
seed: Optional[int] = None,
episode_id: Optional[str] = None,
**kwargs: Any,
) -> StoremanagerObservation:
"""Reset the store and generate a fresh inventory.
Accepts an optional ``task`` keyword argument to dynamically switch the
task configuration without restarting the server. This allows a single
server instance to serve all difficulty levels sequentially.
"""
# ββ Dynamic task reconfiguration ββββββββββββββββββββββββββββββββββββ
task_name = kwargs.get("task")
if task_name:
try:
from tasks import TASKS # local import to avoid circular deps
task_config = TASKS.get(task_name)
if task_config is not None:
self._num_products = min(task_config.num_products, len(_PRODUCT_NAMES))
self._max_steps = task_config.max_steps
self._num_customers = task_config.num_customers
self._expiry_offset_min = task_config.expiry_offset_min
self._expiry_offset_max = task_config.expiry_offset_max
self._task_name = task_config.name
self._profit_target = task_config.profit_target
except ImportError:
pass # tasks module unavailable; keep current config
self._reset_rubric()
effective_seed = seed if seed is not None else self._base_seed
self._rng = np.random.default_rng(effective_seed)
self._current_step = 0
self._cumulative_profit = 0.0
self._pending_orders = []
self._inventory = self._generate_inventory()
self._recompute_pick_probs()
self._update_state(episode_id=episode_id or str(uuid4()), last_reward=self._normalize_reward(0.0))
self._refresh_product_derived_fields()
return StoremanagerObservation(
inventory=list(self._inventory),
current_step=0,
max_steps=self._max_steps,
steps_remaining=self._max_steps,
cumulative_profit=0.0,
last_step_profit=0.0,
last_step_units_sold=0,
last_expired_products=[],
num_customers_per_step=self._num_customers,
task_name=self._task_name,
zone_capacity=dict(ZONE_CAPACITY),
zone_occupancy=self._zone_occupancy(),
zone_multipliers=dict(ZONE_MULTIPLIERS),
holding_cost_this_step=0.0,
placement_cost_this_step=0.0,
restock_cost_this_step=0.0,
unjustified_discount_penalty=0.0,
done=False,
reward=self._normalize_reward(0.0),
)
def step(
self,
action: StoremanagerAction,
timeout_s: Optional[float] = None,
**kwargs: Any,
) -> StoremanagerObservation:
"""Execute one step: process deliveries, apply action, simulate customers, handle expiry."""
# ββ 1. Validate product_id ββββββββββββββββββββββββββββββββββββββββββ
valid_ids = {p.product_id for p in self._inventory}
if action.product_id not in valid_ids:
return self._error_observation(
f"Invalid product_id {action.product_id}. "
f"Valid IDs: {sorted(valid_ids)}"
)
# ββ 2. Process pending deliveries βββββββββββββββββββββββββββββββββββ
delivered = [o for o in self._pending_orders if o["arrive_at_step"] <= self._current_step]
for order in delivered:
product = next((p for p in self._inventory if p.product_id == order["product_id"]), None)
if product is not None:
product.quantity += order["quantity"]
product.is_active = True
product.pending_restock_quantity = 0
product.pending_restock_arrives_at_step = None
self._pending_orders = [o for o in self._pending_orders if o["arrive_at_step"] > self._current_step]
# ββ 3. Compute holding cost (charged before action) βββββββββββββββββ
holding_cost = sum(
p.quantity * p.cost_price * p.holding_cost_rate
for p in self._inventory
if p.is_active and p.quantity > 0
)
# ββ 4. Reset per-step discount tracker (selling_price persists across steps) ββ
# current_discount_pct tracks only this step's discount for the pick-prob formula.
# selling_price is NOT reset β discounts compound: each action cuts the current price.
for product in self._inventory:
product.current_discount_pct = 0.0
# ββ 5. Dispatch action ββββββββββββββββββββββββββββββββββββββββββββββ
placement_cost = 0.0
restock_cost = 0.0
target = next(p for p in self._inventory if p.product_id == action.product_id)
if action.action_type == "discount":
if not target.is_active:
return self._error_observation(
f"Product '{target.name}' (id={target.product_id}) is no longer active "
f"(sold out or expired). Choose an active product to discount."
)
if target.quantity <= 0:
return self._error_observation(
f"Product '{target.name}' (id={target.product_id}) has no stock remaining."
)
target.current_discount_pct = float(action.discount_pct)
# Phase 1: dynamic expiry-aware price floor.
# Far from expiry: protect margin β floor at cost_price.
# Near expiry: allow progressive below-cost markdown to clear stock
# before the far-worse full expiry penalty hits.
steps_left = target.expiry_step - self._current_step
if steps_left >= 4:
price_floor = target.cost_price # full protection
elif steps_left == 3:
price_floor = round(target.cost_price * 0.70, 2) # 30% loss/unit max
elif steps_left == 2:
price_floor = round(target.cost_price * 0.40, 2) # 60% loss/unit max
else: # 1 step left
price_floor = round(target.cost_price * 0.10, 2) # 90% loss/unit max
target.selling_price = round(
max(price_floor, target.selling_price * (1.0 - action.discount_pct / 100.0)),
2,
)
# popularity_multiplier compounds up: repeated discounting makes the
# product progressively more visible/attractive to customers
if action.discount_pct > 0:
target.popularity_multiplier = round(
target.popularity_multiplier * (1.0 + action.discount_pct / 100.0), 6
)
elif action.action_type == "restock":
qty = action.restock_quantity
if qty is None or qty <= 0:
return self._error_observation(
f"restock_quantity must be a positive integer, got {qty!r}."
)
if target.expiry_step <= self._current_step:
return self._error_observation(
f"Product '{target.name}' (id={target.product_id}) has expired "
f"(expiry_step={target.expiry_step}, current_step={self._current_step}). "
f"Restocking an expired product wastes money β the stock would "
f"immediately re-expire and incur an expiry penalty."
)
if target.pending_restock_quantity > 0:
return self._error_observation(
f"Product '{target.name}' already has a pending restock order "
f"for {target.pending_restock_quantity} units arriving at step "
f"{target.pending_restock_arrives_at_step}. Wait for delivery first."
)
arrive_at = self._current_step + target.restock_lead_time
if arrive_at >= target.expiry_step:
return self._error_observation(
f"Restock order for '{target.name}' would arrive at step {arrive_at} "
f"but the product expires at step {target.expiry_step}. "
f"The delivered units would immediately expire and be penalized. "
f"Order cancelled to prevent wasted spend."
)
self._pending_orders.append({
"product_id": target.product_id,
"quantity": qty,
"arrive_at_step": arrive_at,
})
target.pending_restock_quantity = qty
target.pending_restock_arrives_at_step = arrive_at
restock_cost = qty * target.restock_cost_per_unit
elif action.action_type == "place":
zone = action.target_zone
if zone is None:
return self._error_observation("target_zone must be specified for 'place' actions.")
if zone == target.zone:
return self._error_observation(
f"Product '{target.name}' is already in zone {zone}."
)
# Count active products currently in the target zone (excluding this product)
occupants = sum(
1 for p in self._inventory
if p.is_active and p.zone == zone and p.product_id != target.product_id
)
if occupants >= ZONE_CAPACITY[zone]:
return self._error_observation(
f"Zone {zone} is at capacity ({ZONE_CAPACITY[zone]} products). "
f"Move another product out first."
)
target.zone = zone
placement_cost = PLACEMENT_COST
# ββ 6. Gather sellable products βββββββββββββββββββββββββββββββββββββ
active = [p for p in self._inventory if p.is_active and p.quantity > 0]
if not active:
done = True
self._update_state(last_reward=self._normalize_reward(0.0))
self._refresh_product_derived_fields()
return StoremanagerObservation(
inventory=list(self._inventory),
current_step=self._current_step,
max_steps=self._max_steps,
steps_remaining=max(0, self._max_steps - self._current_step),
cumulative_profit=self._cumulative_profit,
last_step_profit=0.0,
last_step_units_sold=0,
last_expired_products=[],
num_customers_per_step=self._num_customers,
task_name=self._task_name,
zone_capacity=dict(ZONE_CAPACITY),
zone_occupancy=self._zone_occupancy(),
zone_multipliers=dict(ZONE_MULTIPLIERS),
holding_cost_this_step=round(holding_cost, 4),
placement_cost_this_step=placement_cost,
restock_cost_this_step=round(restock_cost, 4),
unjustified_discount_penalty=0.0,
done=done,
reward=self._normalize_reward(0.0),
)
# ββ 7. Compute pick probabilities (zone + discount + popularity) ββββ
effective_weights = np.array([
p.base_probability
* ZONE_MULTIPLIERS[p.zone]
* (1.0 + p.current_discount_pct / 100.0)
* p.popularity_multiplier
for p in active
])
pick_probs = effective_weights / effective_weights.sum()
for product, prob in zip(active, pick_probs):
product.effective_pick_prob = round(float(prob), 6)
# ββ 8. Simulate customers βββββββββββββββββββββββββββββββββββββββββββ
chosen_ids = self._rng.choice(
a=[p.product_id for p in active],
size=self._num_customers,
p=pick_probs,
replace=True,
)
sales_counts: dict[int, int] = {}
for pid in chosen_ids:
sales_counts[pid] = sales_counts.get(int(pid), 0) + 1
# ββ 9. Apply sales (clamp by available quantity) ββββββββββββββββββββ
step_revenue = 0.0
step_cost = 0.0
units_sold_total = 0
unjustified_discount_penalty = 0.0
for product in active:
wanted = sales_counts.get(product.product_id, 0)
sold = min(wanted, product.quantity)
if sold > 0:
step_revenue += sold * product.selling_price
step_cost += sold * product.cost_price
product.quantity -= sold
units_sold_total += sold
product.sales_history.append(
{
"step": self._current_step,
"discount_pct": product.current_discount_pct,
"units_sold": sold,
}
)
# Phase 3: if selling below cost with no urgency, double the per-unit
# loss as an extra penalty β gives a sharp "this is bad" signal.
if product.selling_price < product.cost_price:
steps_left = product.expiry_step - self._current_step
if steps_left >= 4:
unjustified_discount_penalty += sold * (product.cost_price - product.selling_price)
if product.quantity == 0:
product.is_active = False
product.effective_pick_prob = 0.0
# ββ 10. Advance step counter ββββββββββββββββββββββββββββββββββββββββ
self._current_step += 1
# ββ 11. Check expiry ββββββββββββββββββββββββββββββββββββββββββββββββ
expiry_penalty = 0.0
expired_names: List[str] = []
for product in self._inventory:
if product.is_active and product.expiry_step <= self._current_step:
expiry_penalty += product.quantity * product.cost_price
expired_names.append(product.name)
product.is_active = False
product.quantity = 0
product.effective_pick_prob = 0.0
# ββ 12. Reward and cumulative profit ββββββββββββββββββββββββββββββββ
step_profit = (
step_revenue - step_cost - expiry_penalty
- holding_cost - placement_cost - restock_cost
- unjustified_discount_penalty
)
self._cumulative_profit += step_profit
# ββ 13. Terminal condition βββββββββββββββββββββββββββββββββββββββββββ
done = self._current_step >= self._max_steps or all(
not p.is_active for p in self._inventory
)
# ββ 14. State update and return βββββββββββββββββββββββββββββββββββββ
normalized_reward = self._normalize_reward(step_profit)
self._update_state(last_reward=normalized_reward)
self._refresh_product_derived_fields()
return StoremanagerObservation(
inventory=list(self._inventory),
current_step=self._current_step,
max_steps=self._max_steps,
steps_remaining=max(0, self._max_steps - self._current_step),
cumulative_profit=self._cumulative_profit,
last_step_profit=step_profit,
last_step_units_sold=units_sold_total,
last_expired_products=expired_names,
num_customers_per_step=self._num_customers,
task_name=self._task_name,
zone_capacity=dict(ZONE_CAPACITY),
zone_occupancy=self._zone_occupancy(),
zone_multipliers=dict(ZONE_MULTIPLIERS),
holding_cost_this_step=round(holding_cost, 4),
placement_cost_this_step=placement_cost,
restock_cost_this_step=round(restock_cost, 4),
unjustified_discount_penalty=round(unjustified_discount_penalty, 4),
done=done,
reward=normalized_reward,
metadata={
"step_revenue": round(step_revenue, 4),
"step_cost": round(step_cost, 4),
"expiry_penalty": round(expiry_penalty, 4),
"holding_cost": round(holding_cost, 4),
"placement_cost": placement_cost,
"restock_cost": round(restock_cost, 4),
"unjustified_discount_penalty": round(unjustified_discount_penalty, 4),
"step_profit": round(step_profit, 4),
},
)
@property
def state(self) -> StoremanagerState:
return self._state
# ββ Private helpers βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _normalize_reward(self, step_profit: float) -> float:
"""
Map raw step profit to a meaningful reward strictly in (0.001, 0.999) using a
sigmoid centered at break-even (step_profit = 0).
Formula:
x = step_profit / per_step_target (normalise by average needed per step)
reward = clamp(sigmoid(k * x), 0.001, 0.999)
Where k=2 gives a useful spread:
step_profit = 0 -> 0.50 (neutral, broke even)
step_profit = per_step_tgt -> 0.88 (on-track for target)
step_profit = 2*per_step_tgt -> 0.98 (excellent step)
step_profit = -per_step_tgt -> 0.12 (below break-even)
step_profit = -2*per_step_tgt -> 0.02 (large penalty step)
x is clamped to [-7, 7] to prevent math.exp() OverflowError on extreme
profits, and the result is clamped to (0.001, 0.999) to ensure the reward
is never exactly 0.0 or 1.0.
"""
per_step_target = self._profit_target / self._max_steps
x = step_profit / per_step_target if per_step_target != 0 else 0.0
x = max(-7.0, min(7.0, x))
raw = 1.0 / (1.0 + math.exp(-2.0 * x))
return round(max(0.001, min(0.999, raw)), 6)
def _zone_occupancy(self) -> Dict[int, int]:
"""Count active products in each zone."""
occupancy: Dict[int, int] = {1: 0, 2: 0, 3: 0}
for p in self._inventory:
if p.is_active and p.zone in occupancy:
occupancy[p.zone] += 1
return occupancy
def _refresh_product_derived_fields(self) -> None:
"""Recompute ephemeral derived fields on every product before returning an observation."""
for p in self._inventory:
p.steps_until_expiry = max(0, p.expiry_step - self._current_step)
p.margin_per_unit = round(p.selling_price - p.cost_price, 4)
def _recompute_pick_probs(self) -> None:
"""Recompute normalised pick probabilities for all active products (zone + popularity)."""
active = [p for p in self._inventory if p.is_active and p.quantity > 0]
if not active:
return
effs = np.array([
p.base_probability
* ZONE_MULTIPLIERS[p.zone]
* (1.0 + p.current_discount_pct / 100.0)
* p.popularity_multiplier
for p in active
])
probs = effs / effs.sum()
for product, prob in zip(active, probs):
product.effective_pick_prob = round(float(prob), 6)
def _generate_inventory(self) -> List[ProductState]:
"""Generate a randomised product inventory for a new episode."""
chosen_names = self._rng.choice(
_PRODUCT_NAMES, size=self._num_products, replace=False
)
# Draw base probability weights via Dirichlet, then rescale to [0.05, 0.4]
raw_probs = self._rng.dirichlet(alpha=[1.0] * self._num_products)
max_raw = raw_probs.max()
base_probs = 0.05 + raw_probs * (0.40 - 0.05) / max_raw
# Assign initial zones: fill zone 1 first (up to capacity), then zone 2, rest to zone 3
zone_slots = {z: ZONE_CAPACITY[z] for z in [1, 2, 3]}
product_zones: List[int] = []
for _ in range(self._num_products):
for zone in [1, 2, 3]:
if zone_slots[zone] > 0:
product_zones.append(zone)
zone_slots[zone] -= 1
break
inventory: List[ProductState] = []
for i in range(self._num_products):
cost = round(float(self._rng.uniform(1.0, 8.0)), 2)
margin = float(self._rng.uniform(1.3, 2.5))
selling = round(cost * margin, 2)
qty = int(self._rng.integers(15, 41))
expiry_offset = int(self._rng.integers(self._expiry_offset_min, self._expiry_offset_max + 1))
holding_rate = round(float(self._rng.uniform(0.01, 0.04)), 4)
restock_cost_per_unit = round(cost * float(self._rng.uniform(1.0, 1.25)), 2)
lead_time = int(self._rng.integers(1, 4)) # 1β3 steps
inventory.append(
ProductState(
product_id=i,
name=str(chosen_names[i]),
cost_price=cost,
selling_price=selling,
base_selling_price=selling,
quantity=qty,
expiry_step=self._current_step + expiry_offset,
base_probability=float(base_probs[i]),
current_discount_pct=0.0,
is_active=True,
sales_history=[],
zone=product_zones[i],
holding_cost_rate=holding_rate,
restock_cost_per_unit=restock_cost_per_unit,
restock_lead_time=lead_time,
pending_restock_quantity=0,
pending_restock_arrives_at_step=None,
popularity_multiplier=1.0,
)
)
return inventory
def _update_state(
self,
*,
episode_id: Optional[str] = None,
last_reward: float = 0.0,
) -> None:
"""Sync the internal StoremanagerState with current environment data."""
if episode_id is not None:
self._state.episode_id = episode_id
self._state.step_count = self._current_step
self._state.num_products = self._num_products
self._state.max_steps = self._max_steps
self._state.cumulative_profit = self._cumulative_profit
self._state.last_reward = last_reward
self._state.active_product_count = sum(
1 for p in self._inventory if p.is_active
)
self._state.inventory_snapshot = [p.model_dump() for p in self._inventory]
def _error_observation(self, message: str) -> StoremanagerObservation:
"""Return an observation flagging an invalid action (step does NOT advance)."""
self._refresh_product_derived_fields()
return StoremanagerObservation(
inventory=list(self._inventory),
current_step=self._current_step,
max_steps=self._max_steps,
steps_remaining=max(0, self._max_steps - self._current_step),
cumulative_profit=self._cumulative_profit,
last_step_profit=0.0,
last_step_units_sold=0,
last_expired_products=[],
num_customers_per_step=self._num_customers,
task_name=self._task_name,
zone_capacity=dict(ZONE_CAPACITY),
zone_occupancy=self._zone_occupancy(),
zone_multipliers=dict(ZONE_MULTIPLIERS),
holding_cost_this_step=0.0,
placement_cost_this_step=0.0,
restock_cost_this_step=0.0,
unjustified_discount_penalty=0.0,
done=False,
reward=self._normalize_reward(0.0),
error=message,
)
# ββ Standalone smoke test βββββββββββββββββββββββββββββββββββββββββββββββββββββ
if __name__ == "__main__":
env = StoremanagerEnvironment(num_products=4, max_steps=6, seed=42)
obs = env.reset()
print("=== RESET ===")
for p in obs.inventory:
print(f" [{p.product_id}] {p.name:10s} zone={p.zone} qty={p.quantity} "
f"lead={p.restock_lead_time} hold_rate={p.holding_cost_rate:.3f}")
print(f" Zone occupancy: {obs.zone_occupancy}")
actions = [
StoremanagerAction(action_type="discount", product_id=0, discount_pct=20),
StoremanagerAction(action_type="restock", product_id=1, restock_quantity=10),
StoremanagerAction(action_type="place", product_id=2, target_zone=1),
StoremanagerAction(action_type="place", product_id=3, target_zone=1), # should fail β zone 1 at capacity
StoremanagerAction(action_type="discount", product_id=0, discount_pct=10),
StoremanagerAction(action_type="discount", product_id=1, discount_pct=0),
]
for step_num, action in enumerate(actions):
obs = env.step(action)
print(f"\n=== STEP {step_num + 1} ({action.action_type.upper()}) ===")
if obs.error:
print(f" ERROR: {obs.error}")
else:
print(f" Reward: {obs.reward:.2f}")
print(f" Holding cost: {obs.holding_cost_this_step:.4f}")
print(f" Placement cost: {obs.placement_cost_this_step:.2f}")
print(f" Restock cost: {obs.restock_cost_this_step:.4f}")
print(f" Cumulative: {obs.cumulative_profit:.2f}")
print(f" Zone occupancy: {obs.zone_occupancy}")
if obs.last_expired_products:
print(f" Expired: {obs.last_expired_products}")
if obs.done:
print(" Episode done.")
break
|