Evalverse Docs
  • Evalverse
  • 🏃LET'S START!
    • Install
    • Quickstart
  • 📃DOCUMENTS
    • Evaluation
    • Report
    • FAQs
  • 🌌Portal
    • 🤗HuggingFace Space
    • 💬Discord
    • GitHub
    • GitHub Issues
Powered by GitBook
On this page
  • class Reporter
  • method __init__
  • method update_db()
  • method run()
  1. DOCUMENTS

Report

Introducing arguments to create a report.

class Reporter

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

method __init__

args
default
description

db_path

./db

directory for saving the report

output_path

./results

directory containing the evaluation results of models to be reported

log_path

None

directory for saving the log

method update_db()

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

args
default
description

save

False

save the csv file of scores or not

git_fetch

False

fetch the origin repository or not

method run()

Create the report file and figures

args
default
description

model_list

"all"

list of models or name of a model to be reported/figured

benchmark_list

"all"

list of benchmarks or name of a benchmark to be reported/figured

save

False

save the report and figure under db_path

PreviousEvaluationNextFAQs

Last updated 1 year ago

📃