> For the complete documentation index, see [llms.txt](https://evalverse.gitbook.io/evalverse-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://evalverse.gitbook.io/evalverse-docs/documents/report.md).

# Report

## <mark style="color:orange;">class</mark> Reporter

You can create a report with figures summarizing the evaluation results.

### <mark style="color:blue;">method</mark> \_\_init\_\_

<table><thead><tr><th width="170">args</th><th width="118">default</th><th>description</th></tr></thead><tbody><tr><td>db_path</td><td>./db</td><td>directory for saving the report</td></tr><tr><td>output_path</td><td>./results</td><td>directory containing the evaluation results of models to be reported</td></tr><tr><td>log_path</td><td>None</td><td>directory for saving the log</td></tr></tbody></table>

### <mark style="color:blue;">method</mark> update\_db()

Updates the `db_path` to align with the evaluation results files in the `output_path` for report generation.

<table><thead><tr><th width="130">args</th><th width="105">default</th><th>description</th></tr></thead><tbody><tr><td>save</td><td>False</td><td>save the <code>csv</code> file of scores or not</td></tr><tr><td>git_fetch</td><td>False</td><td>fetch the origin repository or not</td></tr></tbody></table>

### <mark style="color:blue;">method</mark> run()

Create the report file and figures

<table><thead><tr><th width="165">args</th><th width="88">default</th><th>description</th></tr></thead><tbody><tr><td>model_list</td><td>"all"</td><td>list of models or name of a model to be reported/figured</td></tr><tr><td>benchmark_list</td><td>"all"</td><td>list of benchmarks or name of a benchmark to be reported/figured</td></tr><tr><td>save</td><td>False</td><td>save the report and figure under <code>db_path</code></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://evalverse.gitbook.io/evalverse-docs/documents/report.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.