- 
                Notifications
    You must be signed in to change notification settings 
- Fork 22
Update README.md #43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README.md #43
Conversation
| Failed to generate code suggestions for PR | 
        
          
                README.md
              
                Outdated
          
        
      | How to use Codeflash - | ||
| - Optimize an entire existing codebase by running `codeflash --all` | ||
| - Automate optimizing all __future__ code you will write by installing Codeflash as a GitHub action. | ||
| - Optimize a Python workflow end-to-end by Tracing the workflow. | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tracing to tracing
        
          
                README.md
              
                Outdated
          
        
      | ## Getting the Best Results | ||
|  | ||
| To get the most out of Codeflash: | ||
| - 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. | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this way,
        
          
                README.md
              
                Outdated
          
        
      | ## Features | ||
| 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. | ||
|  | ||
| Codeflash is great at optimizing AI Agents, Computer vision algorithms, numerical code, backend code or anything else you might write with Python. | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
look at consistent capitalization
| </p> | ||
|  | ||
| Codeflash is an AI optimization tool that automatically improves the performance of your Python code while maintaining its correctness. | ||
| [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. | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
code optimizer for python
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that ensures correctness while improving the performance of your python code
| codeflash init | ||
| ``` | ||
| - It will ask you a few questions about your project like the location of your code and tests | ||
| - Ask you to generate an [API Key](https://app.codeflash.ai/app/apikeys) to access Codeflash's LLMs | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It will ask you
| - It will ask you a few questions about your project like the location of your code and tests | ||
| - Ask you to generate an [API Key](https://app.codeflash.ai/app/apikeys) to access Codeflash's LLMs | ||
| - Install a [GitHub app](https://github.com/apps/codeflash-ai/installations/select_target) to open Pull Requests on GitHub. | ||
| - Ask if you want to setup a GitHub actions which will optimize all your future code. | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
setup github actions
the previous one was just bad...