Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amva13 authored Jan 14, 2025
1 parent b6d9d35 commit 2be5192
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# tc2website-flask
Hello, this is the flask implementation for tdc-2 website. Our documentation is still under development. For most matters, you can refer to theh original TDC repo.
# tc2website-flask (+ nextjs)
Hello, this is the flask implementation for tdc-2 website (UPDATE: with nextjs). Our documentation is still under development. For most matters, you can refer to the TDC repo.

We have developed a new more decentralized method for adding entries to TDC leaderboards. Use the following minimalist guide to add your entries to the leaderboards.
We have developed a new, more decentralized method for adding entries to TDC leaderboards. Follow the following minimalist guide to add your entries.

To add your entry to the leaderboard, add your results to the corresponding leaderboard in this file
https://github.com/mims-harvard/tdc2website-flask/blob/main/benchmark/leaderboards.py
You must match the format for your leaderboard in that file. In short, the format is as follows:

1. On the fourth item of the list paired to your leaderboard, you will find a list with entries corresponding to the metadata for your entry as well as the
1. On the fourth item of the list paired with your leaderboard, you will find a list with entries corresponding to the metadata for your entry and the
mean value for the leaderboard metric. Fill out this information and add an entry to that list.

2. On the fifth item of the list paired to your leaderboard, you will find a list containing entries with the metric value and standard deviation. Add your numbers to that list.
2. On the fifth item of the list paired to your leaderboard, you will find a list containing the metric value and standard deviation entries. Add your numbers to that list.

Last, create a PR for this repo and contact @amva13 or [email protected] to get approval!
Last, create a PR for this repo and contact @amva13 or [email protected] for approval!

The PR must include the following in the description:

Expand Down

0 comments on commit 2be5192

Please sign in to comment.