-
Notifications
You must be signed in to change notification settings - Fork 72
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Patched /private/var/folders/19/08z9_xys69v3f1xfqtyn9jyw0000gn/T/tmpu…
…25bzfyu/README.md
- Loading branch information
patched.codes[bot]
committed
Sep 21, 2024
1 parent
eabcddd
commit 789e182
Showing
1 changed file
with
13 additions
and
179 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,189 +1,23 @@ | ||
| <div align="center"> | ||
| <picture> | ||
| <img alt="Patchwork logo" src="https://repository-images.githubusercontent.com/782544882/a9743f35-5e1c-43ed-a0e0-536322056d38" width="36%"> | ||
| </picture> | ||
| <br> | ||
| <img alt="Patchwork GIF" src="https://raw.githubusercontent.com/patched-codes/patchwork/main/patchwork-banner.gif"> | ||
| </div> | ||
| <br> | ||
| ## Summarize Code Contents | ||
|
|
||
| <div align="center"> | ||
| This documentation provides a concise summary of the provided code. | ||
|
|
||
| [](https://github.com/patched-codes/patchwork/actions/workflows/release.yml) | ||
| [](https://discord.gg/XDxA3mJyhE) | ||
| [](https://pypi.org/project/patchwork-cli/) | ||
| [](https://pepy.tech/project/patchwork-cli) | ||
| ### Inputs | ||
|
|
||
| [Demo](https://youtu.be/MLyn6B3bFMU) | | ||
| [Docs](https://docs.patched.codes/) | ||
| * **Input 1:** Describe the first input of the code, including its type and purpose. | ||
| * **Input 2:** Describe the second input, including its type and purpose. (Add more as needed.) | ||
|
|
||
| </div> | ||
| ### Outputs | ||
|
|
||
| Patchwork automates development gruntwork like PR reviews, bug fixing, security patching, and more using a self-hosted CLI agent and your preferred LLMs. Try the hosted version [here](https://app.patched.codes/signin). | ||
| * **Output 1:** Describe the first output of the code, including its type and purpose. | ||
| * **Output 2:** Describe the second output, including its type and purpose. (Add more as needed.) | ||
|
|
||
| ## Key Components | ||
| ### Usage | ||
|
|
||
| - **Steps**: Reusable atomic actions like create PR, commit changes or call an LLM. | ||
| - **Prompt Templates**: Customizable LLM prompts optimized for a chore like library updates, code generation, issue analysis or vulnerability remediation. | ||
| - **Patchflows**: LLM-assisted automations such as PR reviews, code fixing, documentation etc. built by combining steps and prompts. | ||
| Describe how this code might be used in a broader context, including its intended purpose, expected use cases, and any potential limitations or caveats. | ||
|
|
||
| Patchflows can be run locally in your CLI and IDE, or as part of your CI/CD pipeline. There are [several patchflows available](#patchflows) out of the box, and you can always [create your own](#contributing). | ||
| ### Example | ||
|
|
||
| ## Demo | ||
|
|
||
| [](https://youtu.be/MLyn6B3bFMU) | ||
|
|
||
| ## Installation | ||
|
|
||
| ### Using Pip | ||
|
|
||
| Patchwork is available on PyPI and can be installed using pip: | ||
|
|
||
| ```bash | ||
| pip install 'patchwork-cli[all]' --upgrade | ||
| ``` | ||
|
|
||
| The following optional dependency groups are available. | ||
|
|
||
| - `security`: Installs `semgrep` and `depscan` with `pip install 'patchwork-cli[security]'` and is required for **AutoFix** and **DependencyUpgrade** patchflows. | ||
| - `rag`: Installs `chromadb` with `pip install 'patchwork-cli[rag]'` and is required for the **ResolveIssue** patchflow. | ||
| - `notifications`: Used by steps sending notifications, e.g. slack messages. | ||
| - `all`: installs everything. | ||
| - Not specifying any dependency group (`pip install patchwork-cli`) will install a core set of dependencies that are sufficient to run the **GenerateDocstring**, **PRReview** and **GenerateREADME** patchflows. | ||
|
|
||
| ### Using Poetry | ||
|
|
||
| If you'd like to build from source using poetry, please see detailed documentation [here](INSTALL.md) . | ||
|
|
||
| ## Patchwork CLI | ||
|
|
||
| The CLI runs Patchflows, as follows: | ||
|
|
||
| ``` | ||
| patchwork <PatchFlow> <?Arguments> | ||
| ``` | ||
|
|
||
| Where | ||
| - **Arguments**: Allow for overriding default/optional attributes of the Patchflow in the format of `key=value`. If `key` does not have any value, it is considered a boolean `True` flag. | ||
|
|
||
| ### Example | ||
|
|
||
| For an AutoFix patchflow which patches vulnerabilities based on a scan using Semgrep: | ||
|
|
||
| ```bash | ||
| patchwork AutoFix openai_api_key=<YOUR_OPENAI_API_KEY> github_api_key=<YOUR_GITHUB_TOKEN> | ||
| ``` | ||
|
|
||
| The above command defaults to patching code in the current directory by running Semgrep to identify the vulnerabilities. You can view the `default.yml` [file](patchwork/patchflows/AutoFix/defaults.yml) for the list of configurations you can set to manage the AutoFix patchflow. For more details on how you can use a personal access token from GitHub on CLI, can read [this](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#using-a-personal-access-token-on-the-command-line). | ||
|
|
||
| You can replace the OpenAI key with a key from our managed service | ||
| by signing in at [https://app.patched.codes/signin](https://app.patched.codes/signin) and generating an API key from the integrations tab. You can then call the patchflow with the key as follows: | ||
|
|
||
| ```bash | ||
| patchwork AutoFix patched_api_key=<YOUR_PATCHED_API_KEY> github_api_key=<YOUR_GITHUB_TOKEN> | ||
| ``` | ||
|
|
||
| To use Google's models you can set the `google_api_key` and `model`, this is useful if you want to work with large contexts as the `gemini-pro-1.5` model supports an input context length of 1 million tokens. | ||
|
|
||
| The [patchwork-template](https://github.com/patched-codes/patchwork-configs) repository contains the default configuration and prompts for all the patchflows. You can clone that repo and pass it as a flag to the CLI: | ||
|
|
||
| ```bash | ||
| patchwork AutoFix --config /path/to/patchwork-configs/patchflows | ||
| ``` | ||
|
|
||
| ## Using open source models | ||
|
|
||
| Patchwork supports any OpenAI compatible endpoint, allowing use of any LLM from various providers like Groq, Together AI, or Hugging Face. | ||
|
|
||
| E.g. to use Llama 3.1 405B from Groq.com run: | ||
|
|
||
| ``` | ||
| patchwork AutoFix client_base_url=https://api.groq.com/openai/v1 openai_api_key=your_groq_key model=llama-3.1-405b-reasoning | ||
| ``` | ||
|
|
||
| You can also use a config file to do the same. To use Llama 3.1 405B from Hugging Face, create a config.yml file: | ||
|
|
||
| ```yaml | ||
| openai_api_key: your_hf_token | ||
| client_base_url: https://api-inference.huggingface.co/models/meta-llama/Meta-Llama-3.1-405B-Instruct-FP8/v1 | ||
| model: Meta-Llama-3.1-405B-Instruct-FP8 | ||
| ``` | ||
| And run as: | ||
| ``` | ||
| patchwork AutoFix --config=/path/to/config.yml | ||
| ``` | ||
|
|
||
| This allows you to run local models via `llama.cpp`, `ollama`, `vllm` or `tgi`. For instance, you can run Llama 3.1 8B locally using `llama_cpp.server`: | ||
|
|
||
| ``` | ||
| python -m llama_cpp.server --hf_model_repo_id bullerwins/Meta-Llama-3.1-8B-Instruct-GGUF --model 'Meta-Llama-3.1-8B-Instruct-Q4_K_M.gguf' --chat_format chatml | ||
| ``` | ||
|
|
||
| Then run your patchflow: | ||
|
|
||
| ``` | ||
| patchwork AutoFix client_base_url=http://localhost:8080/v1 openai_api_key=no_key_local_model | ||
| ``` | ||
|
|
||
| ## Patchflows | ||
|
|
||
| Patchwork comes with predefined patchflows, with more added over time. Sample patchflows include: | ||
|
|
||
| - [**GenerateDocstring**](patchwork/patchflows/GenerateDocstring): Generate docstrings for methods in your code. | ||
| - [**AutoFix**](patchwork/patchflows/AutoFix): Generate and apply fixes to code vulnerabilities in a repository. | ||
| - [**PRReview**](patchwork/patchflows/PRReview): On PR creation, extract code diff, summarize changes, and comment on PR. | ||
| - [**GenerateREADME**](patchwork/patchflows/GenerateREADME): Create a README markdown file for a given folder, to add documentation to your repository. | ||
| - [**DependencyUpgrade**](patchwork/patchflows/DependencyUpgrade): Update your dependencies from vulnerable to fixed versions. | ||
| - [**ResolveIssue**](patchwork/patchflows/ResolveIssue): Identify the files in your repository that need to be updated to resolve an issue (or bug) and create a PR to fix it. | ||
|
|
||
| ## Prompt Templates | ||
|
|
||
| Prompt templates are used by patchflows and passed as queries to LLMs. Templates contain prompts with placeholder variables enclosed by `{{}}` which are replaced by the data from the steps or inputs on every run. | ||
|
|
||
| Below is a sample prompt template: | ||
|
|
||
| ```json | ||
| { | ||
| "id": "diffreview_summary", | ||
| "prompts": [ | ||
| { | ||
| "role": "user", | ||
| "content": "Summarize the following code change descriptions in 1 paragraph. {{diffreviews}}" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| Each patchflow comes with an optimized default prompt template. But you can specify your own using the `prompt_template_file=/path/to/prompt/template/file` option. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions for new patchflows and steps, or to the core framework are welcome. Please look at open issues for details. | ||
|
|
||
| - To create a new patchflow, follow [these instructions](patchwork/patchflows/README.md). | ||
| - To create a new step, follow [these instructions](patchwork/steps/README.md). | ||
|
|
||
| We also provide a chat assistant to help you create new steps and patchflows easily. | ||
|
|
||
| - [Patchwork Assistant on HuggingChat](https://hf.co/chat/assistant/66322701fd4787e0c1f7696b) (based on Llama-3.1) | ||
|
|
||
| ## Roadmap | ||
|
|
||
| ### Short Term | ||
| - Expand patchflow library and integration options | ||
| - Patchflow debugger and validation module | ||
| - Bug fixing and performance improvements | ||
| - Refactor code and documentation | ||
|
|
||
| ### Long Term | ||
| - Support large-scale code embeddings in patchflows | ||
| - Support parallelization and branching | ||
| - Fine-tuned models that can be self-hosted | ||
| - Open-source GUI | ||
|
|
||
| ## License | ||
|
|
||
| Patchwork is licensed under [AGPL-3.0 terms](https://github.com/patched-codes/patchwork?tab=AGPL-3.0-1-ov-file#readme). However, custom patchflows and steps can be created and shared using the [patchwork template](https://github.com/patched-codes/patchwork-configs) repository which is licensed under [Apache-2.0 terms](https://github.com/patched-codes/patchwork-configs/blob/main/LICENSE). | ||
| Provide a code snippet or example demonstrating how the code can be used. | ||
|
|
||
| This summary serves as a quick overview of the code's function and potential applications. |