Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wellecks authored Oct 31, 2023
1 parent 1ef409c commit 8f955a3
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- [10.2023] `llmstep` adds direct support for reprover (`leandojo-lean4-tacgen-byt5-small`)
- [9.2023] `llmstep` adds support for free GPU servers via Google Colab


---

`llmstep` is a Lean 4 tactic for suggesting proof steps using a language model:
Expand Down Expand Up @@ -32,6 +33,8 @@ example (f : ℕ → ℕ) : Monotone f → ∀ n, f n ≤ f (n + 1) := by

`llmstep` checks the language model suggestions in Lean, and highlights those that are valid and/or close the proof.



## Using `llmstep` in a project
1. Add `llmstep` in `lakefile.lean`:
```lean
Expand Down Expand Up @@ -68,6 +71,9 @@ If your GPU does not support [vLLM](https://vllm.readthedocs.io/en/latest/), ple
`llmstep` aims to be a model-agnostic tool. We welcome contributions of new models.

## Implementation
<img src="./docs/llmstep.png" width="700"/>


`llmstep` has three parts:
1. a [Lean tactic](./LLMstep/LLMstep.lean)
2. a [language model](https://huggingface.co/wellecks/llmstep-mathlib4-pythia2.8b)
Expand All @@ -77,6 +83,8 @@ The Lean tactic calls a [Python script](./python/suggest.py), which sends a requ
The server calls the language model and returns the generated suggestions. \
The suggestions are displayed by the tactic in VS Code.



## Google Colab

To use Google Colab's free GPU to run a server, follow these instructions:
Expand Down

0 comments on commit 8f955a3

Please sign in to comment.