You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-14Lines changed: 25 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,12 +11,18 @@
11
11
</a>
12
12
</p>
13
13
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 creates merge-ready pull requests containing the best optimization found, which you can review and merge.
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.
16
15
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.
16
+
How Codeflash works:
17
+
1. LLMs generate multiple optimization candidates for your code
18
+
2. Codeflash tests the optimization candidates for correctness
19
+
3. Codeflash benchmarks the optimization candidates for performance
20
+
21
+
Should the optimization be valid and faster than the original code, Codeflash will create a pull request with the optimized code. You can now review and merge the code to make your codebase faster!
22
+
23
+
Ways to use Codeflash:
24
+
- Optimize an entire codebase by running `codeflash --all`
25
+
- Automatically optimize all __future__ code written by installing Codeflash as a GitHub action. Codeflash will try to optimize your new code before you merge it into the codebase.
20
26
- Optimize a Python workflow end-to-end by tracing the workflow.
21
27
22
28
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.
@@ -35,21 +41,26 @@ Add codeflash as a development time dependency if you are using package managers
35
41
## Quick Start
36
42
37
43
38
-
1.To configure Codeflash for a project, at the root directory of your project where the pyproject.toml file is located, run:
44
+
1.Run the following command at the root directory of your project where the pyproject.toml file is located
39
45
```
40
46
codeflash init
41
47
```
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.
47
-
48
-
2. Optimize your entire codebase:
48
+
This will set up basic configurations for your project, eg:
49
+
- Input a Codeflash API key (for access to LLMs)
50
+
- Enable a [GitHub app](https://github.com/apps/codeflash-ai/installations/select_target) to open Pull Requests on the repo
51
+
-[Optional] Setup a GitHub actions which will optimize all your future code.
52
+
53
+
54
+
55
+
2. Optimize a file:
56
+
57
+
```
58
+
codeflash --file <path/to/file.py>
49
59
```
60
+
3. Optimize your entire codebase: (This will run for a while and open PRs as it finds optimizations)
61
+
```
50
62
codeflash --all
51
63
```
52
-
This can take a while to run for a large codebase, but it will keep opening PRs as it finds optimizations.
53
64
54
65
## Documentation
55
66
For detailed installation and usage instructions, visit our documentation at [docs.codeflash.ai](https://docs.codeflash.ai)
0 commit comments