Skip to content

Commit 9c5916f

Browse files
ReadMe Update
* chore: clean unused dependencies and resolve version errors * Updated ReadMe --------- Co-authored-by: Luis Gaspar Schroeder <luis.gasparschroeder@gmail.com>
1 parent b478570 commit 9c5916f

File tree

5 files changed

+93
-265
lines changed

5 files changed

+93
-265
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,14 @@ export OPENAI_API_KEY="your_api_key_here"
4949
Finally, use vCache in your Python code:
5050

5151
```python
52-
from vcache import VCache, VerifiedDecisionPolicy
52+
from vcache import VCache, VCachePolicy, VerifiedDecisionPolicy
5353

5454
error_rate_bound: int = 0.01
5555
policy: VCachePolicy = VerifiedDecisionPolicy(delta=error_rate_bound)
56-
vcache: VCache = VCache(policy)
56+
vcache: VCache = VCache(policy=policy)
5757

5858
response: str = vcache.infer("Is the sky blue?")
59+
print(response)
5960
```
6061

6162

benchmarks/ReadMe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ This directory provides the official benchmarking tools for evaluating the perfo
2222

2323
## ⚙️ Installation
2424

25-
To enable benchmarking capabilities, install vCache with the `benchmarks` extras:
25+
To enable benchmarking capabilities, install vCache with the `benchmarks` extras from the project root:
2626

2727
```bash
28-
pip install -e .
28+
pip install -e .[benchmarks]
2929
```
3030

3131

0 commit comments

Comments
 (0)