Skip to content

Commit 87c9e63

Browse files
johann-petrakjohann-petrak
committed
WIP
1 parent f36413b commit 87c9e63

File tree

5 files changed

+51
-1
lines changed

5 files changed

+51
-1
lines changed

‎docs/_layouts/default.html‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!DOCTYPE html>
2+
<html lang="{{ site.lang | default: "en-US" }}">
3+
<head>
4+
<meta charset="UTF-8">
5+
6+
{% seo %}
7+
<link rel="preconnect" href="https://fonts.gstatic.com">
8+
<link rel="preload" href="https://fonts.googleapis.com/css?family=Open+Sans:400,700&display=swap" as="style" type="text/css" crossorigin>
9+
<meta name="viewport" content="width=device-width, initial-scale=1">
10+
<meta name="theme-color" content="#157878">
11+
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
12+
<link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
13+
{% include head-custom.html %}
14+
</head>
15+
<body>
16+
<a id="skip-to-content" href="#content">Skip to the content.</a>
17+
18+
<header class="page-header" role="banner">
19+
<h2 class="project-name">{{ page.title | default: site.title | default: site.github.repository_name }}</h2>
20+
<h3><a style="color:white;" href="{{site.baseurl}}/index.html">Overview</a> | <a style="color:white;" href="{{site.baseurl}}/installation.html">Installation</a> | <a style="color:white;" href="{{site.baseurl}}/quickstart.html">Quickstart</a> | <a style="color:white;" href="{{site.baseurl}}/configuration.html">Configuration</a> | <a style="color:white;" href="{{site.baseurl}}/usage.html">Usage</a> </h3>
21+
{% if site.github.is_project_page %}
22+
<a style="color:white;" href="{{ site.github.repository_url }}">View on GitHub</a>
23+
{% endif %}
24+
{% if site.show_downloads %}
25+
<a href="{{ site.github.zip_url }}" class="btn">Download .zip</a>
26+
<a href="{{ site.github.tar_url }}" class="btn">Download .tar.gz</a>
27+
{% endif %}
28+
</header>
29+
30+
<main id="content" class="main-content" role="main">
31+
{{ content }}
32+
33+
<footer class="site-footer">
34+
{% if site.github.is_project_page %}
35+
<span class="site-footer-owner"><a href="{{ site.github.repository_url }}">{{ site.github.repository_name }}</a> is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>.</span>
36+
{% endif %}
37+
<span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
38+
</footer>
39+
</main>
40+
</body>
41+
</html>
42+

‎docs/configuration.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Configuration
2+
13
For every LLM to be used in a project, there should be configuration data that is necessary for using the LLM.
24
Configuration data is expected as a dictionary which contains the key `llms` associated with a list of per-LLM configurations
35
and optionally the key `providers` associated with a dictionary mapping provider names to settings common to all LLMs of that

‎docs/quickstart.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Quickstart/Examples
2+
13
### 1) Install the package into your environment (see [[Installation]])
24

35
### 2) Create a config file for the LLM or LLMs you want to use:

‎docs/test-script.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Test-Script
2+
13
After installing the `llms_wrapper` package the command `llms_wrapper_test` is available as a new command.
24

35
The command can be used to run a standard query against all LLMs configured and check the response (the default query asks the LLM
@@ -40,4 +42,4 @@ key via the standard environment variable, e.g.
4042

4143
```
4244
export GROQ_API_KEY=${MY_SPECIAL_GROQ_API_KEY} llms_wrapper_test --llms groq/llama3-70b-8192
43-
```
45+
```

‎docs/usage.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
# Usage
2+
13
TBD!

0 commit comments

Comments
 (0)