Deploying to gh-pages from @ 8f752ba 🚀

_sources/installation.rst.txt

@@ -20,3 +20,38 @@ To install in development mode, use the following:
     $ git clone git+https://github.com/INCATools/ontobot-change-agent.git
     $ cd ontobot-change-agent
     $ poetry install
+
+New Features
+------------
+
+.. important::
+
+    In order to make `ontobot-change-agent` capable of using llm models, you could install it with the optional
+    dependency package `llm-change-agent`. This feature is in early development and is not yet ready for general use.
+
+    To install using pip:
+
+    .. code-block:: shell
+
+        $ pip install ontobot_change_agent[llm]
+
+    OR
+
+    .. code-block:: shell
+
+        $ pip install git+https://github.com/INCATools/ontobot-change-agent.git#egg=ontobot_change_agent[llm]
+
+
+    To install in development mode, use the following:
+    .. code-block:: shell
+
+        $ poetry install --extras llm
+
+.. note::
+
+    To leverage the features of `llm-change-agent` package one would need to have any one or all of
+    the environment variables set:
+
+    - `OPENAI_API_KEY`
+    - `ANTHROPIC_API_KEY`
+    - `CBORG_API_KEY` (for LBNL users only)

cli.html

@@ -285,6 +285,12 @@ <h3>process-issue<a class="headerlink" href="#ochange-process-issue" title="Perm
 <dd><p>Output could be a file or sys.stdout.</p>
 </dd></dl>
 
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-ochange-process-issue-use-llm">
+<span id="cmdoption-ochange-process-issue-no-use-llm"></span><span class="sig-name descname"><span class="pre">--use-llm</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--no-use-llm</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ochange-process-issue-use-llm" title="Permalink to this definition"></a></dt>
+<dd><p>Use llm-change-agent for processing.</p>
+</dd></dl>
+
 <p class="rubric">Arguments</p>
 <dl class="std option">
 <dt class="sig sig-object std" id="cmdoption-ochange-process-issue-arg-INPUT">

genindex.html

@@ -110,6 +110,13 @@ <h2 id="Symbols">Symbols</h2>
         <li><a href="cli.html#cmdoption-ochange-issues-l">ochange-issues command line option</a>
 </li>
         <li><a href="cli.html#cmdoption-ochange-process-issue-l">ochange-process-issue command line option</a>
+</li>
+      </ul></li>
+      <li>
+    --no-use-llm
+
+      <ul>
+        <li><a href="cli.html#cmdoption-ochange-process-issue-use-llm">ochange-process-issue command line option</a>
 </li>
       </ul></li>
       <li>
@@ -180,6 +187,13 @@ <h2 id="Symbols">Symbols</h2>
         <li><a href="cli.html#cmdoption-ochange-issues-g">ochange-issues command line option</a>
 </li>
         <li><a href="cli.html#cmdoption-ochange-process-issue-g">ochange-process-issue command line option</a>
+</li>
+      </ul></li>
+      <li>
+    --use-llm
+
+      <ul>
+        <li><a href="cli.html#cmdoption-ochange-process-issue-use-llm">ochange-process-issue command line option</a>
 </li>
       </ul></li>
       <li>
@@ -189,15 +203,15 @@ <h2 id="Symbols">Symbols</h2>
         <li><a href="cli.html#cmdoption-ochange-v">ochange command line option</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     --version
 
       <ul>
         <li><a href="cli.html#cmdoption-ochange-version">ochange command line option</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     -c
 
@@ -420,6 +434,8 @@ <h2 id="O">O</h2>
         <li><a href="cli.html#cmdoption-ochange-process-issue-j">--jar-path</a>
 </li>
         <li><a href="cli.html#cmdoption-ochange-process-issue-l">--label</a>
+</li>
+        <li><a href="cli.html#cmdoption-ochange-process-issue-use-llm">--no-use-llm</a>
 </li>
         <li><a href="cli.html#cmdoption-ochange-process-issue-n">--number</a>
 </li>
@@ -432,6 +448,8 @@ <h2 id="O">O</h2>
         <li><a href="cli.html#cmdoption-ochange-process-issue-s">--state</a>
 </li>
         <li><a href="cli.html#cmdoption-ochange-process-issue-g">--token</a>
+</li>
+        <li><a href="cli.html#cmdoption-ochange-process-issue-use-llm">--use-llm</a>
 </li>
         <li><a href="cli.html#cmdoption-ochange-process-issue-c">-c</a>
 </li>

index.html

@@ -85,7 +85,10 @@ <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Perm
 <p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="installation.html#new-features">New Features</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="first_run.html">First Run</a></li>
 <li class="toctree-l1"><a class="reference internal" href="implementation.html">Implementation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="implementation.html#step-1-github-workflow-setup">Step 1: GitHub Workflow Setup</a></li>

installation.html

@@ -46,7 +46,10 @@
               <p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#new-features">New Features</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="first_run.html">First Run</a></li>
 <li class="toctree-l1"><a class="reference internal" href="implementation.html">Implementation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="developers.html">For Developers</a></li>
@@ -95,6 +98,37 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
 $<span class="w"> </span>poetry<span class="w"> </span>install
 </pre></div>
 </div>
+<section id="new-features">
+<h2>New Features<a class="headerlink" href="#new-features" title="Permalink to this heading"></a></h2>
+<div class="admonition important">
+<p class="admonition-title">Important</p>
+<p>In order to make <cite>ontobot-change-agent</cite> capable of using llm models, you could install it with the optional
+dependency package <cite>llm-change-agent</cite>. This feature is in early development and is not yet ready for general use.</p>
+<p>To install using pip:</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>ontobot_change_agent<span class="o">[</span>llm<span class="o">]</span>
+</pre></div>
+</div>
+<p>OR</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>git+https://github.com/INCATools/ontobot-change-agent.git#egg<span class="o">=</span>ontobot_change_agent<span class="o">[</span>llm<span class="o">]</span>
+</pre></div>
+</div>
+<p>To install in development mode, use the following:
+.. code-block:: shell</p>
+<blockquote>
+<div><p>$ poetry install –extras llm</p>
+</div></blockquote>
+</div>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>To leverage the features of <cite>llm-change-agent</cite> package one would need to have any one or all of
+the environment variables set:</p>
+<ul class="simple">
+<li><p><cite>OPENAI_API_KEY</cite></p></li>
+<li><p><cite>ANTHROPIC_API_KEY</cite></p></li>
+<li><p><cite>CBORG_API_KEY</cite> (for LBNL users only)</p></li>
+</ul>
+</div>
+</section>
 </section>