Skip to content

Commit

Permalink
Deployed 86dfcbf with MkDocs version: 1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
FortiShield committed Jun 13, 2024
1 parent 2e9459b commit 45fbe59
Show file tree
Hide file tree
Showing 14 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
khulnasoft.github.io
pr-assistant.github.io
2 changes: 1 addition & 1 deletion chrome-extension/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1473,7 +1473,7 @@ <h2 id="installation">Installation<a class="headerlink" href="#installation" tit
<p>Go to the marketplace and install the extension:
<a href="https://chromewebstore.google.com/detail/pr-assistant-chrome-extension/ephlnjeghhogofkifjloamocljapahnl">PR-Assistant Chrome Extension</a></p>
<h2 id="pre-requisites">Pre-requisites<a class="headerlink" href="#pre-requisites" title="Permanent link">&para;</a></h2>
<p>The PR-Assistant Chrome extension will work on any repo where you have previously <a href="https://khulnasoft.github.io/installation/">installed PR-Assistant</a>.</p>
<p>The PR-Assistant Chrome extension will work on any repo where you have previously <a href="https://pr-assistant.github.io/installation/">installed PR-Assistant</a>.</p>
<h2 id="data-privacy-and-security">Data privacy and security<a class="headerlink" href="#data-privacy-and-security" title="Permanent link">&para;</a></h2>
<p>The PR-Assistant Chrome extension only modifies the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a PR-Assistant tool, in accordance with the standard privacy policy of PR-Assistant.</p>

Expand Down
2 changes: 1 addition & 1 deletion finetuning_benchmark/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1541,7 +1541,7 @@ <h2 id="results-analysis">Results analysis<a class="headerlink" href="#results-a
<h2 id="the-dataset">The dataset<a class="headerlink" href="#the-dataset" title="Permanent link">&para;</a></h2>
<h3 id="training-dataset">Training dataset<a class="headerlink" href="#training-dataset" title="Permanent link">&para;</a></h3>
<p>Our training dataset comprises 25,000 pull requests, aggregated from permissive license repos. For each pull request, we generated responses for the three main tools of PR-Assistant:
<a href="https://khulnasoft.github.io/tools/describe/">Describe</a>, <a href="https://khulnasoft.github.io/tools/improve/">Review</a> and <a href="https://khulnasoft.github.io/tools/improve/">Improve</a>.</p>
<a href="https://pr-assistant.github.io/tools/describe/">Describe</a>, <a href="https://pr-assistant.github.io/tools/improve/">Review</a> and <a href="https://pr-assistant.github.io/tools/improve/">Improve</a>.</p>
<p>On the raw data collected, we employed various automatic and manual cleaning techniques to ensure the outputs were of the highest quality, and suitable for instruct-tuning.</p>
<p>Here are the prompts, and example outputs, used as input-output pairs to fine-tune the models:</p>
<table>
Expand Down
10 changes: 5 additions & 5 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1493,7 +1493,7 @@ <h2 id="pr-assistant-features">PR-Assistant Features<a class="headerlink" href="
</tr>
<tr>
<td></td>
<td><a href="https://khulnasoft.github.io/tools/review/#soc2-ticket-compliance" target="_blank">SOC2 Compliance</a> 💎</td>
<td><a href="https://pr-assistant.github.io/tools/review/#soc2-ticket-compliance" target="_blank">SOC2 Compliance</a> 💎</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
Expand All @@ -1517,7 +1517,7 @@ <h2 id="pr-assistant-features">PR-Assistant Features<a class="headerlink" href="
</tr>
<tr>
<td></td>
<td><a href="https://khulnasoft.github.io/tools/describe/#inline-file-summary" target="_blank">Inline file summary</a> 💎</td>
<td><a href="https://pr-assistant.github.io/tools/describe/#inline-file-summary" target="_blank">Inline file summary</a> 💎</td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
<td style="text-align: center;"></td>
Expand Down Expand Up @@ -1736,14 +1736,14 @@ <h2 id="pr-assistant-pro">PR-Assistant Pro 💎<a class="headerlink" href="#pr-a
<li>(Tool): <a href="tools/custom_prompt/"><strong>Custom Prompt Suggestions</strong></a></li>
<li>(Tool): <a href="tools/test/"><strong>Tests</strong></a></li>
<li>(Tool): <a href="tools/documentation/"><strong>PR documentation</strong></a></li>
<li>(Tool): <a href="https://khulnasoft.github.io/tools/improve_component/"><strong>Improve Component</strong></a></li>
<li>(Tool): <a href="https://khulnasoft.github.io/tools/similar_code/"><strong>Similar code search</strong></a></li>
<li>(Tool): <a href="https://pr-assistant.github.io/tools/improve_component/"><strong>Improve Component</strong></a></li>
<li>(Tool): <a href="https://pr-assistant.github.io/tools/similar_code/"><strong>Similar code search</strong></a></li>
<li>(Tool): <a href="tools/ci_feedback/"><strong>CI feedback</strong></a></li>
<li>(Feature): <a href="usage-guide/automations_and_usage/#interactive-triggering"><strong>Interactive triggering</strong></a></li>
<li>(Feature): <a href="tools/review/#soc2-ticket-compliance"><strong>SOC2 compliance check</strong></a></li>
<li>(Feature): <a href="tools/describe/#handle-custom-labels-from-the-repos-labels-page"><strong>Custom labels</strong></a></li>
<li>(Feature): <a href="usage-guide/configuration_options/#wiki-configuration-file"><strong>Global and wiki configuration</strong></a></li>
<li>(Feature): <a href="https://khulnasoft.github.io/tools/describe/#inline-file-summary"><strong>Inline file summary</strong></a></li>
<li>(Feature): <a href="https://pr-assistant.github.io/tools/describe/#inline-file-summary"><strong>Inline file summary</strong></a></li>
</ul>
</li>
</ol>
Expand Down
2 changes: 1 addition & 1 deletion installation/github/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1455,7 +1455,7 @@ <h2 id="run-as-a-github-action">Run as a GitHub Action<a class="headerlink" href
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="w"> </span><span class="nt">PR_REVIEWER.REQUIRE_TESTS_REVIEW</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;false&quot;</span><span class="w"> </span><span class="c1"># Disable tests review</span>
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a><span class="w"> </span><span class="nt">PR_CODE_SUGGESTIONS.NUM_CODE_SUGGESTIONS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">6</span><span class="w"> </span><span class="c1"># Increase number of code suggestions</span>
</code></pre></div>
See detailed usage instructions in the <a href="https://khulnasoft.github.io/usage-guide/automations_and_usage/#github-action">USAGE GUIDE</a></p>
See detailed usage instructions in the <a href="https://pr-assistant.github.io/usage-guide/automations_and_usage/#github-action">USAGE GUIDE</a></p>
<hr />
<h2 id="run-as-a-github-app">Run as a GitHub App<a class="headerlink" href="#run-as-a-github-app" title="Permanent link">&para;</a></h2>
<p>Allowing you to automate the review process on your private or public repositories.</p>
Expand Down
2 changes: 1 addition & 1 deletion installation/gitlab/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1393,7 +1393,7 @@ <h2 id="run-a-gitlab-webhook-server">Run a GitLab webhook server<a class="header
</ol>
<p><div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>WEBHOOK_SECRET=$(python -c &quot;import secrets; print(secrets.token_hex(10))&quot;)
</code></pre></div>
3. Follow the instructions to build the Docker image, setup a secrets file and deploy on your own server from <a href="https://khulnasoft.github.io/installation/github/#run-as-a-github-app">here</a> steps 4-7.</p>
3. Follow the instructions to build the Docker image, setup a secrets file and deploy on your own server from <a href="https://pr-assistant.github.io/installation/github/#run-as-a-github-app">here</a> steps 4-7.</p>
<ol>
<li>
<p>In the secrets file, fill in the following:</p>
Expand Down
2 changes: 1 addition & 1 deletion installation/pr_assistant_pro/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1435,7 +1435,7 @@ <h1>💎 PR-Assistant Pro</h1>

<h2 id="getting-started-with-pr-assistant-pro">Getting Started with PR-Assistant Pro<a class="headerlink" href="#getting-started-with-pr-assistant-pro" title="Permanent link">&para;</a></h2>
<p>PR-Assistant Pro is a versatile application compatible with GitHub, GitLab, and BitBucket, hosted by KhulnaSoft.
See <a href="https://khulnasoft.github.io/#pr-assistant-pro">here</a> for more details about the benefits of using PR-Assistant Pro.</p>
See <a href="https://pr-assistant.github.io/#pr-assistant-pro">here</a> for more details about the benefits of using PR-Assistant Pro.</p>
<p>Interested parties can subscribe to PR-Assistant Pro through the following <a href="https://www.khulnasoft.com/pricing/">link</a>.
After subscribing, you are granted the ability to easily install the application across any of your repositories.</p>
<p><a class="glightbox" href="https://khulnasoft.com/images/pr_assistant/pr_assistant_pro_install.png" data-type="image" data-width="auto" data-height="auto" data-desc-position="bottom"><img alt="PR Assistant Pro" src="https://khulnasoft.com/images/pr_assistant/pr_assistant_pro_install.png" width="468" /></a></p>
Expand Down
4 changes: 2 additions & 2 deletions tools/describe/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1490,7 +1490,7 @@ <h3 id="manual-triggering">Manual triggering<a class="headerlink" href="#manual-
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>/describe --pr_description.some_config1=... --pr_description.some_config2=...
</code></pre></div></p>
<h3 id="automatic-triggering">Automatic triggering<a class="headerlink" href="#automatic-triggering" title="Permanent link">&para;</a></h3>
<p>To run the <code>describe</code> automatically when a PR is opened, define in a <a href="https://khulnasoft.github.io/usage-guide/configuration_options/#wiki-configuration-file">configuration file</a>:
<p>To run the <code>describe</code> automatically when a PR is opened, define in a <a href="https://pr-assistant.github.io/usage-guide/configuration_options/#wiki-configuration-file">configuration file</a>:
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>[github_app]
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>pr_commands = [
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a> &quot;/describe&quot;,
Expand Down Expand Up @@ -1600,7 +1600,7 @@ <h2 id="markers-template">Markers template<a class="headerlink" href="#markers-t
<h2 id="custom-labels">Custom labels<a class="headerlink" href="#custom-labels" title="Permanent link">&para;</a></h2>
<p>The default labels of the describe tool are quite generic, since they are meant to be used in any repo: [<code>Bug fix</code>, <code>Tests</code>, <code>Enhancement</code>, <code>Documentation</code>, <code>Other</code>].</p>
<p>You can define custom labels that are relevant for your repo and use cases.
Custom labels can be defined in a <a href="https://khulnasoft.github.io/tools/custom_labels/#configuration-options">configuration file</a>, or directly in the repo's <a href="#handle-custom-labels-from-the-repos-labels-page">labels page</a>.</p>
Custom labels can be defined in a <a href="https://pr-assistant.github.io/tools/custom_labels/#configuration-options">configuration file</a>, or directly in the repo's <a href="#handle-custom-labels-from-the-repos-labels-page">labels page</a>.</p>
<p>Examples for custom labels:</p>
<ul>
<li><code>Main topic:performance</code> - pr_assistant:The main topic of this PR is performance</li>
Expand Down
6 changes: 3 additions & 3 deletions tools/improve/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1470,7 +1470,7 @@ <h3 id="manual-triggering">Manual triggering<a class="headerlink" href="#manual-
<p>Note that a single comment has a significantly smaller PR footprint. We recommend this mode for most cases.
Also note that collapsible are not supported in <em>Bitbucket</em>. Hence, the suggestions are presented there as code comments.</p>
<h3 id="automatic-triggering">Automatic triggering<a class="headerlink" href="#automatic-triggering" title="Permanent link">&para;</a></h3>
<p>To run the <code>improve</code> automatically when a PR is opened, define in a <a href="https://khulnasoft.github.io/usage-guide/configuration_options/#wiki-configuration-file">configuration file</a>:
<p>To run the <code>improve</code> automatically when a PR is opened, define in a <a href="https://pr-assistant.github.io/usage-guide/configuration_options/#wiki-configuration-file">configuration file</a>:
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>[github_app]
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>pr_commands = [
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a> &quot;/improve&quot;,
Expand Down Expand Up @@ -1582,7 +1582,7 @@ <h2 id="usage-tips">Usage Tips<a class="headerlink" href="#usage-tips" title="Pe
<div class="admonition tip">
<p class="admonition-title">Review vs. Improve tools comparison</p>
<ul>
<li>The <a href="https://khulnasoft.github.io/tools/review/">review</a> tool includes a section called 'Possible issues', that also provide feedback on the PR Code.
<li>The <a href="https://pr-assistant.github.io/tools/review/">review</a> tool includes a section called 'Possible issues', that also provide feedback on the PR Code.
In this section, the model is instructed to focus <strong>only</strong> on <a href="https://github.com/khulnasoft/pr-assistant/blob/main/pr_assistant/settings/pr_reviewer_prompts.toml#L71">major bugs and issues</a>.</li>
<li>The <code>improve</code> tool, on the other hand, has a broader mandate, and in addition to bugs and issues, it can also give suggestions for improving code quality and making the code more efficient, readable, and maintainable (see <a href="https://github.com/khulnasoft/pr-assistant/blob/main/pr_assistant/settings/pr_code_suggestions_prompts.toml#L34">here</a>).</li>
<li>Hence, if you are interested only in feedback about clear bugs, the <code>review</code> tool might suffice. If you want a more detailed feedback, including broader suggestions for improving the PR code, also enable the <code>improve</code> tool to run on each PR.</li>
Expand All @@ -1591,7 +1591,7 @@ <h2 id="usage-tips">Usage Tips<a class="headerlink" href="#usage-tips" title="Pe
<h2 id="a-note-on-code-suggestions-quality">A note on code suggestions quality<a class="headerlink" href="#a-note-on-code-suggestions-quality" title="Permanent link">&para;</a></h2>
<ul>
<li>While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Critical reading and judgment are required.</li>
<li>While mistakes of the AI are rare but can happen, a real benefit from the suggestions of the <code>improve</code> (and <a href="https://khulnasoft.github.io/tools/review/"><code>review</code></a>) tool is to catch, with high probability, <strong>mistakes or bugs done by the PR author</strong>, when they happen. So, it's a good practice to spend the needed ~30-60 seconds to review the suggestions, even if not all of them are always relevant.</li>
<li>While mistakes of the AI are rare but can happen, a real benefit from the suggestions of the <code>improve</code> (and <a href="https://pr-assistant.github.io/tools/review/"><code>review</code></a>) tool is to catch, with high probability, <strong>mistakes or bugs done by the PR author</strong>, when they happen. So, it's a good practice to spend the needed ~30-60 seconds to review the suggestions, even if not all of them are always relevant.</li>
<li>
<p>The hierarchical structure of the suggestions is designed to help the user to <em>quickly</em> understand them, and to decide which ones are relevant and which are not:</p>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion tools/review/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1459,7 +1459,7 @@ <h3 id="manual-triggering">Manual triggering<a class="headerlink" href="#manual-
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
</code></pre></div></p>
<h3 id="automatic-triggering">Automatic triggering<a class="headerlink" href="#automatic-triggering" title="Permanent link">&para;</a></h3>
<p>To run the <code>review</code> automatically when a PR is opened, define in a <a href="https://khulnasoft.github.io/usage-guide/configuration_options/#wiki-configuration-file">configuration file</a>:
<p>To run the <code>review</code> automatically when a PR is opened, define in a <a href="https://pr-assistant.github.io/usage-guide/configuration_options/#wiki-configuration-file">configuration file</a>:
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>[github_app]
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>pr_commands = [
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a> &quot;/review&quot;,
Expand Down
4 changes: 2 additions & 2 deletions usage-guide/additional_configurations/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1527,8 +1527,8 @@ <h2 id="working-with-large-prs">Working with large PRs<a class="headerlink" href
This mode provides a very good speed-quality-cost tradeoff, and can handle most PRs successfully.
When the PR is above the token limit, it employs a <a href="../../core-abilities/">PR Compression strategy</a>.</p>
<p>However, for very large PRs, or in case you want to emphasize quality over speed and cost, there are two possible solutions:
1) <a href="https://khulnasoft.github.io/Docs-PR-Assistant/usage-guide/#changing-a-model">Use a model</a> with larger context, like GPT-32K, or claude-100K. This solution will be applicable for all the tools.
2) For the <code>/improve</code> tool, there is an <a href="https://khulnasoft.github.io/Docs-PR-Assistant/tools/#improve">'extended' mode</a> (<code>/improve --extended</code>),
1) <a href="https://pr-assistant.github.io/Docs-PR-Assistant/usage-guide/#changing-a-model">Use a model</a> with larger context, like GPT-32K, or claude-100K. This solution will be applicable for all the tools.
2) For the <code>/improve</code> tool, there is an <a href="https://pr-assistant.github.io/Docs-PR-Assistant/tools/#improve">'extended' mode</a> (<code>/improve --extended</code>),
which divides the PR to chunks, and processes each chunk separately. With this mode, regardless of the model, no compression will be done (but for large PRs, multiple model calls may occur)</p>
<h2 id="changing-a-model">Changing a model<a class="headerlink" href="#changing-a-model" title="Permanent link">&para;</a></h2>
<p>See <a href="https://github.com/khulnasoft/pr-assistant/blob/main/pr_assistant/algo/__init__.py">here</a> for the list of available models.
Expand Down
Loading

0 comments on commit 45fbe59

Please sign in to comment.