@@ -9,32 +9,31 @@ Make your extraction more accurate with automatic optimization. LangStruct learn
99
1010## The Easy Way
1111
12- ** Optimization is enabled by default - you're already getting better results:**
12+ ** Enable optimization for better results:**
1313
1414``` python
1515from langstruct import LangStruct
1616
17- # Create extractor (optimization enabled by default)
18- extractor = LangStruct(example = {
19- " name" : " Dr. Sarah Johnson" ,
20- " age" : 34 ,
21- " occupation" : " data scientist"
22- })
17+ # Create extractor with optimization enabled
18+ extractor = LangStruct(
19+ example = {
20+ " name" : " Dr. Sarah Johnson" ,
21+ " age" : 34 ,
22+ " occupation" : " data scientist"
23+ },
24+ optimize = True
25+ )
2326
2427result = extractor.extract(" Dr. Sarah Johnson, 34, is a data scientist" )
25- print (result.entities) # Already optimized results!
28+ print (result.entities) # Optimized results!
2629```
2730
28- That's it! Your extractions are automatically improving over time.
29-
30- ** To disable optimization (not recommended):**
31+ ** Default behavior (faster startup, good baseline accuracy):**
3132
3233``` python
33- # Only if you need faster startup and don't care about accuracy
34- extractor = LangStruct(
35- example = {" name" : " John" , " age" : 30 },
36- optimize = False
37- )
34+ # No optimization - good for quick experiments
35+ extractor = LangStruct(example = {" name" : " John" , " age" : 30 })
36+ # optimize=False by default - enables faster startup
3837```
3938
4039## When You Have Training Data
@@ -106,7 +105,7 @@ extractor.optimize(
106105
107106<CardGrid >
108107 <Card title = " Start Simple" icon = " rocket" >
109- Optimization is enabled by default - just create your extractor
108+ Start without optimization for quick experiments, enable when you need accuracy
110109 </Card >
111110 <Card title = " Quality Over Quantity" icon = " star" >
112111 10 good training examples beats 100 poor ones
@@ -122,7 +121,7 @@ extractor.optimize(
122121## Common Questions
123122
124123** Q: Do I always need training data?**
125- A: No! Optimization works without any training data and still improves results.
124+ A: No! Optimization can work without training data, but providing examples improves results significantly .
126125
127126** Q: How long does optimization take?**
128127A: Usually 1-5 minutes for typical datasets (10-100 examples).
@@ -140,7 +139,7 @@ A: Just change the model and re-optimize! Same training data, same accuracy - ze
140139
141140<CardGrid >
142141 <Card title = " Try It Now" icon = " laptop" >
143- Create a LangStruct extractor - optimization is already enabled !
142+ Create a LangStruct extractor and enable optimization when you need accuracy !
144143 </Card >
145144 <Card title = " Source Grounding" icon = " document" >
146145 [ Track where information comes from] ( /source-grounding/ )
0 commit comments