WIP

Author: johann-petrak

docs/llms_wrapper/config.html

@@ -131,6 +131,9 @@ <h2 class="section-title" id="header-functions">Functions</h2>
             llm = llm[&#34;llm&#34;]
         if not re.match(r&#34;^[a-zA-Z0-9]+/.+$&#34;, llm):
             raise ValueError(f&#34;Error: &#39;llm&#39; field must be in the format &#39;provider/model&#39; in line: {llm}&#34;)
+        # add known additional configuration fields: these can get specified using a name like e.g. cost_per_prompt_token
+        # but get stored in the config as _cost_per_prompt_token to avoid passing them to the LLM.
+        # All other fields, i.e. fields with unknown names are passed to the LLM as is.
     for provider, provider_config in config[&#39;providers&#39;].items():
         # provider name must be one of the supported providers by litellm
         if provider not in LITELLM_CHAT_PROVIDERS:

docs/llms_wrapper/index.html

@@ -53,11 +53,16 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 <div class="desc"><p>Module for the llms_wrapper_test command to perform a simple test to check
 if one or more LLMs are working.</p></div>
 </dd>
-<dt><code class="name"><a title="llms_wrapper.logging" href="logging.html">llms_wrapper.logging</a></code></dt>
+<dt><code class="name"><a title="llms_wrapper.log" href="log.html">llms_wrapper.log</a></code></dt>
 <dd>
 <div class="desc"><p>Module to handle logging. This module is used to set up the logging for the entire package.
 NOTE: by default, loguru logging is disabled for the …</p></div>
 </dd>
+<dt><code class="name"><a title="llms_wrapper.model_list" href="model_list.html">llms_wrapper.model_list</a></code></dt>
+<dd>
+<div class="desc"><p>Module which implements an approach to find the available models for a provider, trying to use the
+underlying API if possible, and falling back to …</p></div>
+</dd>
 <dt><code class="name"><a title="llms_wrapper.utils" href="utils.html">llms_wrapper.utils</a></code></dt>
 <dd>
 <div class="desc"><p>Module for various utility functions.</p></div>
@@ -85,7 +90,8 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 <li><code><a title="llms_wrapper.config" href="config.html">llms_wrapper.config</a></code></li>
 <li><code><a title="llms_wrapper.llms" href="llms.html">llms_wrapper.llms</a></code></li>
 <li><code><a title="llms_wrapper.llms_wrapper_test" href="llms_wrapper_test.html">llms_wrapper.llms_wrapper_test</a></code></li>
-<li><code><a title="llms_wrapper.logging" href="logging.html">llms_wrapper.logging</a></code></li>
+<li><code><a title="llms_wrapper.log" href="log.html">llms_wrapper.log</a></code></li>
+<li><code><a title="llms_wrapper.model_list" href="model_list.html">llms_wrapper.model_list</a></code></li>
 <li><code><a title="llms_wrapper.utils" href="utils.html">llms_wrapper.utils</a></code></li>
 <li><code><a title="llms_wrapper.version" href="version.html">llms_wrapper.version</a></code></li>
 </ul>

docs/llms_wrapper/llms.html

@@ -77,7 +77,6 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     &#34;&#34;&#34;
     Get the command line arguments
     &#34;&#34;&#34;
-    print(&#34;ENTERING get_args&#34;)
     parser = argparse.ArgumentParser(description=&#39;Test llms&#39;)
     parser.add_argument(&#39;--llms&#39;, &#39;-l&#39;, nargs=&#34;*&#34;, type=str, default=[], help=&#39;LLMs to use for the queries (or use config)&#39;, required=False)
     parser.add_argument(&#39;--use&#39;, &#39;-u&#39;, nargs=&#34;*&#34;, type=str, default=[], help=&#39;Subset of LLMs to use (all)&#39;, required=False)
@@ -90,12 +89,14 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     parser.add_argument(&#34;--show_response&#34;, action=&#34;store_true&#34;, help=&#34;Show thefull  response from the LLM&#34;, required=False)
     parser.add_argument(&#34;--show_cost&#34;, action=&#34;store_true&#34;, help=&#34;Show token counts and cost&#34;, required=False)
     parser.add_argument(&#34;--logfile&#34;, &#34;-f&#34;, type=str, help=&#34;Log file&#34;, required=False)
+    parser.add_argument(&#34;--version&#34;, action=&#34;store_true&#34;, help=&#34;Show version and exit&#34;)
     args = parser.parse_args()
-    print(&#34;after parse_args&#34;)
+    if args.version:
+        print(&#34;llms_wrapper version:&#34;, __version__)
+        sys.exit()
     loglevel1 = &#34;INFO&#34;
     if args.debug:
         loglevel1 = &#34;DEBUG&#34;
-    print(&#34;before configure_logging&#34;)
     configure_logging(level=loglevel1, logfile=args.logfile)
     # logger.enable(&#34;llms_wrapper&#34;)
     # TODO: for testing, remove once logging works properly
@@ -158,9 +159,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def main():
-    print(&#34;Entering main()&#34;)
     args = get_args()
-    print(&#34;After get_args()&#34;)
     run(args)</code></pre>
 </details>
 <div class="desc"></div>

docs/llms_wrapper/llms_wrapper_test.html

@@ -0,0 +1,126 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+<meta name="generator" content="pdoc3 0.11.5">
+<title>llms_wrapper.log API documentation</title>
+<meta name="description" content="Module to handle logging. This module is used to set up the logging for the entire package.
+NOTE: by default, loguru logging is disabled for the …">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+/* Collapse source docstrings */
+setTimeout(() => {
+[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
+.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
+.forEach(el => {
+let d = document.createElement('details');
+d.classList.add('hljs-string');
+d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
+el.replaceWith(d);
+});
+}, 100);
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>llms_wrapper.log</code></h1>
+</header>
+<section id="section-intro">
+<p>Module to handle logging. This module is used to set up the logging for the entire package.
+NOTE: by default, loguru logging is disabled for the package (see <strong>init</strong>.py). To enable logging,
+a client of this library must setup its own logging configuration and enable logging for this package
+using logger.enable("llms_wrapper").</p>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-functions">Functions</h2>
+<dl>
+<dt id="llms_wrapper.log.configure_logging"><code class="name flex">
+<span>def <span class="ident">configure_logging</span></span>(<span>level=None, logfile=None, format=None, enable=True)</span>
+</code></dt>
+<dd>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def configure_logging(level=None, logfile=None, format=None, enable=True):
+    &#34;&#34;&#34;
+    Configure loguru logging sinks. This removes the default sink and adds one for stderr and, if a logfile
+    is specified, one for the logfile, both for the specified level. The format of the log messages can be
+    specified with the format parameter or the default format is used.
+    &#34;&#34;&#34;
+    logger.remove()
+    if level is None:
+        level = DEFAULT_LOGGING_LEVEL
+    if format is None:
+        format = DEFAULT_LOGGING_FORMAT
+    logger.add(sys.stderr, level=level, format=format)
+    if logfile is not None:
+        logger.add(logfile, level=level, format=format)
+    sys.excepthook = handle_exception
+    if enable:
+        logger.enable(&#34;llms_wrapper&#34;)</code></pre>
+</details>
+<div class="desc"><p>Configure loguru logging sinks. This removes the default sink and adds one for stderr and, if a logfile
+is specified, one for the logfile, both for the specified level. The format of the log messages can be
+specified with the format parameter or the default format is used.</p></div>
+</dd>
+<dt id="llms_wrapper.log.handle_exception"><code class="name flex">
+<span>def <span class="ident">handle_exception</span></span>(<span>exc_type, exc_value, exc_traceback)</span>
+</code></dt>
+<dd>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def handle_exception(exc_type, exc_value, exc_traceback):
+    if issubclass(exc_type, KeyboardInterrupt):
+        sys.__excepthook__(exc_type, exc_value, exc_traceback)
+        return
+    logger.opt(exception=(exc_type, exc_value, exc_traceback)).error(&#34;Unhandled exception&#34;)</code></pre>
+</details>
+<div class="desc"></div>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="llms_wrapper" href="index.html">llms_wrapper</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-functions">Functions</a></h3>
+<ul class="">
+<li><code><a title="llms_wrapper.log.configure_logging" href="#llms_wrapper.log.configure_logging">configure_logging</a></code></li>
+<li><code><a title="llms_wrapper.log.handle_exception" href="#llms_wrapper.log.handle_exception">handle_exception</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.5</a>.</p>
+</footer>
+</body>
+</html>