Deploying to gh-pages from @ microsoft/graphrag@7ffce8d7ba 🚀

This commit is contained in:
AlonsoGuevara 2024-08-29 22:57:29 +00:00
parent 7db09c3ae0
commit 5523b22f91

View File

@ -292,7 +292,7 @@ a {
<p>GraphRAG provides the ability to create domain adapted prompts for the generation of the knowledge graph. This step is optional, though it is highly encouraged to run it as it will yield better results when executing an Index Run.</p>
<p>These are generated by loading the inputs, splitting them into chunks (text units) and then running a series of LLM invocations and template substitutions to generate the final prompts. We suggest using the default values provided by the script, but in this page you'll find the detail of each in case you want to further explore and tweak the prompt tuning algorithm.</p>
<p align="center">
<img src="../../img/auto-tune-diagram.png" alt="Figure 1: Auto Tuning Conceptual Diagram." width="450" align="center">
<img src="../../../img/auto-tune-diagram.png" alt="Figure 1: Auto Tuning Conceptual Diagram." width="450" align="center">
</p>
<p align="center">
Figure 1: Auto Tuning Conceptual Diagram.
@ -303,7 +303,9 @@ Figure 1: Auto Tuning Conceptual Diagram.
<p>You can run the main script from the command line with various options:</p>
<div style="position: relative">
<pre class="language-bash"><code id="code-19" class="language-bash">python <span class="token parameter variable">-m</span> graphrag.prompt_tune <span class="token punctuation">[</span>--root ROOT<span class="token punctuation">]</span> <span class="token punctuation">[</span>--domain DOMAIN<span class="token punctuation">]</span> <span class="token punctuation">[</span>--method METHOD<span class="token punctuation">]</span> <span class="token punctuation">[</span>--limit LIMIT<span class="token punctuation">]</span> <span class="token punctuation">[</span>--language <span class="token environment constant">LANGUAGE</span><span class="token punctuation">]</span> <span class="token punctuation">[</span>--max-tokens MAX_TOKENS<span class="token punctuation">]</span> <span class="token punctuation">[</span>--chunk-size CHUNK_SIZE<span class="token punctuation">]</span> <span class="token punctuation">[</span>--n-subset-max N_SUBSET_MAX<span class="token punctuation">]</span> <span class="token punctuation">[</span>--k K<span class="token punctuation">]</span> <span class="token punctuation">[</span>--min-examples-required MIN_EXAMPLES_REQUIRED<span class="token punctuation">]</span> <span class="token punctuation">[</span>--no-entity-types<span class="token punctuation">]</span> <span class="token punctuation">[</span>--output OUTPUT<span class="token punctuation">]</span></code></pre>
<pre class="language-bash"><code id="code-19" class="language-bash">python <span class="token parameter variable">-m</span> graphrag.prompt_tune <span class="token punctuation">[</span>--root ROOT<span class="token punctuation">]</span> <span class="token punctuation">[</span>--domain DOMAIN<span class="token punctuation">]</span> <span class="token punctuation">[</span>--method METHOD<span class="token punctuation">]</span> <span class="token punctuation">[</span>--limit LIMIT<span class="token punctuation">]</span> <span class="token punctuation">[</span>--language <span class="token environment constant">LANGUAGE</span><span class="token punctuation">]</span> <span class="token punctuation">\</span>
<span class="token punctuation">[</span>--max-tokens MAX_TOKENS<span class="token punctuation">]</span> <span class="token punctuation">[</span>--chunk-size CHUNK_SIZE<span class="token punctuation">]</span> <span class="token punctuation">[</span>--n-subset-max N_SUBSET_MAX<span class="token punctuation">]</span> <span class="token punctuation">[</span>--k K<span class="token punctuation">]</span> <span class="token punctuation">\</span>
<span class="token punctuation">[</span>--min-examples-required MIN_EXAMPLES_REQUIRED<span class="token punctuation">]</span> <span class="token punctuation">[</span>--no-entity-types<span class="token punctuation">]</span> <span class="token punctuation">[</span>--output OUTPUT<span class="token punctuation">]</span></code></pre>
<button class="code-copy " data-clipboard-target="#code-19" style="position: absolute; top: 7.5px; right: 6px; padding-top: 3px; cursor: pointer; outline: none; opacity: 0.8;" title="Copy">
<span style="display:inline-block;background:url(https://api.iconify.design/mdi/content-copy.svg) no-repeat center center / contain;width: 16px; height: 16px;" class=""></span>
@ -354,7 +356,9 @@ Figure 1: Auto Tuning Conceptual Diagram.
<h2>Example Usage</h2>
<div style="position: relative">
<pre class="language-bash"><code id="code-93" class="language-bash">python <span class="token parameter variable">-m</span> graphrag.prompt_tune <span class="token parameter variable">--root</span> /path/to/project <span class="token parameter variable">--config</span> /path/to/settings.yaml <span class="token parameter variable">--domain</span> <span class="token string">"environmental news"</span> <span class="token parameter variable">--method</span> random <span class="token parameter variable">--limit</span> <span class="token number">10</span> <span class="token parameter variable">--language</span> English --max-tokens <span class="token number">2048</span> --chunk-size <span class="token number">256</span> --min-examples-required <span class="token number">3</span> --no-entity-types <span class="token parameter variable">--output</span> /path/to/output</code></pre>
<pre class="language-bash"><code id="code-93" class="language-bash">python <span class="token parameter variable">-m</span> graphrag.prompt_tune <span class="token parameter variable">--root</span> /path/to/project <span class="token parameter variable">--config</span> /path/to/settings.yaml <span class="token parameter variable">--domain</span> <span class="token string">"environmental news"</span> <span class="token punctuation">\</span>
<span class="token parameter variable">--method</span> random <span class="token parameter variable">--limit</span> <span class="token number">10</span> <span class="token parameter variable">--language</span> English --max-tokens <span class="token number">2048</span> --chunk-size <span class="token number">256</span> --min-examples-required <span class="token number">3</span> <span class="token punctuation">\</span>
--no-entity-types <span class="token parameter variable">--output</span> /path/to/output</code></pre>
<button class="code-copy " data-clipboard-target="#code-93" style="position: absolute; top: 7.5px; right: 6px; padding-top: 3px; cursor: pointer; outline: none; opacity: 0.8;" title="Copy">
<span style="display:inline-block;background:url(https://api.iconify.design/mdi/content-copy.svg) no-repeat center center / contain;width: 16px; height: 16px;" class=""></span>