Skip to content

Commit

Permalink
Update docs (#1025)
Browse files Browse the repository at this point in the history
Made some minor changes in docs for better readability and to make it
more grammatically accurate
<!-- ELLIPSIS_HIDDEN -->

----

> [!IMPORTANT]
> Minor grammatical corrections in documentation files for improved
readability and accuracy.
> 
>   - **Documentation**:
> - Corrected "domain-specific-language" to "domain-specific language"
in `README.md`.
>     - Fixed "likelyhood" to "likelihood" in `pydantic.mdx`.
> - Changed "There's other" to "There are other" and "modelling" to
"modeling" in `pydantic.mdx`.
> - Corrected "import and call" to "imports and calls" in
`pydantic.mdx`.
> 
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=BoundaryML%2Fbaml&utm_source=github&utm_medium=referral)<sup>
for 2c75911. It will automatically
update as commits are pushed.</sup>

<!-- ELLIPSIS_HIDDEN -->
  • Loading branch information
FarukhS52 authored Oct 10, 2024
1 parent 1a26dd4 commit 2dd1bb6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

# 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.

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/comparisons/pydantic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ and sometimes even GPT-4 outputs incorrect stuff like this, even though it's tec
```
(this is an actual result from GPT-4 before some more prompt engineering)

when all you really want is a prompt that looks like the one below -- with way less tokens (and less likelyhood of confusion). :
when all you really want is a prompt that looks like the one below -- with way less tokens (and less likelihood of confusion). :
```diff
Parse the following resume and return a structured representation of the data in the schema below.
Resume:
Expand Down Expand Up @@ -220,8 +220,8 @@ Ahh, much better. **That's 80% less tokens** with a simpler prompt, for the same
But we digress, let's get back to the point. You can see how this can get out of hand quickly, and how Pydantic wasn't really made with LLMs in mind. We haven't gotten around to adding resilience like **retries, or falling back to a different model in the event of an outage**. There's still a lot of wrapper code to write.

### Pydantic and Enums
There's other core limitations.
Say you want to do a classification task using Pydantic. An Enum is a great fit for modeling this.
There are other core limitations.
Say you want to do a classification task using Pydantic. An Enum is a great fit for modelling this.

Assume this is our prompt:
```text
Expand Down Expand Up @@ -375,7 +375,7 @@ function ExtractResume(resume_text: string) -> Resume {
"#
}
``` */}
The BAML compiler generates a python client that import and call the function:
The BAML compiler generates a python client that imports and calls the function:
```python
from baml_client import baml as b

Expand Down

0 comments on commit 2dd1bb6

Please sign in to comment.