diff --git a/README.md b/README.md index 1586d48ef..774a6f678 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,17 @@ Qode Merge PR-Agent aims to help efficiently review and handle pull requests, by ## News and Updates +### Jan 2, 2025 + +New tool: [/Implement 💎](https://qodo-merge-docs.qodo.ai/tools/implement/), which converts human code review discussions and feedback into ready-to-commit code changes. + + + + +### Jan 1, 2025 + +Update logic and [documentation](https://qodo-merge-docs.qodo.ai/usage-guide/changing_a_model/#ollama) for running local models via Ollama. + ### December 30, 2024 Following [feedback](https://research.kudelskisecurity.com/2024/08/29/careful-where-you-code-multiple-vulnerabilities-in-ai-powered-pr-agent/) from the community, we have addressed two vulnerabilities identified in the open-source PR-Agent project. The fixes are now included in the newly released version (v0.26), available as of today. @@ -79,12 +90,6 @@ Focused mode -### November 4, 2024 - -Qodo Merge PR Agent will now leverage context from Jira or GitHub tickets to enhance the PR Feedback. Read more about this feature -[here](https://qodo-merge-docs.qodo.ai/core-abilities/fetching_ticket_context/) - - ## Overview
@@ -158,7 +163,7 @@ ___ \ ‣ **Similar Code 💎 ([`/find_similar_component`](https://pr-agent-docs.codium.ai/tools/similar_code/))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code. \ -‣ **Implement 💎 ([`/implement`](https://pr-agent-docs.codium.ai/tools/implement/))**: Generates implementation code from review suggestions. +‣ **Implement 💎 ([`/implement`](https://qodo-merge-docs.qodo.ai/tools/implement/))**: Generates implementation code from review suggestions. ___ ## Example results diff --git a/docs/docs/tools/implement.md b/docs/docs/tools/implement.md index 4b1b69aa9..b75c3c789 100644 --- a/docs/docs/tools/implement.md +++ b/docs/docs/tools/implement.md @@ -1,12 +1,12 @@ ## Overview -The `implement` tool automatically generates implementation code based on PR review suggestions. -It combines LLM capabilities with PR review suggestions to help developers implement code changes quickly and with confidence. +The `implement` tool converts human code review discussions and feedback into ready-to-commit code changes. +It leverages LLM technology to transform PR comments and review suggestions into concrete implementation code, helping developers quickly turn feedback into working solutions. ## Usage Scenarios -### 1. For Reviewers +### For Reviewers Reviewers can request code changes by:
1. Selecting the code block to be modified.
@@ -15,10 +15,10 @@ Reviewers can request code changes by:
/implement ``` -![implement1](https://codium.ai/images/pr_agent/implement1.png){width=512} +![implement1](https://codium.ai/images/pr_agent/implement1.png){width=640} -### 2. For PR Authors +### For PR Authors PR authors can implement suggested changes by replying to a review comment using either:
1. Add specific implementation details as described above @@ -30,16 +30,16 @@ PR authors can implement suggested changes by replying to a review comment using /implement ``` -![implement2](https://codium.ai/images/pr_agent/implement2.png){width=512} +![implement2](https://codium.ai/images/pr_agent/implement2.png){width=640} -### 3. For Referencing Comments +### For Referencing Comments You can reference and implement changes from any comment by: ``` /implement ``` -![implement3](https://codium.ai/images/pr_agent/implement3.png){width=512} +![implement3](https://codium.ai/images/pr_agent/implement3.png){width=640} Note that the implementation will occur within the review discussion thread. diff --git a/docs/docs/usage-guide/changing_a_model.md b/docs/docs/usage-guide/changing_a_model.md index 6ee037594..24dee24ab 100644 --- a/docs/docs/usage-guide/changing_a_model.md +++ b/docs/docs/usage-guide/changing_a_model.md @@ -40,7 +40,7 @@ E.g. to use a new model locally via Ollama, set in `.secrets.toml` or in a confi model = "ollama/qwen2.5-coder:32b" fallback_models=["ollama/qwen2.5-coder:32b"] custom_model_max_tokens=128000 # set the maximal input tokens for the model -duplicate_examples=true # will duplicate the examples in the prompt, to help the model to output structured output +duplicate_examples=true # will duplicate the examples in the prompt, to help the model to generate structured output [ollama] api_base = "http://localhost:11434" # or whatever port you're running Ollama on @@ -48,11 +48,14 @@ api_base = "http://localhost:11434" # or whatever port you're running Ollama on !!! note "Local models vs commercial models" Qodo Merge is compatible with almost any AI model, but analyzing complex code repositories and pull requests requires a model specifically optimized for code analysis. + Commercial models such as GPT-4, Claude Sonnet, and Gemini have demonstrated robust capabilities in generating structured output for code analysis tasks with large input. In contrast, most open-source models currently available (as of January 2025) face challenges with these complex tasks. + Based on our testing, local open-source models are suitable for experimentation and learning purposes, but they are not suitable for production-level code analysis tasks. + Hence, for production workflows and real-world usage, we recommend using commercial models. -### Hugging Face Inference Endpoints +### Hugging Face To use a new model with Hugging Face Inference Endpoints, for example, set: ```