Skip to content

Commit 562e264

Browse files
actions-useractions-user
committed
Update documentation
1 parent c552600 commit 562e264

File tree

115 files changed

+13795
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

115 files changed

+13795
-0
lines changed

‎.nojekyll‎

Whitespace-only changes.

‎_images/prompt-session.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎_modules/danoan/llm_assistant/cli/cli.html‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" data-content_root="../../../../">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>danoan.llm_assistant.cli.cli &mdash; llm-assistant 0.2.0 documentation</title>
7+
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=80d5e7a1" />
8+
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=19f00094" />
9+
<link rel="stylesheet" type="text/css" href="../../../../_static/css/custom.css?v=a3d76245" />
10+
11+
12+
<!--[if lt IE 9]>
13+
<script src="../../../../_static/js/html5shiv.min.js"></script>
14+
<![endif]-->
15+
16+
<script src="../../../../_static/jquery.js?v=5d32c60e"></script>
17+
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
18+
<script src="../../../../_static/documentation_options.js?v=938c9ccc"></script>
19+
<script src="../../../../_static/doctools.js?v=9a2dae69"></script>
20+
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
21+
<script src="https://unpkg.com/mermaid@10.2.0/dist/mermaid.min.js"></script>
22+
<script>mermaid.initialize({startOnLoad:true});</script>
23+
<script src="../../../../_static/js/theme.js"></script>
24+
<link rel="index" title="Index" href="../../../../genindex.html" />
25+
<link rel="search" title="Search" href="../../../../search.html" />
26+
</head>
27+
28+
<body class="wy-body-for-nav">
29+
<div class="wy-grid-for-nav">
30+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
31+
<div class="wy-side-scroll">
32+
<div class="wy-side-nav-search" >
33+
34+
35+
36+
<a href="../../../../index.html" class="icon icon-home">
37+
llm-assistant
38+
</a>
39+
<div class="version">
40+
0.2.0
41+
</div>
42+
<div role="search">
43+
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
44+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
45+
<input type="hidden" name="check_keywords" value="yes" />
46+
<input type="hidden" name="area" value="default" />
47+
</form>
48+
</div>
49+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="../../../../getting-started.html">Getting started with LLM Assistant</a></li>
52+
</ul>
53+
<ul>
54+
<li class="toctree-l1"><a class="reference internal" href="../../../../api-reference.html">API Reference</a></li>
55+
</ul>
56+
<ul>
57+
<li class="toctree-l1"><a class="reference internal" href="../../../../design-and-architecture.html">Design and Architecture</a></li>
58+
</ul>
59+
60+
</div>
61+
</div>
62+
</nav>
63+
64+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
65+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
66+
<a href="../../../../index.html">llm-assistant</a>
67+
</nav>
68+
69+
<div class="wy-nav-content">
70+
<div class="rst-content">
71+
<div role="navigation" aria-label="Page navigation">
72+
<ul class="wy-breadcrumbs">
73+
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
74+
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
75+
<li class="breadcrumb-item active">danoan.llm_assistant.cli.cli</li>
76+
<li class="wy-breadcrumbs-aside">
77+
</li>
78+
</ul>
79+
<hr/>
80+
</div>
81+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
82+
<div itemprop="articleBody">
83+
84+
<h1>Source code for danoan.llm_assistant.cli.cli</h1><div class="highlight"><pre>
85+
<span></span><span class="kn">from</span> <span class="nn">danoan.llm_assistant.cli.commands.custom</span> <span class="kn">import</span> <span class="n">custom_parser</span> <span class="k">as</span> <span class="n">custom</span>
86+
<span class="kn">from</span> <span class="nn">danoan.llm_assistant.cli.commands.session</span> <span class="kn">import</span> <span class="n">session_parser</span> <span class="k">as</span> <span class="n">session</span>
87+
<span class="kn">from</span> <span class="nn">danoan.llm_assistant.cli.commands.setup</span> <span class="kn">import</span> <span class="n">setup</span>
88+
89+
<span class="kn">import</span> <span class="nn">argparse</span>
90+
91+
92+
<div class="viewcode-block" id="main">
93+
<a class="viewcode-back" href="../../../../reference/danoan.llm_assistant.cli.cli.html#danoan.llm_assistant.cli.cli.main">[docs]</a>
94+
<span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
95+
<span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">(</span>
96+
<span class="s2">&quot;llm-assistant&quot;</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s2">&quot;Collection of LLM applications&quot;</span>
97+
<span class="p">)</span>
98+
<span class="n">subcommand_action</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">add_subparsers</span><span class="p">()</span>
99+
100+
<span class="n">list_of_commands</span> <span class="o">=</span> <span class="p">[</span><span class="n">setup</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">custom</span><span class="p">]</span>
101+
<span class="k">for</span> <span class="n">command</span> <span class="ow">in</span> <span class="n">list_of_commands</span><span class="p">:</span>
102+
<span class="n">command</span><span class="o">.</span><span class="n">extend_parser</span><span class="p">(</span><span class="n">subcommand_action</span><span class="p">)</span>
103+
104+
<span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()</span>
105+
<span class="k">if</span> <span class="s2">&quot;func&quot;</span> <span class="ow">in</span> <span class="n">args</span><span class="p">:</span>
106+
<span class="n">args</span><span class="o">.</span><span class="n">func</span><span class="p">(</span><span class="o">**</span><span class="nb">vars</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
107+
<span class="k">elif</span> <span class="s2">&quot;subommand_help&quot;</span> <span class="ow">in</span> <span class="n">args</span><span class="p">:</span>
108+
<span class="n">args</span><span class="o">.</span><span class="n">subommand_help</span><span class="p">()</span>
109+
<span class="k">else</span><span class="p">:</span>
110+
<span class="n">parser</span><span class="o">.</span><span class="n">print_help</span><span class="p">()</span></div>
111+
112+
113+
114+
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;__main__&quot;</span><span class="p">:</span>
115+
<span class="n">main</span><span class="p">()</span>
116+
</pre></div>
117+
118+
</div>
119+
</div>
120+
<footer>
121+
122+
<hr/>
123+
124+
<div role="contentinfo">
125+
<p>&#169; Copyright 2024, Daniel Martins Antunes.</p>
126+
</div>
127+
128+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
129+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
130+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
131+
132+
133+
</footer>
134+
</div>
135+
</div>
136+
</section>
137+
</div>
138+
<script>
139+
jQuery(function () {
140+
SphinxRtdTheme.Navigation.enable(true);
141+
});
142+
</script>
143+
144+
</body>
145+
</html>

‎_modules/danoan/llm_assistant/cli/commands/custom/custom.html‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" data-content_root="../../../../../../">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>danoan.llm_assistant.cli.commands.custom.custom &mdash; llm-assistant 0.2.0 documentation</title>
7+
<link rel="stylesheet" type="text/css" href="../../../../../../_static/pygments.css?v=80d5e7a1" />
8+
<link rel="stylesheet" type="text/css" href="../../../../../../_static/css/theme.css?v=19f00094" />
9+
<link rel="stylesheet" type="text/css" href="../../../../../../_static/css/custom.css?v=a3d76245" />
10+
11+
12+
<!--[if lt IE 9]>
13+
<script src="../../../../../../_static/js/html5shiv.min.js"></script>
14+
<![endif]-->
15+
16+
<script src="../../../../../../_static/jquery.js?v=5d32c60e"></script>
17+
<script src="../../../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
18+
<script src="../../../../../../_static/documentation_options.js?v=938c9ccc"></script>
19+
<script src="../../../../../../_static/doctools.js?v=9a2dae69"></script>
20+
<script src="../../../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
21+
<script src="https://unpkg.com/mermaid@10.2.0/dist/mermaid.min.js"></script>
22+
<script>mermaid.initialize({startOnLoad:true});</script>
23+
<script src="../../../../../../_static/js/theme.js"></script>
24+
<link rel="index" title="Index" href="../../../../../../genindex.html" />
25+
<link rel="search" title="Search" href="../../../../../../search.html" />
26+
</head>
27+
28+
<body class="wy-body-for-nav">
29+
<div class="wy-grid-for-nav">
30+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
31+
<div class="wy-side-scroll">
32+
<div class="wy-side-nav-search" >
33+
34+
35+
36+
<a href="../../../../../../index.html" class="icon icon-home">
37+
llm-assistant
38+
</a>
39+
<div class="version">
40+
0.2.0
41+
</div>
42+
<div role="search">
43+
<form id="rtd-search-form" class="wy-form" action="../../../../../../search.html" method="get">
44+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
45+
<input type="hidden" name="check_keywords" value="yes" />
46+
<input type="hidden" name="area" value="default" />
47+
</form>
48+
</div>
49+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="../../../../../../getting-started.html">Getting started with LLM Assistant</a></li>
52+
</ul>
53+
<ul>
54+
<li class="toctree-l1"><a class="reference internal" href="../../../../../../api-reference.html">API Reference</a></li>
55+
</ul>
56+
<ul>
57+
<li class="toctree-l1"><a class="reference internal" href="../../../../../../design-and-architecture.html">Design and Architecture</a></li>
58+
</ul>
59+
60+
</div>
61+
</div>
62+
</nav>
63+
64+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
65+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
66+
<a href="../../../../../../index.html">llm-assistant</a>
67+
</nav>
68+
69+
<div class="wy-nav-content">
70+
<div class="rst-content">
71+
<div role="navigation" aria-label="Page navigation">
72+
<ul class="wy-breadcrumbs">
73+
<li><a href="../../../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
74+
<li class="breadcrumb-item"><a href="../../../../../index.html">Module code</a></li>
75+
<li class="breadcrumb-item active">danoan.llm_assistant.cli.commands.custom.custom</li>
76+
<li class="wy-breadcrumbs-aside">
77+
</li>
78+
</ul>
79+
<hr/>
80+
</div>
81+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
82+
<div itemprop="articleBody">
83+
84+
<h1>Source code for danoan.llm_assistant.cli.commands.custom.custom</h1><div class="highlight"><pre>
85+
<span></span><span class="kn">from</span> <span class="nn">danoan.llm_assistant.core</span> <span class="kn">import</span> <span class="n">api</span><span class="p">,</span> <span class="n">model</span>
86+
87+
<span class="kn">import</span> <span class="nn">logging</span>
88+
<span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>
89+
<span class="kn">import</span> <span class="nn">sys</span>
90+
<span class="kn">import</span> <span class="nn">json</span>
91+
<span class="kn">import</span> <span class="nn">toml</span>
92+
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TextIO</span>
93+
94+
<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
95+
<span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span>
96+
<span class="n">handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">)</span>
97+
<span class="n">handler</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span>
98+
<span class="n">logger</span><span class="o">.</span><span class="n">addHandler</span><span class="p">(</span><span class="n">handler</span><span class="p">)</span>
99+
100+
101+
<div class="viewcode-block" id="custom">
102+
<a class="viewcode-back" href="../../../../../../reference/danoan.llm_assistant.cli.commands.custom.custom.html#danoan.llm_assistant.cli.commands.custom.custom.custom">[docs]</a>
103+
<span class="k">def</span> <span class="nf">custom</span><span class="p">(</span><span class="n">prompt_configuration_filepath</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">prompt_instance_data</span><span class="p">:</span> <span class="n">TextIO</span><span class="p">):</span>
104+
<span class="n">config</span> <span class="o">=</span> <span class="n">api</span><span class="o">.</span><span class="n">get_configuration</span><span class="p">()</span>
105+
<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">config</span><span class="p">)</span>
106+
107+
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">prompt_configuration_filepath</span><span class="p">,</span> <span class="s2">&quot;r&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">file_pc</span><span class="p">:</span>
108+
<span class="n">prompt_configuration</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">PromptConfiguration</span><span class="p">(</span><span class="o">**</span><span class="n">toml</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">file_pc</span><span class="p">))</span>
109+
<span class="n">prompt_instance</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_instance_data</span><span class="p">)</span>
110+
111+
<span class="n">response</span> <span class="o">=</span> <span class="n">api</span><span class="o">.</span><span class="n">custom</span><span class="p">(</span><span class="n">prompt_configuration</span><span class="p">,</span> <span class="o">**</span><span class="n">prompt_instance</span><span class="p">)</span>
112+
<span class="k">return</span> <span class="n">response</span></div>
113+
114+
</pre></div>
115+
116+
</div>
117+
</div>
118+
<footer>
119+
120+
<hr/>
121+
122+
<div role="contentinfo">
123+
<p>&#169; Copyright 2024, Daniel Martins Antunes.</p>
124+
</div>
125+
126+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
127+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
128+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
129+
130+
131+
</footer>
132+
</div>
133+
</div>
134+
</section>
135+
</div>
136+
<script>
137+
jQuery(function () {
138+
SphinxRtdTheme.Navigation.enable(true);
139+
});
140+
</script>
141+
142+
</body>
143+
</html>

0 commit comments

Comments
 (0)