Skip to content

Commit

Permalink
Image for get started and watch demo buttons
Browse files Browse the repository at this point in the history
  • Loading branch information
nking-1 committed May 10, 2024
1 parent 1a1e83a commit 5c37271
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 21 deletions.
24 changes: 3 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,3 @@
<style>
a button {
background-color: #0164D9;
color: white;
border: none;
border-radius: 5px;
padding-top: 7px;
padding-bottom: 7px;
width: 120px;
text-decoration: none;
cursor: pointer;
transition: background-color 0.2s;
}

a button:hover {
background-color: #014CAB;
}
</style>

<div align="right"><a href="https://guidance.readthedocs.org"><img src="https://readthedocs.org/projects/guidance/badge/?version=latest&style=flat" /></a></div>
<div align="center"><picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/figures/guidance_logo_blue_dark.svg">
Expand All @@ -27,9 +8,10 @@
# An efficient programming paradigm for steering language models
**`{guidance}`** is a programming paradigm that offers superior control and efficiency compared to conventional prompting and chaining. With `{guidance}`, you can control how output is structured and get high-quality output for your use case—**while reducing latency and costs of conventional prompting or fine-tuning.** It allows users to constrain generation (e.g. with regex and CFGs) as well as to interleave control (conditional, loops) and generation seamlessly.

<a href="https://www.youtube.com/watch?v=9oXjP5IIMzQ" aria-label="Watch demo"><button>Watch demo</button></a>
<a href="https://www.youtube.com/watch?v=9oXjP5IIMzQ" aria-label="Watch demo"><img alt="Watch demo" src="docs/figures/watch_demo_button.png" width="120"></a>


<a href="#get-started" aria-label="Get started"><button>Get started</button></a>
<a href="#get-started" aria-label="Get started"><img alt="Watch demo" src="docs/figures/get_started_button.png" width="120"></a>

# Key Features
The **`{guidance}`** library offers developers an elegant prompt-writing experience, allowing users to interleave control (conditional, loops) and constrain generation seamlessly:
Expand Down
Binary file added docs/figures/get_started_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/figures/watch_demo_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5c37271

Please sign in to comment.