Building a leaderboard using a template

To build a leaderboard, the easiest is to look at our demo templates here

📏 Contents

Our demo leaderboard template contains 4 sections: two spaces and two datasets.

🪛 Getting started

You should copy the two spaces and the two datasets to your org to get started with your own leaderboard!

Setting up the frontend

To get started on your own frontend leaderboard, you will need to edit 2 files:

Setting up fake results to initialize the leaderboard

Once this is done, you need to edit the “fake results” file to fit the format of your tasks: in the sub dictionary results, replace task_name1 and metric_name by the correct values you defined in tasks above.

"results": {
    "task_name1": {
        "metric_name": 0
    }
}

At this step, you should already have some results displayed in the frontend!

Any more model you want to add will need to have a file in request and one in result, following the same template as already present files.

Optional: Setting up the backend

If you plan on running your evaluations on spaces, you then need to edit the backend to run the evaluations most relevant for you in the way you want. Depending on the suite you want to learn, this is the part which is likely to take the most time.

However, this is optional if you only want to use the leaderboard to display results, or plan on running evaluations manually/on your own compute source.

🔧 Tips and tricks

Leaderboards setup in the above fashion are adjustable, from providing fully automated evaluations (a user submits a model, it is evaluated, etc) to fully manual (every new evaluation is run with human control) to semi-automatic.

When running the backend in Spaces, you can either :

If you run evaluations on your own compute source, you can still grab some of the files from the backend to pull and push the results and request datasets.

Once your leaderboard is setup, don’t forget to set its metadata so it gets indexed by our Leaderboard Finder. See “What do the tags mean?” in the LeaderboardFinder space.

< > Update on GitHub