Skip to content

Commit 5fc9fd4

Browse files
committed
Update README.md
1 parent 6f50125 commit 5fc9fd4

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ python openevolve-run.py examples/function_minimization/initial_program.py \
9393

9494
**Note:** The example config uses Gemini by default, but you can use any OpenAI-compatible provider by modifying the `config.yaml`. See the [configs](configs/) for full configuration options.
9595

96-
### 📚 **Library Usage**
96+
### **Library Usage**
9797

9898
OpenEvolve can be used as a library without any external files:
9999

@@ -410,7 +410,7 @@ def minimize_function(func, bounds, max_evals=1000):
410410

411411
**Performance**: 100x improvement in convergence speed!
412412

413-
### 🔬 **Advanced Examples**
413+
### **Advanced Examples**
414414

415415
<details>
416416
<summary><b>Prompt Evolution</b></summary>
@@ -439,7 +439,7 @@ def minimize_function(func, bounds, max_evals=1000):
439439

440440
</details>
441441

442-
## ⚙️ Configuration
442+
## Configuration
443443

444444
OpenEvolve offers extensive configuration for advanced users:
445445

@@ -529,7 +529,7 @@ See [prompt examples](examples/llm_prompt_optimization/templates/) for complete
529529

530530
</details>
531531

532-
## 📝 Crafting Effective System Messages
532+
## Crafting Effective System Messages
533533

534534
**System messages are the secret to successful evolution.** They guide the LLM's understanding of your domain, constraints, and optimization goals. A well-crafted system message can be the difference between random mutations and targeted improvements.
535535

@@ -578,7 +578,7 @@ Based on successful OpenEvolve implementations, system messages are best created
578578

579579
### Examples by Complexity
580580

581-
#### 🎯 **Simple: General Optimization**
581+
#### **Simple: General Optimization**
582582
```yaml
583583
prompt:
584584
system_message: |
@@ -587,7 +587,7 @@ prompt:
587587
global minimum reliably, escaping local minima that might trap simple algorithms.
588588
```
589589

590-
#### 🔧 **Intermediate: Domain-Specific Guidance**
590+
#### **Intermediate: Domain-Specific Guidance**
591591
```yaml
592592
prompt:
593593
system_message: |
@@ -690,7 +690,7 @@ See the [LLM Prompt Optimization example](examples/llm_prompt_optimization/) for
690690
- **No Examples**: Concrete examples guide LLM better than abstract descriptions
691691
- **Ignoring Artifacts**: Don't refine prompts based on error feedback
692692
693-
## 🔧 Artifacts & Debugging
693+
## Artifacts & Debugging
694694
695695
**Artifacts side-channel** provides rich feedback to accelerate evolution:
696696
@@ -720,7 +720,7 @@ return EvaluationResult(
720720

721721
This creates a **feedback loop** where each generation learns from previous mistakes!
722722

723-
## 📊 Visualization
723+
## Visualization
724724

725725
**Real-time evolution tracking** with interactive web interface:
726726

@@ -745,7 +745,7 @@ python scripts/visualizer.py --path examples/function_minimization/openevolve_ou
745745

746746
![OpenEvolve Visualizer](openevolve-visualizer.png)
747747

748-
## 🚀 Roadmap
748+
## Roadmap
749749

750750
### **🔥 Upcoming Features**
751751

@@ -763,7 +763,7 @@ python scripts/visualizer.py --path examples/function_minimization/openevolve_ou
763763

764764
Want to contribute? Check out our [roadmap discussions](https://github.com/codelion/openevolve/discussions/categories/roadmap)!
765765

766-
## 🤔 FAQ
766+
## FAQ
767767

768768
<details>
769769
<summary><b>💰 How much does it cost to run?</b></summary>
@@ -834,15 +834,15 @@ Just set the `api_base` in your config to point to your endpoint.
834834

835835
</details>
836836

837-
### 🌟 **Contributors**
837+
### **Contributors**
838838

839839
Thanks to all our amazing contributors who make OpenEvolve possible!
840840

841841
<a href="https://github.com/codelion/openevolve/graphs/contributors">
842842
<img src="https://contrib.rocks/image?repo=codelion/openevolve" />
843843
</a>
844844

845-
### 🤝 **Contributing**
845+
### **Contributing**
846846

847847
We welcome contributions! Here's how to get started:
848848

@@ -855,14 +855,14 @@ We welcome contributions! Here's how to get started:
855855

856856
**New to open source?** Check out our [Contributing Guide](CONTRIBUTING.md) and look for [`good-first-issue`](https://github.com/codelion/openevolve/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) labels!
857857

858-
### 📚 **Academic & Research**
858+
### **Academic & Research**
859859

860860
**Articles & Blog Posts About OpenEvolve**:
861861
- [Towards Open Evolutionary Agents](https://huggingface.co/blog/driaforall/towards-open-evolutionary-agents) - Evolution of coding agents and the open-source movement
862862
- [OpenEvolve: GPU Kernel Discovery](https://huggingface.co/blog/codelion/openevolve-gpu-kernel-discovery) - Automated discovery of optimized GPU kernels
863863
- [OpenEvolve: Evolutionary Coding with LLMs](https://huggingface.co/blog/codelion/openevolve) - Introduction to evolutionary algorithm discovery using large language models
864864

865-
## 📊 Citation
865+
## Citation
866866

867867
If you use OpenEvolve in your research, please cite:
868868

0 commit comments

Comments
 (0)