Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ pip install uv

```bash
git clone <shinka-repository-url>
cd shinka
cd ShinkaEvolve

# Create virtual environment with Python 3.11
uv venv --python 3.11
Expand All @@ -79,7 +79,7 @@ conda activate shinka

```bash
git clone <shinka-repository-url>
cd shinka
cd ShinkaEvolve
pip install -e .
```

Expand Down Expand Up @@ -249,7 +249,7 @@ from shinka.core import run_shinka_eval

def main(program_path: str, results_dir: str):
"""Main evaluation function called by Shinka"""

metrics, correct, error_msg = run_shinka_eval(
program_path=program_path,
results_dir=results_dir,
Expand All @@ -268,22 +268,22 @@ def main(program_path: str, results_dir: str):
def validate_packing(run_output):
"""Returns (is_valid: bool, error_msg: str or None)"""
centers, radii, reported_sum = run_output

# Check constraints (bounds, overlaps, etc.)
if constraint_violated:
return False, "Specific error description"

return True, None # Valid solution
```

**2. Metrics Aggregation Function** - Computes fitness and organizes results:
```python
def aggregate_metrics(results, results_dir):
"""Returns metrics dictionary with required structure"""

# Extract data from results
centers, radii, reported_sum = results[0]

return {
"combined_score": float(reported_sum), # PRIMARY FITNESS (higher = better)
"public": { # Visible in WebUI/logs
Expand Down