@@ -8,13 +8,13 @@ Generate word salad text by shuffling the interior letters of each word while ke
88
99## Features
1010
11- - 🔀 ** Scramble text** while preserving readability
12- - 🎯 ** Deterministic output** with optional ` --seed ` for reproducible experiments
13- - 📚 ** Library functions** for programmatic use
14- - 🖥️ ** Rich CLI** with subcommands for scrambling, scoring, and batch evaluation
15- - 📊 ** Multiple scoring methods** to grade AI decoding attempts
16- - 🏆 ** Leaderboard generation** for comparing model performance
17- - ✅ ** Fully typed** with ` py.typed ` marker for IDE support
11+ - ** Scramble text** while preserving readability
12+ - ** Deterministic output** with optional ` --seed ` for reproducible experiments
13+ - ** Library functions** for programmatic use
14+ - ** Rich CLI** with subcommands for scrambling, scoring, and batch evaluation
15+ - ** Multiple scoring methods** to grade AI decoding attempts
16+ - ** Leaderboard generation** for comparing model performance
17+ - ** Fully typed** with ` py.typed ` marker for IDE support
1818
1919## Installation
2020
@@ -86,8 +86,8 @@ word-salat evaluate -o text.txt -d text_decoded/ --no-log
8686### Library API
8787
8888``` python
89- from word_salat import scramble_text, scramble_word, score_decoded_text
90- from word_salat import batch_evaluate, generate_leaderboard
89+ from src import scramble_text, scramble_word, score_decoded_text
90+ from src import batch_evaluate, generate_leaderboard
9191
9292# Scramble text
9393original = " A longish sentence to scramble"
@@ -100,7 +100,7 @@ score = score_decoded_text(original, decoded_attempt)
100100print (f " Score: { score:.2% } " )
101101
102102# Get detailed metrics
103- from word_salat .scoring import compute_detailed_score
103+ from src .scoring import compute_detailed_score
104104result = compute_detailed_score(original, decoded_attempt, name = " my-model" )
105105print (f " Char: { result.char_score:.2% } , Word: { result.word_score:.2% } " )
106106
@@ -206,12 +206,12 @@ Version 2.0 introduces a new package structure. To migrate:
206206 # Old (v1)
207207 from word_salat import scramble_text, score_decoded_text
208208
209- # New (v2) - same imports still work!
210- from word_salat import scramble_text, score_decoded_text
209+ # New (v2)
210+ from src import scramble_text, score_decoded_text
211211
212- # New detailed imports
213- from word_salat .core import scramble_text, scramble_word
214- from word_salat .scoring import score_decoded_text, batch_evaluate
212+ # Detailed imports
213+ from src .core import scramble_text, scramble_word
214+ from src .scoring import score_decoded_text, batch_evaluate
215215 ```
216216
2172172 . ** CLI changes** : The CLI now uses subcommands:
0 commit comments