Skip to content

Commit 2181dbf

Browse files
Update README.md
1 parent eaa30aa commit 2181dbf

File tree

1 file changed

+44
-26
lines changed

1 file changed

+44
-26
lines changed

README.md

Lines changed: 44 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,28 @@
1-
# Codeflash
1+
![Codeflash-banner](https://i.postimg.cc/GmPRC52t/Codeflash-banner.png)
2+
<p align="center">
3+
<a href="https://github.com/codeflash-ai/codeflash">
4+
<img src="https://img.shields.io/github/commit-activity/m/codeflash-ai/codeflash" alt="GitHub commit activity">
5+
</a>
6+
<a href="https://pypi.org/project/codeflash/">
7+
<img src="https://img.shields.io/pypi/dm/codeflash" alt="PyPI Downloads">
8+
</a>
9+
<a href="https://pypi.org/project/codeflash/">
10+
<img src="https://img.shields.io/pypi/v/codeflash?label=PyPI%20version" alt="PyPI Downloads">
11+
</a>
12+
</p>
213

3-
Codeflash is an AI optimization tool that automatically improves the performance of your Python code while maintaining its correctness.
14+
[Codeflash](https://www.codeflash.ai) is a general purpose optimizer for Python that automatically improves the performance of your Python code while maintaining its correctness.
15+
It uses advanced LLMs to generate multiple optimization ideas for your code, tests them to be correct and benchmarks them for performance. It then opens merge ready Pull Requests with the best optimization it found that you can review and merge.
416

5-
![img.png](https://res.cloudinary.com/dkg30tdvl/image/upload/v1731590846/readme-img_df52le.png)
17+
How to use Codeflash -
18+
- Optimize an entire existing codebase by running `codeflash --all`
19+
- Automate optimizing all __future__ code you will write by installing Codeflash as a GitHub action.
20+
- Optimize a Python workflow end-to-end by Tracing the workflow.
621

7-
## Features
22+
Codeflash is used by top engineering teams at [Pydantic](https://github.com/pydantic/pydantic/pulls?q=is%3Apr+author%3Amisrasaurabh1+is%3Amerged), [Langflow](https://github.com/langflow-ai/langflow/issues?q=state%3Aclosed%20is%3Apr%20author%3Amisrasaurabh1), [Albumentations](https://github.com/albumentations-team/albumentations/issues?q=state%3Amerged%20is%3Apr%20author%3Akrrt7%20OR%20state%3Amerged%20is%3Apr%20author%3Aaseembits93%20) and many others to ship performant, expert level code.
23+
24+
Codeflash is great at optimizing AI Agents, Computer vision algorithms, numerical code, backend code or anything else you might write with Python.
825

9-
- Automatically optimizes your code using AI
10-
- Maintains code correctness through extensive testing
11-
- Opens a pull request for each optimization
12-
- Continuously optimizes your codebase through CI
13-
- Dynamically optimizes your real workflows through tracing
1426

1527
## Installation
1628

@@ -19,38 +31,44 @@ To install Codeflash, run:
1931
```
2032
pip install codeflash
2133
```
22-
34+
Add codeflash as a development time dependency if you are using package managers like uv or poetry.
2335
## Quick Start
2436

25-
1. Configure Codeflash for your project:
26-
```
27-
codeflash init
28-
```
2937

30-
2. Optimize a function:
38+
1. To configure Codeflash for a project, at the root directory of your project where the pyproject.toml file is located, run:
3139
```
32-
codeflash --file path/to/your/file.py --function function_name
40+
codeflash init
3341
```
42+
- It will ask you a few questions about your project like the location of your code and tests
43+
- Ask you to generate an [API Key](https://app.codeflash.ai/app/apikeys) to access Codeflash's LLMs
44+
- Install a [GitHub app](https://github.com/apps/codeflash-ai/installations/select_target) to open Pull Requests on GitHub.
45+
- Ask if you want to setup a GitHub actions which will optimize all your future code.
46+
- The codeflash config is then saved in the pyproject.toml file.
3447

35-
3. Optimize your entire codebase:
48+
2. Optimize your entire codebase:
3649
```
3750
codeflash --all
3851
```
52+
This can take a while to run for a large codebase, but it will keep opening PRs as it finds optimizations.
53+
54+
## Documentation
55+
For detailed installation and usage instructions, visit our documentation at [docs.codeflash.ai](https://docs.codeflash.ai)
56+
57+
## Demo
3958

40-
## Getting the Best Results
4159

42-
To get the most out of Codeflash:
60+
- Optimizing the performance of new code for a Pull Request through GitHub actions. This way you can ship new code quickly, and make it all performant too.
4361

44-
1. Install the Github App and actions workflow
45-
2. Find optimizations on your whole codebase with codeflash --all
46-
3. Find and optimize bottlenecks with the Codeflash Tracer
47-
4. Review the PRs Codeflash opens
62+
https://github.com/user-attachments/assets/38f44f4e-be1c-4f84-8db9-63d5ee3e61e5
4863

64+
## Support
4965

50-
## Learn More
66+
Join our community for support and discussions. If you have any questions, feel free to reach out to us using one of the following methods:
5167

52-
- [Codeflash Website](https://www.codeflash.ai)
53-
- [Documentation](https://docs.codeflash.ai)
68+
- [Join our Discord](https://www.codeflash.ai/discord)
69+
- [Follow us on Twitter](https://x.com/codeflashAI)
70+
- [Follow us on Linkedin](https://www.linkedin.com/in/saurabh-misra/)
71+
- [Email founders](mailto:[email protected])
5472

5573
## License
5674

0 commit comments

Comments
 (0)