Skip to content

Commit aa0b8a2

Browse files
committed
Update docs for GitHub Pages
1 parent 16f8ca9 commit aa0b8a2

4 files changed

Lines changed: 16 additions & 9 deletions

File tree

Cargo.lock

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/docs/intro.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,12 @@ Or **try Evaluate immediately** by cloning from **[GitHub](https://github.com/RG
2121

2222
- [Rust](https://www.rust-lang.org/tools/install) version 1.70 or above
2323
- [Node.js](https://nodejs.org/en/download/) version 20.0 or above (for the documentation site)
24-
- An LLM Provider:
24+
- An LLM Provider, for example:
25+
- An OpenAI or Claude subscription API KEY
2526
- A Gemini API key from [Google AI Studio](https://makersuite.google.com/app/apikey)
26-
- Or a running [Ollama](https://ollama.com/) instance for local models.
27+
- Or a running [Ollama](https://ollama.com/) instance for local models
2728
- Git for version control
29+
- Sqlite ~ (installed by default)
2830

2931
## Clone and Setup
3032

@@ -91,10 +93,14 @@ Open your browser and navigate to `http://127.0.0.1:8080` to access the **built-
9193

9294
Now that your server is running, you can:
9395

94-
- Test the API with sample curl commands
96+
- Test the API with sample cURL commands
9597
- Use the web interface to run single evaluations
9698
- Submit batch evaluations using JSON files
9799
- View your evaluation history in the GUI
98100

99101
Explore the documentation to learn more about configuring models, writing eval definitions, and using the AI-powered judging capabilities.
100-
```
102+
103+
## Clear the database
104+
If you wish to start again or clear the results, you can delete the database and it will create a new one next time you run evaluate.
105+
106+
`rm data/evals.db`

docs/docs/usage.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ sidebar_position: 2
77
Make batch eval using the API
88

99
## step 1 : edit the qa_sample.json in the project root
10+
Alterrnative make your own, using the same structure as below
1011

1112
```json
1213
[

qa_sample.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@
4444
"tags": ["summarization", "literature", "philosophy"],
4545
"metadata": { "book_title": "Do Androids Dream of Electric Sheep?", "author": "Philip K. Dick" }
4646
}
47-
]
47+
]

0 commit comments

Comments
 (0)