Update README with instructions on how to run locally

README.md

@@ -4,15 +4,25 @@ This is a fork of the [leaderboard demo from HuggingFace](https://huggingface.co
 
 ## Set-up and installation
 
-To start development, clone the repository and install the dependencies:
+To start development, clone the repository and install the dependencies.
+Make sure to also install the pre-commit hooks so that formatting is uniform across the codebase.
 
 ```sh
 python -m venv venv
 source venv/bin/activate
 git clone git@github.com:filbench/hf-leaderboard-backend.git
 pip install -r requirements.txt
+pre-commit install
 ```
 
+To view the leaderboard **locally**, then run the following command:
+
+```sh
+gradio app.py
+```
+
+This will launch the leaderboard (by default in `localhost:7860`) in hot-reload mode, so you can see the changes as you edit the source code.
+
 ## Updating the HuggingFace Space
 
 All development should happen in this GitHub remote.

requirements.txt

@@ -9,6 +9,7 @@ huggingface-hub>=0.18.0
 matplotlib
 numpy
 pandas
+pre-commit
 python-dateutil
 sentencepiece
 tokenizers>=0.15.0

src/about.py

@@ -26,7 +26,7 @@ TITLE = """<h1 align="center" id="space-title">Demo leaderboard</h1>"""
 
 # What does your leaderboard evaluate?
 INTRODUCTION_TEXT = """
-Intro text
+FilBench
 """
 
 # Which evaluations are you running? how can people reproduce what you have?