farouk1/tweet-optimizer-v2
1
2
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Farouk Adeleke
2025-10-20 00:14:03 +00:00
parent bf99e98283
commit 438abfba3d
1 changed files with 20 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -11,6 +11,26 @@ A composable DSPy agent that optimizes tweets using a reflective generate-evalua
- **Structured Evaluation**: 1-9 scoring with detailed reasoning per category - **Structured Evaluation**: 1-9 scoring with detailed reasoning per category
- **Easy Configuration**: Flexible model, iteration, and patience settings - **Easy Configuration**: Flexible model, iteration, and patience settings
### Quick Usage
```python
# Load this pre-trained agent from Modaic Hub
from modaic import AutoAgent
tweet_optimizer = AutoAgent.from_precompiled("farouk1/tweet-optimizer-v2")
results = tweet_optimizer(
input_text="Your tweet content here",
iterations=20,
patience=7
)
print(f"Original: {results.initial_text}")
print(f"Optimized: {results.final_tweet}")
print(f"Score: {results.best_score:.2f}")
print(f"Iterations: {results.iterations_run}")
```
## Installation ## Installation
### Prerequisites ### Prerequisites
@@ -98,27 +118,6 @@ agent.push_to_hub(
) )
``` ```
### Load from Hub
```python
# Load this pre-trained agent from Modaic Hub
from modaic import AutoAgent
tweet_optimizer = AutoAgent.from_precompiled("farouk1/tweet-optimizer-v2")
# Use immediately
results = tweet_optimizer(
input_text="Your tweet content here",
iterations=20,
patience=7
)
print(f"Original: {results['initial_text']}")
print(f"Optimized: {results['final_tweet']}")
print(f"Score: {results['best_score']:.2f}")
print(f"Iterations: {results['iterations_run']}")
```
### Configuration Options ### Configuration Options
#### TweetOptimizerConfig #### TweetOptimizerConfig