Skip to content

Commit

Permalink
Add bfcl results to readme, fix links icons (#856)
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronvg authored Aug 2, 2024
1 parent 4a17dce commit 5ef7f3d
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 9 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
<a href="https://boundaryml.com?utm_source=github" target="_blank" rel="noopener noreferrer">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://www.boundaryml.com/gloo-ai-square-256.png">
<img src="https://www.boundaryml.com/gloo-ai-square-256.png" height="64">
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/baml-lamb-white.png">
<img src="docs/assets/baml-lamb-white.png" height="64">
</picture>

</a>

# BAML

**BAML is a domain-specific-language to write and test LLM functions.**
BAML is a domain-specific-language to write and test LLM functions.

An LLM function is a prompt template with some defined input variables, and a specific output type like a class, enum, union, optional string, etc.
With BAML you can write and test a complex LLM function in 1/10 of the time it takes to setup a python LLM testing environment.

BAML LLM functions plug into python, TS, and other languages, which makes it easy to focus more on engineering and less on prompting.

BAML outperforms all other current methods of getting structured data, even when using it with GPT3.5. It also outperforms models fine-tuned for tool-use. See the [Berkeley Function Calling Benchmark](https://gorilla.cs.berkeley.edu/leaderboard.html) results. [Read more on our Schema-Aligned Parser](https://www.boundaryml.com/blog/schema-aligned-parsing).

<img src="docs/assets/bfcl-baml.png" width="80%" alt="Boundary Studio">

## Try it out in the playground -- [PromptFiddle.com](https://promptfiddle.com)

Expand Down Expand Up @@ -186,7 +191,7 @@ Showcase of applications using BAML

Analyze, label, and trace each request in [Boundary Studio](https://app.boundaryml.com).

<img src="docs/images/v3/pipeline_view.png" width="80%" alt="Boundary Studio">
<img src="docs/assets/images/v3/pipeline_view.png" width="80%" alt="Boundary Studio">

## Why not just use an existing Python framework?

Expand Down
Binary file added docs/assets/baml-lamb-white.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/assets/bfcl-baml.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/assets/favicon.ico
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -190,10 +190,10 @@ colors:
light: "#fefefe"
# dark: "#14191f"
logo:
light: assets/favicon.png
light: assets/favicon.ico
# dark: assets/favicon.png
height: 40
favicon: assets/favicon.png
favicon: assets/favicon.ico
css: assets/styles.css
layout:
page-width: full
Expand Down
2 changes: 1 addition & 1 deletion integ-tests/python/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ readme = "README.md"
packages = [{ include = "app" }]

[tool.poetry.dependencies]
python = "^3.9"
python = "^3.8"
# Use client in production
# baml-py = "^0.14.1"
ruff = "^0.3.3"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ const ProjectViewImpl = ({ project }: { project: BAMLProject }) => {
<div className='flex items-center justify-start h-full pt-0.5 '>
<Button asChild variant={'ghost'} className='h-full py-1 gap-x-1 hover:bg-indigo-600'>
<Link
href='https://docs.boundaryml.com'
href='https://boundaryml.com'
target='_blank'
className='text-sm hover:text-foreground text-foreground '
>
Expand Down

0 comments on commit 5ef7f3d

Please sign in to comment.