Skip to content

Commit

Permalink
Merge pull request #279 from DavidBlavid/v2.0
Browse files Browse the repository at this point in the history
Fix systems.md and systems_updated.md, updated Tutorial
  • Loading branch information
xixi019 authored Jul 8, 2024
2 parents 8ddf409 + cb65d02 commit bf87c74
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Using a global and open resource, trusting evaluation results will be easier. In

There are multiple ways to add a new result to the leaderboard:

1. You can directly edit the leaderboard for your dataset of interest. You can add columns, new rows or even change individual cells. This is the easiest way to add a new result. If a leaderboard for a dataset is not yet available, you can simply add it by pasting a markdown table, similar to the other ones in the repository. Look at [this example]() for a template.
1. You can directly edit the leaderboard for your dataset of interest. You can add columns, new rows or even change individual cells. This is the easiest way to add a new result. If a leaderboard for a dataset is not yet available, you can simply add it by pasting a markdown table, similar to the other ones in the repository. Please also add an entry of the system to systems_updated.md if none exists already. Look at [this example](https://github.com/KGQA/leaderboard/blob/v2.0/template_leaderboard.md?plain=1) for a template.
1. You can also simply open an issue and we will add the result for you.

If you have an entire new dataset, which you want to add to the leaderboard, you'll have to create a pull request. This is how we expect you to add a new dataset. (P.S.: You can also simply create an issue and we will add the dataset for you.)
Expand All @@ -27,7 +27,7 @@ If you have an entire new dataset, which you want to add to the leaderboard, you
- Find the appropriate knowledge graph folder, e.g. "freebase"
- Create these markdown files:
- ^(datasetName).md - This is the header of your dataset in plain markdown.
- (datasetName).md - This is the main leaderboard table. You can copy the template from [here]()
- (datasetName).md - This is the main leaderboard table. You can copy the template from [here](https://github.com/KGQA/leaderboard/blob/v2.0/template_leaderboard.md?plain=1)
- $(datasetName).md - This is the footer of your dataste, again in plain markdown.
- Add correspnding route in the file frontend/static/entries.txt
- Create a pull request
Expand Down
Loading

0 comments on commit bf87c74

Please sign in to comment.