Skip to content

Commit e37866e

Browse files
actions-useractions-user
committed
Update documentation
1 parent 70a072c commit e37866e

19 files changed

+354
-37
lines changed

‎_modules/danoan/llm_assistant/common/utils.html‎

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="writer-html5" lang="en" data-content_root="../../../../">
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
<title>danoan.llm_assistant.common.utils &mdash; llm-assistant 0.5.0 documentation</title>
9+
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=b86133f3" />
10+
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
11+
<link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css?v=a3d76245" />
12+
13+
14+
<script src="../../../../_static/jquery.js?v=5d32c60e"></script>
15+
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16+
<script src="../../../../_static/documentation_options.js?v=1dd76d02"></script>
17+
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
18+
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
19+
<script type="module" src="https://cdn.jsdelivr.net/npm/mermaid@11.2.0/dist/mermaid.esm.min.mjs"></script>
20+
<script type="module" src="https://cdn.jsdelivr.net/npm/@mermaid-js/layout-elk@0.1.4/dist/mermaid-layout-elk.esm.min.mjs"></script>
21+
<script type="module">import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@11.2.0/dist/mermaid.esm.min.mjs";import elkLayouts from "https://cdn.jsdelivr.net/npm/@mermaid-js/layout-elk@0.1.4/dist/mermaid-layout-elk.esm.min.mjs";mermaid.registerLayoutLoaders(elkLayouts);mermaid.initialize({startOnLoad:false});</script>
22+
<script src="https://cdn.jsdelivr.net/npm/d3@7.9.0/dist/d3.min.js"></script>
23+
<script type="module">
24+
import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@11.2.0/dist/mermaid.esm.min.mjs";
25+
window.addEventListener("load", () => mermaid.run());
26+
</script>
27+
<script src="../../../../_static/js/theme.js"></script>
28+
<link rel="index" title="Index" href="../../../../genindex.html" />
29+
<link rel="search" title="Search" href="../../../../search.html" />
30+
</head>
31+
32+
<body class="wy-body-for-nav">
33+
<div class="wy-grid-for-nav">
34+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
35+
<div class="wy-side-scroll">
36+
<div class="wy-side-nav-search" >
37+
38+
39+
40+
<a href="../../../../index.html" class="icon icon-home">
41+
llm-assistant
42+
</a>
43+
<div role="search">
44+
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
45+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
46+
<input type="hidden" name="check_keywords" value="yes" />
47+
<input type="hidden" name="area" value="default" />
48+
</form>
49+
</div>
50+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
51+
<ul>
52+
<li class="toctree-l1"><a class="reference internal" href="../../../../getting-started.html">Getting started with LLM Assistant</a></li>
53+
</ul>
54+
<ul>
55+
<li class="toctree-l1"><a class="reference internal" href="../../../../how-to/setup-assistant.html">How to setup llm-assistant</a></li>
56+
<li class="toctree-l1"><a class="reference internal" href="../../../../how-to/run-a-prompt.html">How to run a prompt</a></li>
57+
<li class="toctree-l1"><a class="reference internal" href="../../../../how-to/sync-and-push-prompts.html">How to sync and push prompts</a></li>
58+
</ul>
59+
<ul>
60+
<li class="toctree-l1"><a class="reference internal" href="../../../../api-reference.html">API Reference</a></li>
61+
</ul>
62+
<ul>
63+
<li class="toctree-l1"><a class="reference internal" href="../../../../design-and-architecture.html">Design and Architecture</a></li>
64+
</ul>
65+
66+
</div>
67+
</div>
68+
</nav>
69+
70+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
71+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
72+
<a href="../../../../index.html">llm-assistant</a>
73+
</nav>
74+
75+
<div class="wy-nav-content">
76+
<div class="rst-content">
77+
<div role="navigation" aria-label="Page navigation">
78+
<ul class="wy-breadcrumbs">
79+
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
80+
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
81+
<li class="breadcrumb-item active">danoan.llm_assistant.common.utils</li>
82+
<li class="wy-breadcrumbs-aside">
83+
</li>
84+
</ul>
85+
<hr/>
86+
</div>
87+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
88+
<div itemprop="articleBody">
89+
90+
<h1>Source code for danoan.llm_assistant.common.utils</h1><div class="highlight"><pre>
91+
<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.common.model</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
92+
<span class="n">RunnerConfiguration</span><span class="p">,</span>
93+
<span class="n">PromptRepositoryConfiguration</span><span class="p">,</span>
94+
<span class="p">)</span>
95+
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.common.config</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_absolute_configuration_path</span>
96+
97+
<span class="kn">from</span><span class="w"> </span><span class="nn">copy</span><span class="w"> </span><span class="kn">import</span> <span class="n">deepcopy</span>
98+
99+
100+
<div class="viewcode-block" id="generate_absolute_runner_config">
101+
<a class="viewcode-back" href="../../../../reference/danoan.llm_assistant.common.utils.html#danoan.llm_assistant.common.utils.generate_absolute_runner_config">[docs]</a>
102+
<span class="k">def</span><span class="w"> </span><span class="nf">generate_absolute_runner_config</span><span class="p">(</span><span class="n">runner_config</span><span class="p">:</span> <span class="n">RunnerConfiguration</span><span class="p">):</span>
103+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
104+
<span class="sd"> Resolve all paths in the runner configuration to absolute paths.</span>
105+
106+
<span class="sd"> This requires llm-assistant-config.toml to be defined.</span>
107+
<span class="sd"> &quot;&quot;&quot;</span>
108+
<span class="n">runner_config_copy</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">runner_config</span><span class="p">)</span>
109+
<span class="n">runner_config_copy</span><span class="o">.</span><span class="n">cache_path</span> <span class="o">=</span> <span class="n">get_absolute_configuration_path</span><span class="p">(</span>
110+
<span class="n">runner_config_copy</span><span class="o">.</span><span class="n">cache_path</span>
111+
<span class="p">)</span>
112+
113+
<span class="k">return</span> <span class="n">runner_config_copy</span></div>
114+
115+
116+
117+
<div class="viewcode-block" id="generate_absolute_prompt_config">
118+
<a class="viewcode-back" href="../../../../reference/danoan.llm_assistant.common.utils.html#danoan.llm_assistant.common.utils.generate_absolute_prompt_config">[docs]</a>
119+
<span class="k">def</span><span class="w"> </span><span class="nf">generate_absolute_prompt_config</span><span class="p">(</span><span class="n">prompt_repo_config</span><span class="p">:</span> <span class="n">PromptRepositoryConfiguration</span><span class="p">):</span>
120+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
121+
<span class="sd"> Resolve all paths in the prompt repository configuration to absolute paths.</span>
122+
123+
<span class="sd"> This requires llm-assistant-config.toml to be defined.</span>
124+
<span class="sd"> &quot;&quot;&quot;</span>
125+
<span class="n">prompt_repo_config_copy</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">prompt_repo_config</span><span class="p">)</span>
126+
<span class="n">prompt_repo_config_copy</span><span class="o">.</span><span class="n">prompt_collection_folder</span> <span class="o">=</span> <span class="n">get_absolute_configuration_path</span><span class="p">(</span>
127+
<span class="n">prompt_repo_config_copy</span><span class="o">.</span><span class="n">prompt_collection_folder</span>
128+
<span class="p">)</span>
129+
130+
<span class="k">return</span> <span class="n">prompt_repo_config_copy</span></div>
131+
132+
</pre></div>
133+
134+
</div>
135+
</div>
136+
<footer>
137+
138+
<hr/>
139+
140+
<div role="contentinfo">
141+
<p>&#169; Copyright 2024, Daniel Martins Antunes.</p>
142+
</div>
143+
144+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
145+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
146+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
147+
148+
149+
</footer>
150+
</div>
151+
</div>
152+
</section>
153+
</div>
154+
<script>
155+
jQuery(function () {
156+
SphinxRtdTheme.Navigation.enable(true);
157+
});
158+
</script>
159+
160+
</body>
161+
</html>

‎_modules/danoan/llm_assistant/prompt/cli/commands/evaluate/commands/regenerate_tests/action.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
<h1>Source code for danoan.llm_assistant.prompt.cli.commands.evaluate.commands.regenerate_tests.action</h1><div class="highlight"><pre>
9191
<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.common.logging_config</span><span class="w"> </span><span class="kn">import</span> <span class="n">setup_logging</span>
9292
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.common</span><span class="w"> </span><span class="kn">import</span> <span class="n">config</span>
93+
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.common</span><span class="w"> </span><span class="kn">import</span> <span class="n">utils</span>
9394
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.prompt.core</span><span class="w"> </span><span class="kn">import</span> <span class="n">api</span>
9495
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.runner.core</span><span class="w"> </span><span class="kn">import</span> <span class="n">api</span> <span class="k">as</span> <span class="n">runner</span>
9596
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.runner.core</span><span class="w"> </span><span class="kn">import</span> <span class="n">api</span> <span class="k">as</span> <span class="n">llma</span>
@@ -106,7 +107,9 @@ <h1>Source code for danoan.llm_assistant.prompt.cli.commands.evaluate.commands.r
106107

107108
<span class="k">def</span><span class="w"> </span><span class="nf">__regenerate_tests__</span><span class="p">(</span><span class="n">prompt_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
108109
<span class="n">runner_configuration</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">get_configuration</span><span class="p">()</span><span class="o">.</span><span class="n">runner</span>
109-
<span class="n">runner</span><span class="o">.</span><span class="n">LLMAssistant</span><span class="p">()</span><span class="o">.</span><span class="n">setup</span><span class="p">(</span><span class="n">runner_configuration</span><span class="p">)</span>
110+
<span class="n">runner</span><span class="o">.</span><span class="n">LLMAssistant</span><span class="p">()</span><span class="o">.</span><span class="n">setup</span><span class="p">(</span>
111+
<span class="n">utils</span><span class="o">.</span><span class="n">generate_absolute_runner_config</span><span class="p">(</span><span class="n">runner_configuration</span><span class="p">)</span>
112+
<span class="p">)</span>
110113
<span class="n">prompt_config</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">get_prompt_configuration</span><span class="p">(</span><span class="n">prompt_name</span><span class="p">)</span>
111114

112115
<span class="n">test_model</span> <span class="o">=</span> <span class="n">api</span><span class="o">.</span><span class="n">get_prompt_test_regression_filepath</span><span class="p">(</span><span class="n">prompt_name</span><span class="p">)</span>

‎_modules/danoan/llm_assistant/prompt/cli/commands/evaluate/commands/run_tests/action.html‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ <h1>Source code for danoan.llm_assistant.prompt.cli.commands.evaluate.commands.r
9191
<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.common.logging_config</span><span class="w"> </span><span class="kn">import</span> <span class="n">setup_logging</span>
9292
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.common.model</span><span class="w"> </span><span class="kn">import</span> <span class="n">PromptConfiguration</span><span class="p">,</span> <span class="n">RunnerConfiguration</span>
9393
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.common</span><span class="w"> </span><span class="kn">import</span> <span class="n">config</span>
94+
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.common</span><span class="w"> </span><span class="kn">import</span> <span class="n">utils</span>
95+
9496
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.prompt.cli</span><span class="w"> </span><span class="kn">import</span> <span class="n">utils</span> <span class="k">as</span> <span class="n">cli_utils</span>
9597
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.prompt.core</span><span class="w"> </span><span class="kn">import</span> <span class="n">api</span>
9698
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.runner.core</span><span class="w"> </span><span class="kn">import</span> <span class="n">api</span> <span class="k">as</span> <span class="n">llma</span>
@@ -171,7 +173,9 @@ <h1>Source code for danoan.llm_assistant.prompt.cli.commands.evaluate.commands.r
171173
<span class="p">):</span>
172174
<span class="n">runner_configuration</span> <span class="o">=</span> <span class="n">config</span><span class="o">.</span><span class="n">get_configuration</span><span class="p">()</span><span class="o">.</span><span class="n">runner</span>
173175
<span class="n">runner_configuration</span><span class="o">.</span><span class="n">use_cache</span> <span class="o">=</span> <span class="n">use_cache</span>
174-
<span class="n">llma</span><span class="o">.</span><span class="n">LLMAssistant</span><span class="p">()</span><span class="o">.</span><span class="n">setup</span><span class="p">(</span><span class="n">runner_configuration</span><span class="p">)</span>
176+
<span class="n">llma</span><span class="o">.</span><span class="n">LLMAssistant</span><span class="p">()</span><span class="o">.</span><span class="n">setup</span><span class="p">(</span>
177+
<span class="n">utils</span><span class="o">.</span><span class="n">generate_absolute_runner_config</span><span class="p">(</span><span class="n">runner_configuration</span><span class="p">)</span>
178+
<span class="p">)</span>
175179

176180
<span class="k">try</span><span class="p">:</span>
177181
<span class="k">for</span> <span class="n">base_response_str</span><span class="p">,</span> <span class="n">compare_response_str</span> <span class="ow">in</span> <span class="n">__run_tests__</span><span class="p">(</span>

‎_modules/danoan/llm_assistant/runner/cli/commands/run/run.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@
8989

9090
<h1>Source code for danoan.llm_assistant.runner.cli.commands.run.run</h1><div class="highlight"><pre>
9191
<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.common.logging_config</span><span class="w"> </span><span class="kn">import</span> <span class="n">setup_logging</span>
92-
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.common</span><span class="w"> </span><span class="kn">import</span> <span class="n">model</span>
92+
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.common</span><span class="w"> </span><span class="kn">import</span> <span class="n">model</span><span class="p">,</span> <span class="n">utils</span>
9393
<span class="kn">from</span><span class="w"> </span><span class="nn">danoan.llm_assistant.runner.core</span><span class="w"> </span><span class="kn">import</span> <span class="n">api</span>
9494

9595
<span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
@@ -108,7 +108,9 @@ <h1>Source code for danoan.llm_assistant.runner.cli.commands.run.run</h1><div cl
108108
<span class="n">prompt_input</span><span class="p">:</span> <span class="n">TextIO</span><span class="p">,</span>
109109
<span class="n">prompt_param</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]]],</span>
110110
<span class="p">):</span>
111-
<span class="n">api</span><span class="o">.</span><span class="n">LLMAssistant</span><span class="p">()</span><span class="o">.</span><span class="n">setup</span><span class="p">(</span><span class="n">runner_configuration</span><span class="p">)</span>
111+
<span class="n">api</span><span class="o">.</span><span class="n">LLMAssistant</span><span class="p">()</span><span class="o">.</span><span class="n">setup</span><span class="p">(</span>
112+
<span class="n">utils</span><span class="o">.</span><span class="n">generate_absolute_runner_config</span><span class="p">(</span><span class="n">runner_configuration</span><span class="p">)</span>
113+
<span class="p">)</span>
112114

113115
<span class="n">input_obj</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">prompt_input</span><span class="p">)</span>
114116
<span class="k">if</span> <span class="n">prompt_param</span><span class="p">:</span>

0 commit comments

Comments
 (0)