Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasavila00 committed Apr 7, 2024
1 parent 7fcf9f5 commit 618a3fd
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 24 deletions.
25 changes: 4 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,16 @@
# LmScript

LmScript: Fast and Controllable Language Model Interactions
Controllable Language Model Interactions in TypeScript

- LMScript: a suite of tools for easy, fast, and controllable interactions with
language models.
- A suite of tools for easy, fast, and controllable interactions with language models.
- Open models and open source.
- Supports [SGLang](https://github.com/sgl-project/sglang/) and
[vLLM](https://github.com/vllm-project/vllm)
([Outlines](https://github.com/outlines-dev/outlines)).

## What the code looks like?
## Documentation, Tutorial, Examples

```ts
const {
captured: { language },
} = await client
.push("The best programming language is ")
.select("language", { choices: ["javascript", "typescript"] })
.run();

console.log(language);
```

There are more complete examples in the
[client's examples folder](https://github.com/lucasavila00/LmScript/tree/main/examples/client).

## Do you prefer a graphical interface?

[![screenshot of lmscript ui](./assets/app.png)](https://github.com/lucasavila00/LmScript/tree/main/apps/egui)
Check out the [LmScript Docs](https://lucasavila00.github.io/LmScript/)

## Projects

Expand Down
2 changes: 1 addition & 1 deletion apps/lmscript-docs/docs/client/selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 2

# Selection

Let me language model choose an option from a list of choices.
Let the language model choose an option from a list of choices.

:::note

Expand Down
2 changes: 1 addition & 1 deletion apps/lmscript-docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import type * as Preset from "@docusaurus/preset-classic";
const config: Config = {
title: "LmScript",
tagline:
"Controllable Language Model Interactions - Open Source, Open Models",
"Controllable Language Model Interactions in TypeScript",
favicon: "img/favicon.ico",

// Set the production url of your site here
Expand Down
Binary file removed assets/app.png
Binary file not shown.
2 changes: 1 addition & 1 deletion examples/docs/tests/client/selection.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ test(
# Selection
Let me language model choose an option from a list of choices.
Let the language model choose an option from a list of choices.
:::note
Expand Down

0 comments on commit 618a3fd

Please sign in to comment.