Spaces:
Sleeping
Sleeping
File size: 36,503 Bytes
d627dc7 | 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 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 | """
server/data_cleaning_env.py
---------------------------
DataCleaningEnvironment β the heart of the environment.
Implements the three abstract methods from openenv.core.env_server.interfaces.Environment:
reset(seed, episode_id, **kwargs) -> CleanObservation
step(action, timeout_s, **kwargs) -> CleanObservation
state (property) -> CleanState
Architecture
------------
Live DataFrames (_dirty_df, _clean_df) live as instance variables for speed.
CleanState holds lightweight CSV snapshots used only for WebSocket state()
responses β not for every step. This avoids serialising a 400-row DataFrame
on every call.
Action dispatch
---------------
Each CleanAction.command routes to a private _apply_* method that mutates
_dirty_df in place. Errors in those methods (bad column name, out-of-bounds
row) are caught and returned as (success=False, error_msg=...) so the agent
gets corrective feedback instead of a 500.
Reward
------
compute_reward() implements the dense reward formula designed in the plan:
progress term β grader score delta (main signal)
efficiency bonus β small reward for early completion
false-positive penalty β for dropping a valid-extreme row (medium task)
early-DONE penalty β for calling DONE with a low score
step cost β -0.005 every step to discourage padding
"""
from __future__ import annotations
import sys
import os
from typing import Any, Optional
from uuid import uuid4
import numpy as np
import pandas as pd
# ββ OpenEnv imports (try relative β absolute) βββββββββββββββββββββββββββββββββ
try:
from openenv.core.env_server.interfaces import Environment
from openenv.core.env_server.types import EnvironmentMetadata
except ImportError:
from openenv.core.env_server.interfaces import Environment
from openenv.core.env_server.types import EnvironmentMetadata
# ββ Local imports (try relative β absolute for both server and standalone) βββ
try:
from ..models import (
CleanAction, CleanObservation, CleanState,
MAX_STEPS, DONE_THRESHOLD,
)
from ..dataset_factory import make_dataset, TaskDataset
from ..graders import grade, GradeResult
except ImportError:
try:
from models import (
CleanAction, CleanObservation, CleanState,
MAX_STEPS, DONE_THRESHOLD,
)
from dataset_factory import make_dataset, TaskDataset
from graders import grade, GradeResult
except ImportError:
sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
from models import (
CleanAction, CleanObservation, CleanState,
MAX_STEPS, DONE_THRESHOLD,
)
from dataset_factory import make_dataset, TaskDataset
from graders import grade, GradeResult
# ββ Constants βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# Per-step cost that discourages infinite loops / padding
STEP_COST = -0.005
# Penalty for calling DONE before the score is reasonable
EARLY_DONE_PENALTY = -0.20
EARLY_DONE_THRESHOLD = 0.60 # DONE below this score triggers the penalty
# Penalty for removing a valid-extreme row in the medium task
FALSE_POSITIVE_PENALTY = -0.15
# Efficiency bonus multiplier (only awarded when episode is solved)
EFFICIENCY_BONUS_WEIGHT = 0.10
# Date formats the STANDARDIZE_COL handler will try, in priority order
_DATE_PARSE_FORMATS = [
"%Y-%m-%d", # ISO β most reliable, try first
"%m/%d/%Y", # US
"%d.%m.%Y", # EU
"%d/%m/%Y", # EU alt
"%Y/%m/%d", # Asian
]
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# DataCleaningEnvironment
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
class DataCleaningEnvironment(Environment):
"""
Gym-style environment for the data cleaning pipeline task.
Each episode:
1. reset(task_id="easy"|"medium"|"hard") loads a dirty/clean CSV pair.
2. The agent calls step() repeatedly, each time sending a CleanAction.
3. The episode ends when the agent sends DONE, the score crosses the
task threshold, or the step budget is exhausted.
The environment is fully stateless between sessions β all mutable state
lives in instance variables, so concurrent sessions each get their own
isolated copy (SUPPORTS_CONCURRENT_SESSIONS = True).
"""
SUPPORTS_CONCURRENT_SESSIONS = True
def __init__(self) -> None:
super().__init__()
# Live DataFrames β mutated by each step()
self._dirty_df: Optional[pd.DataFrame] = None
self._clean_df: Optional[pd.DataFrame] = None
# Full task dataset from dataset_factory (holds metadata for grader)
self._dataset: Optional[TaskDataset] = None
# Pydantic state (lightweight; updated on demand)
self._state: Optional[CleanState] = None
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# reset()
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def reset(
self,
seed: Optional[int] = None,
episode_id: Optional[str] = None,
task_id: str = "easy",
**kwargs: Any,
) -> CleanObservation:
"""
Reset the environment for a new episode.
Parameters
----------
seed
Ignored β datasets use fixed seeds per task for reproducibility.
episode_id
Optional; auto-generated if not provided.
task_id
Which task to load: "easy", "medium", or "hard".
"""
if task_id not in MAX_STEPS:
raise ValueError(
f"Unknown task_id {task_id!r}. Must be one of: {list(MAX_STEPS)}"
)
# Load dataset (always deterministic via fixed seed in dataset_factory)
self._dataset = make_dataset(task_id)
self._dirty_df = self._dataset.dirty_df.copy(deep=True)
self._clean_df = self._dataset.clean_df.copy(deep=True)
max_steps = MAX_STEPS[task_id]
# Run grader on the initial dirty state so we have a starting score
initial_result = grade(
task_id=task_id,
agent_df=self._dirty_df,
clean_df=self._clean_df,
metadata=self._dataset.metadata,
initial_dirty_cells=self._dataset.total_dirty_cells,
)
self._state = CleanState(
episode_id=episode_id or str(uuid4()),
step_count=0,
task_id=task_id,
dirty_csv_snapshot=self._df_to_csv(self._dirty_df),
clean_csv_snapshot=self._df_to_csv(self._clean_df),
initial_dirty_cells=self._dataset.total_dirty_cells,
current_score=initial_result.score,
previous_score=0.0,
task_metadata=self._dataset.metadata,
schema_hint=self._dataset.schema_hint,
max_steps=max_steps,
)
return self._build_observation(
reward=None,
done=False,
last_action_success=True,
last_action_error=None,
grader_result=initial_result,
)
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# step()
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def step(
self,
action: CleanAction,
timeout_s: Optional[float] = None,
**kwargs: Any,
) -> CleanObservation:
"""
Apply one CleanAction and return the resulting observation.
Never raises for bad action inputs β instead returns
last_action_success=False with a descriptive error message so the
agent can self-correct on the next step.
"""
if self._state is None or self._dirty_df is None:
raise RuntimeError("Environment not initialised. Call reset() first.")
self._state.step_count += 1
# ββ Save previous score before mutating ββββββββββββββββββββββββββββββ
prev_score = self._state.current_score
self._state.previous_score = prev_score
# ββ DONE shortcut ββββββββββββββββββββββββββββββββββββββββββββββββββββ
if action.command == "DONE":
reward = self._compute_reward(
action=action,
prev_score=prev_score,
curr_score=prev_score, # score doesn't change on DONE
action_success=True,
was_false_positive=False,
)
done = True
self._state.dirty_csv_snapshot = self._df_to_csv(self._dirty_df)
return self._build_observation(
reward=reward,
done=done,
last_action_success=True,
last_action_error=None,
grader_result=GradeResult(
score=prev_score,
issues_remaining=self._state.initial_dirty_cells
- int(prev_score * self._state.initial_dirty_cells),
detail="Agent signalled DONE.",
),
)
# ββ Apply action to _dirty_df ββββββββββββββββββββββββββββββββββββββββ
action_success, error_msg, was_false_positive = self._apply_action(action)
# ββ Grade the result ββββββββββββββββββββββββββββββββββββββββββββββββββ
grader_result = grade(
task_id=self._state.task_id,
agent_df=self._dirty_df,
clean_df=self._clean_df,
metadata=self._state.task_metadata,
initial_dirty_cells=self._state.initial_dirty_cells,
)
curr_score = grader_result.score
self._state.current_score = curr_score
# ββ Compute reward ββββββββββββββββββββββββββββββββββββββββββββββββββββ
reward = self._compute_reward(
action=action,
prev_score=prev_score,
curr_score=curr_score,
action_success=action_success,
was_false_positive=was_false_positive,
)
# ββ Check termination ββββββββββββββββββββββββββββββββββββββββββββββββ
done = (
curr_score >= DONE_THRESHOLD[self._state.task_id]
or self._state.step_count >= self._state.max_steps
)
# ββ Sync state snapshot ββββββββββββββββββββββββββββββββββββββββββββββ
self._state.dirty_csv_snapshot = self._df_to_csv(self._dirty_df)
return self._build_observation(
reward=reward,
done=done,
last_action_success=action_success,
last_action_error=error_msg,
grader_result=grader_result,
)
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# state (property)
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
@property
def state(self) -> CleanState:
"""Return the current environment state (serialisable snapshot)."""
if self._state is None:
raise RuntimeError("Environment not initialised. Call reset() first.")
# Keep snapshot fresh in case step() was called without triggering a sync
if self._dirty_df is not None:
self._state.dirty_csv_snapshot = self._df_to_csv(self._dirty_df)
return self._state
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# Action dispatch
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _apply_action(
self, action: CleanAction
) -> tuple[bool, Optional[str], bool]:
"""
Mutate self._dirty_df according to the action.
Returns
-------
(success, error_msg, was_false_positive)
success β True if action applied without error
error_msg β human-readable description if success=False
was_false_positive β True if a DROP_ROW removed a valid-extreme row
"""
cmd = action.command
if cmd == "SET_VALUE":
return self._apply_set_value(action)
elif cmd == "DROP_ROW":
return self._apply_drop_row(action)
elif cmd == "STANDARDIZE_COL":
return self._apply_standardize_col(action)
elif cmd == "FILL_MISSING":
return self._apply_fill_missing(action)
else:
return False, f"Unknown command: {cmd!r}", False
# ββ SET_VALUE βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _apply_set_value(
self, action: CleanAction
) -> tuple[bool, Optional[str], bool]:
df = self._dirty_df
row_idx = action.row_index
col = action.column
val = action.value
# Validate column
if col not in df.columns:
return (
False,
f"Column {col!r} not found. Available: {list(df.columns)}",
False,
)
# Validate row index (positional)
if row_idx < 0 or row_idx >= len(df):
return (
False,
f"Row index {row_idx} out of range. DataFrame has {len(df)} rows (0β{len(df)-1}).",
False,
)
# Try to cast value to the column's expected type
cast_val, cast_err = self._cast_value(val, df, col)
if cast_err:
return False, cast_err, False
df.iloc[row_idx, df.columns.get_loc(col)] = cast_val
return True, None, False
# ββ DROP_ROW ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _apply_drop_row(
self, action: CleanAction
) -> tuple[bool, Optional[str], bool]:
df = self._dirty_df
row_idx = action.row_index
if row_idx < 0 or row_idx >= len(df):
return (
False,
f"Row index {row_idx} out of range. DataFrame has {len(df)} rows.",
False,
)
# Detect false positive for medium task: is this a valid-extreme row?
was_false_positive = self._is_valid_extreme_row(row_idx)
# Drop the row and reset positional index so future iloc references stay valid
self._dirty_df = df.drop(df.index[row_idx]).reset_index(drop=True)
return True, None, was_false_positive
def _is_valid_extreme_row(self, iloc_idx: int) -> bool:
"""
Return True if dropping this row would be a false positive.
Only applies to the medium task, which tracks valid_extreme_rows
by their original tx_id.
"""
if self._state is None or self._state.task_id != "medium":
return False
valid_extreme_rows: list = self._state.task_metadata.get(
"valid_extreme_rows", []
)
if not valid_extreme_rows or self._clean_df is None:
return False
df = self._dirty_df
if "tx_id" not in df.columns:
return False
# Get the tx_id of the row being dropped
try:
tx_id_to_drop = int(df.iloc[iloc_idx]["tx_id"])
except (IndexError, ValueError, KeyError):
return False
# Check if any valid-extreme row in clean_df has this tx_id
for orig_idx in valid_extreme_rows:
if orig_idx >= len(self._clean_df):
continue
if int(self._clean_df.iloc[orig_idx]["tx_id"]) == tx_id_to_drop:
return True
return False
# ββ STANDARDIZE_COL βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _apply_standardize_col(
self, action: CleanAction
) -> tuple[bool, Optional[str], bool]:
df = self._dirty_df
col = action.column
if col not in df.columns:
return (
False,
f"Column {col!r} not found. Available: {list(df.columns)}",
False,
)
series = df[col].copy()
# ββ Try date normalisation first ββββββββββββββββββββββββββββββββββββββ
if self._looks_like_date_column(col, series):
normalised, err = self._normalise_dates(series)
if err:
return False, f"Date normalisation failed for column {col!r}: {err}", False
self._dirty_df[col] = normalised
return True, None, False
# ββ Try numeric coercion ββββββββββββββββββββββββββββββββββββββββββββββ
if self._looks_like_numeric_column(col, series):
numeric = pd.to_numeric(series, errors="coerce")
# Only apply if we didn't lose more than 20% of non-null values
original_non_null = series.notna().sum()
coerced_non_null = numeric.notna().sum()
if original_non_null == 0 or coerced_non_null / original_non_null >= 0.8:
self._dirty_df[col] = numeric
return True, None, False
# ββ String normalisation: strip whitespace βββββββββββββββββββββββββββ
self._dirty_df[col] = series.apply(
lambda x: str(x).strip() if not _is_nan(x) else x
)
return True, None, False
def _looks_like_date_column(self, col: str, series: pd.Series) -> bool:
"""Heuristic: column name contains 'date' or most non-null values parse as dates."""
if "date" in col.lower():
return True
sample = series.dropna().astype(str).head(5)
parsed = 0
for s in sample:
for fmt in _DATE_PARSE_FORMATS:
try:
pd.to_datetime(s, format=fmt)
parsed += 1
break
except Exception:
pass
return parsed >= max(1, len(sample) // 2)
def _looks_like_numeric_column(self, col: str, series: pd.Series) -> bool:
"""Heuristic: column name or majority of values suggests numeric data."""
numeric_keywords = {"price", "amount", "value", "quantity", "qty", "count", "id", "num"}
if any(kw in col.lower() for kw in numeric_keywords):
return True
sample = series.dropna().head(10)
if len(sample) == 0:
return False
convertible = pd.to_numeric(sample, errors="coerce").notna().sum()
return convertible / len(sample) >= 0.7
def _normalise_dates(self, series: pd.Series) -> tuple[pd.Series, Optional[str]]:
"""Parse dates in any supported format and reformat as YYYY-MM-DD."""
def _parse_one(x: Any) -> Any:
if _is_nan(x):
return x
s = str(x).strip()
for fmt in _DATE_PARSE_FORMATS:
try:
return pd.to_datetime(s, format=fmt).strftime("%Y-%m-%d")
except Exception:
pass
# Last resort: let pandas guess
try:
parsed = pd.to_datetime(s, dayfirst=False)
if 2000 <= parsed.year <= 2030:
return parsed.strftime("%Y-%m-%d")
except Exception:
pass
return x # leave unchanged if unparseable
return series.apply(_parse_one), None
# ββ FILL_MISSING ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _apply_fill_missing(
self, action: CleanAction
) -> tuple[bool, Optional[str], bool]:
df = self._dirty_df
col = action.column
strategy = action.fill_strategy
if col not in df.columns:
return (
False,
f"Column {col!r} not found. Available: {list(df.columns)}",
False,
)
series = df[col].copy()
numeric = pd.to_numeric(series, errors="coerce")
has_numeric = numeric.notna().sum() > 0
if strategy == "mean":
if not has_numeric:
return False, f"Cannot compute mean for non-numeric column {col!r}.", False
fill_val = numeric.mean()
self._dirty_df[col] = numeric.fillna(round(fill_val, 2))
elif strategy == "median":
if not has_numeric:
return False, f"Cannot compute median for non-numeric column {col!r}.", False
fill_val = numeric.median()
self._dirty_df[col] = numeric.fillna(round(fill_val, 2))
elif strategy == "mode":
mode_result = series.mode(dropna=True)
if mode_result.empty:
return False, f"No mode found for column {col!r} (all values missing?).", False
self._dirty_df[col] = series.fillna(mode_result.iloc[0])
elif strategy == "drop":
before = len(self._dirty_df)
self._dirty_df = self._dirty_df.dropna(subset=[col]).reset_index(drop=True)
after = len(self._dirty_df)
return True, None, False
else:
return False, f"Unknown fill_strategy: {strategy!r}", False
return True, None, False
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# Reward computation
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _compute_reward(
self,
action: CleanAction,
prev_score: float,
curr_score: float,
action_success: bool,
was_false_positive: bool,
) -> float:
"""
Dense per-step reward in the range [-0.5, +1.0].
Components
----------
progress score delta (main learning signal)
efficiency bonus small reward for solving with steps to spare
fp_penalty penalise removing a valid-extreme row (medium task)
early_done_penalty penalise calling DONE with a very low score
step_cost tiny constant cost to discourage padding
"""
if self._state is None:
return 0.0
max_steps = self._state.max_steps
step_count = self._state.step_count
# 1. Progress term
progress = curr_score - prev_score
# 2. Efficiency bonus (only when task is solved this step)
threshold = DONE_THRESHOLD[self._state.task_id]
just_solved = prev_score < threshold <= curr_score
step_fraction = step_count / max_steps
efficiency = EFFICIENCY_BONUS_WEIGHT * (1.0 - step_fraction) if just_solved else 0.0
# 3. False-positive penalty
fp_penalty = FALSE_POSITIVE_PENALTY if was_false_positive else 0.0
# 4. Early-DONE penalty
early_done = (
EARLY_DONE_PENALTY
if action.command == "DONE" and curr_score < EARLY_DONE_THRESHOLD
else 0.0
)
# 5. Step cost
step_cost = STEP_COST
reward = progress + efficiency + fp_penalty + early_done + step_cost
return round(float(np.clip(reward, -0.5, 1.0)), 4)
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# Observation builder
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _build_observation(
self,
reward: Optional[float],
done: bool,
last_action_success: bool,
last_action_error: Optional[str],
grader_result: GradeResult,
) -> CleanObservation:
if self._state is None:
raise RuntimeError("State not initialised.")
return CleanObservation(
# Inherited from Observation base
done=done,
reward=reward,
# Task context
task_id=self._state.task_id,
schema_hint=self._state.schema_hint,
initial_dirty_cells=self._state.initial_dirty_cells,
# Per-step state
dirty_csv=self._df_to_csv(self._dirty_df),
current_score=grader_result.score,
issues_remaining=grader_result.issues_remaining,
step_number=self._state.step_count,
max_steps=self._state.max_steps,
# Last-action feedback
last_action_success=last_action_success,
last_action_error=last_action_error,
)
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# Utilities
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
@staticmethod
def _df_to_csv(df: Optional[pd.DataFrame]) -> str:
"""Serialise DataFrame to CSV string with the integer position index."""
if df is None:
return ""
return df.to_csv(index=True, index_label="row_index")
@staticmethod
def _cast_value(
val: str, df: pd.DataFrame, col: str
) -> tuple[Any, Optional[str]]:
"""
Try to cast a string value to the appropriate type for `col`.
Returns (cast_value, error_message). error_message is None on success.
"""
# Determine target type from the clean (non-null, non-text) column values
sample = pd.to_numeric(
df[col].dropna().astype(str).str.strip(), errors="coerce"
)
majority_numeric = sample.notna().sum() / max(len(df[col].dropna()), 1) >= 0.5
if majority_numeric:
try:
float_val = float(val.strip().replace(",", ""))
# If all sample values are whole numbers, keep as int
if (sample.dropna() % 1 == 0).all() and float_val % 1 == 0:
return int(float_val), None
return round(float_val, 2), None
except (ValueError, AttributeError):
return (
None,
f"Cannot cast {val!r} to numeric for column {col!r}. "
f"Provide a plain number (e.g. '29.99').",
)
# String column β accept as-is (strip whitespace)
return val.strip(), None
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# Lifecycle
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def close(self) -> None:
self._dirty_df = None
self._clean_df = None
self._dataset = None
self._state = None
def get_metadata(self) -> EnvironmentMetadata:
return EnvironmentMetadata(
name="data_cleaning_env",
description=(
"Data cleaning pipeline: the agent receives a dirty CSV "
"and must fix type errors, outliers, missing values, and "
"schema inconsistencies to match a hidden ground truth."
),
version="1.0.0",
author="hackathon",
)
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# Helpers
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _is_nan(x: Any) -> bool:
"""Return True if x is any flavour of missing value."""
if x is None:
return True
try:
return bool(pd.isna(x))
except (TypeError, ValueError):
return False
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
# Smoke test
# βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
if __name__ == "__main__":
SEP = "β" * 64
for task_id in ("easy", "medium", "hard"):
print(f"\n{SEP}\nTASK: {task_id.upper()}\n{SEP}")
env = DataCleaningEnvironment()
# ββ reset ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
obs = env.reset(task_id=task_id)
print(f"reset() β score={obs.current_score:.4f} "
f"issues={obs.issues_remaining} done={obs.done}")
assert obs.reward is None, "reward must be None after reset"
assert obs.done is False, "done must be False after reset"
lines = obs.dirty_csv.strip().split("\n")
print(f" CSV: {len(lines)} rows, {len(lines[0].split(','))} cols")
print(f" Hint: {obs.schema_hint[:70]}β¦")
# ββ state() ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
st = env.state
print(f"state() β episode_id={st.episode_id[:8]}β¦ step_count={st.step_count}")
# ββ step: bad column (should give feedback, not crash) βββββββββββββββ
bad_action = CleanAction(
command="SET_VALUE", row_index=0, column="DOES_NOT_EXIST", value="0"
)
obs2 = env.step(bad_action)
assert obs2.last_action_success is False
print(f"step (bad col) β success={obs2.last_action_success} "
f"error='{obs2.last_action_error[:50]}β¦'")
# ββ step: out-of-bounds row ββββββββββββββββββββββββββββββββββββββββββ
bad_row = CleanAction(
command="SET_VALUE", row_index=9999, column="price", value="10.0"
)
obs3 = env.step(bad_row)
assert obs3.last_action_success is False
print(f"step (bad row) β success={obs3.last_action_success} "
f"error='{obs3.last_action_error[:50]}β¦'")
# ββ step: valid fix ββββββββββββββββββββββββββββββββββββββββββββββββββ
if task_id == "easy":
# Find the first injected dirty cell and fix it
injected = env._dataset.metadata.get("injected_cells", [])
if injected:
row, col = injected[0]
clean_val = str(env._clean_df.iloc[row][col])
fix_action = CleanAction(
command="SET_VALUE", row_index=row, column=col, value=clean_val
)
obs4 = env.step(fix_action)
print(f"step (fix row={row} col={col!r}) β "
f"success={obs4.last_action_success} "
f"score={obs4.current_score:.4f} "
f"reward={obs4.reward:.4f}")
assert obs4.last_action_success is True
assert obs4.reward is not None
elif task_id == "medium":
# Fix one outlier row via FILL_MISSING on amount
obs4 = env.step(CleanAction(
command="FILL_MISSING", column="amount", fill_strategy="median"
))
print(f"step (FILL_MISSING amount/median) β "
f"score={obs4.current_score:.4f} reward={obs4.reward:.4f}")
elif task_id == "hard":
# Standardize the date column
obs4 = env.step(CleanAction(
command="STANDARDIZE_COL", column="date"
))
print(f"step (STANDARDIZE_COL date) β "
f"success={obs4.last_action_success} "
f"score={obs4.current_score:.4f} reward={obs4.reward:.4f}")
# ββ DONE action βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
done_obs = env.step(CleanAction(command="DONE"))
assert done_obs.done is True
print(f"step (DONE) β done={done_obs.done} "
f"reward={done_obs.reward:.4f} score={done_obs.current_score:.4f}")
env.close()
print(f"\n{SEP}\nAll smoke tests passed.\n{SEP}") |