Skip to content

Commit

Permalink
Deploying to gh-pages from @ f707da2 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
hrshdhgd committed Feb 13, 2024
1 parent 3f4659e commit 78fc69c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
9 changes: 5 additions & 4 deletions _sources/description.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Model Providers Implemented
The following model providers have been implemented in CoderGPT:

.. list-table::
:widths: 25 75
:widths: 75 25
:header-rows: 1

* - Provider
Expand All @@ -38,7 +38,7 @@ The following model providers have been implemented in CoderGPT:
export OPENAI_API_KEY='your-api-key-here'
export GOOGLE_API_KEY='your-api-key-here'
Replace ``your-api-key-here`` with your actual OpenAI and Google API keys. This step is crucial for the proper functioning of CoderGPT as it relies on OpenAI and Google APIs for generating and modifying code.
Replace ``your-api-key-here`` with your actual OpenAI and Google API keys. This step is crucial for the proper functioning of CoderGPT as it relies on OpenAI and Google APIs for generating and modifying code.

Installation
------------
Expand Down Expand Up @@ -78,6 +78,7 @@ Options
- ``-v, --verbose INTEGER``: Set verbosity level (0, 1, or 2).
- ``-q, --quiet``: Enable quiet mode.
- ``--version``: Display version information.
- ``--model [gpt-3.5-turbo | gpt-4 | gpt-4-turbo (default) | gemini-pro]``: Set the model provider to use.

Commands
~~~~~~~~
Expand All @@ -87,13 +88,13 @@ Commands

.. code-block:: shell
codergpt inspect <path>
codergpt --model <model-name> inspect <path>
**Example**

.. code-block:: shell
$ codergpt inspect src/codergpt/
$ codergpt --model gpt-4 inspect src/codergpt/
Inspecting the code.
File Language
------------------------------------------ ----------
Expand Down
10 changes: 5 additions & 5 deletions description.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ <h2>Model Providers Implemented<a class="headerlink" href="#model-providers-impl
<p>The following model providers have been implemented in CoderGPT:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 25.0%" />
<col style="width: 75.0%" />
<col style="width: 25.0%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Provider</p></th>
Expand All @@ -126,10 +126,9 @@ <h2>Model Providers Implemented<a class="headerlink" href="#model-providers-impl
</div>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">OPENAI_API_KEY</span><span class="o">=</span><span class="s1">&#39;your-api-key-here&#39;</span>
<span class="nb">export</span><span class="w"> </span><span class="nv">GOOGLE_API_KEY</span><span class="o">=</span><span class="s1">&#39;your-api-key-here&#39;</span>

Replace<span class="w"> </span><span class="sb">``</span>your-api-key-here<span class="sb">``</span><span class="w"> </span>with<span class="w"> </span>your<span class="w"> </span>actual<span class="w"> </span>OpenAI<span class="w"> </span>and<span class="w"> </span>Google<span class="w"> </span>API<span class="w"> </span>keys.<span class="w"> </span>This<span class="w"> </span>step<span class="w"> </span>is<span class="w"> </span>crucial<span class="w"> </span><span class="k">for</span><span class="w"> </span>the<span class="w"> </span>proper<span class="w"> </span>functioning<span class="w"> </span>of<span class="w"> </span>CoderGPT<span class="w"> </span>as<span class="w"> </span>it<span class="w"> </span>relies<span class="w"> </span>on<span class="w"> </span>OpenAI<span class="w"> </span>and<span class="w"> </span>Google<span class="w"> </span>APIs<span class="w"> </span><span class="k">for</span><span class="w"> </span>generating<span class="w"> </span>and<span class="w"> </span>modifying<span class="w"> </span>code.
</pre></div>
</div>
<p>Replace <code class="docutils literal notranslate"><span class="pre">your-api-key-here</span></code> with your actual OpenAI and Google API keys. This step is crucial for the proper functioning of CoderGPT as it relies on OpenAI and Google APIs for generating and modifying code.</p>
</section>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h2>
Expand Down Expand Up @@ -160,17 +159,18 @@ <h3>Options<a class="headerlink" href="#options" title="Link to this heading">
<li><p><code class="docutils literal notranslate"><span class="pre">-v,</span> <span class="pre">--verbose</span> <span class="pre">INTEGER</span></code>: Set verbosity level (0, 1, or 2).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-q,</span> <span class="pre">--quiet</span></code>: Enable quiet mode.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--version</span></code>: Display version information.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--model</span> <span class="pre">[gpt-3.5-turbo</span> <span class="pre">|</span> <span class="pre">gpt-4</span> <span class="pre">|</span> <span class="pre">gpt-4-turbo</span> <span class="pre">(default)</span> <span class="pre">|</span> <span class="pre">gemini-pro]</span></code>: Set the model provider to use.</p></li>
</ul>
</section>
<section id="commands">
<h3>Commands<a class="headerlink" href="#commands" title="Link to this heading"></a></h3>
<ol class="arabic" id="inspect-command">
<li><p><strong>inspect</strong>: Inspect a package and display a file-language map.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>codergpt<span class="w"> </span>inspect<span class="w"> </span>&lt;path&gt;
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>codergpt<span class="w"> </span>--model<span class="w"> </span>&lt;model-name&gt;<span class="w"> </span>inspect<span class="w"> </span>&lt;path&gt;
</pre></div>
</div>
<p><strong>Example</strong></p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>codergpt<span class="w"> </span>inspect<span class="w"> </span>src/codergpt/
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>codergpt<span class="w"> </span>--model<span class="w"> </span>gpt-4<span class="w"> </span>inspect<span class="w"> </span>src/codergpt/
Inspecting<span class="w"> </span>the<span class="w"> </span>code.
File<span class="w"> </span>Language
------------------------------------------<span class="w"> </span>----------
Expand Down

0 comments on commit 78fc69c

Please sign in to comment.