├── README.md ├── add_paper.md ├── add_results.md └── add_task.md /README.md: -------------------------------------------------------------------------------- 1 | # Papers with Code Tutorials 2 | Basic guidance on how to contribute to Papers with Code 3 | 4 | * [Adding Papers to Papers with Code](https://github.com/paperswithcode/tutorials/blob/main/add_paper.md) 5 | 6 | * [Adding Results on Papers with Code](https://github.com/paperswithcode/tutorials/blob/main/add_results.md) 7 | 8 | * [Adding a Task on Papers with Code](https://github.com/paperswithcode/tutorials/blob/main/add_task.md) 9 | 10 | Leave an [issue](https://github.com/paperswithcode/tutorials/issues/new) if you have any other questions. 11 | -------------------------------------------------------------------------------- /add_paper.md: -------------------------------------------------------------------------------- 1 | ### Adding a Paper to Papers with Code 2 | 3 | 4 | 1. In order to add a paper on PWC, first create an account on [Papers with Code](https://paperswithcode.com/). 5 | 2. Use this [form](https://paperswithcode.com/submit-paper) to submit paper. 6 | 3. Make sure to add all the required information for the paper and that it is publicly accessible. 7 | 4. That's it! You can now add results manually and other metadata to the paper. 8 | -------------------------------------------------------------------------------- /add_results.md: -------------------------------------------------------------------------------- 1 | ### Adding Results on Papers with Code 2 | 3 | 1. In order to add results first create an account on [Papers with Code](https://paperswithcode.com/). 4 | 5 | 2. We encourage results from published papers from either a conference, journal or preprints like ArXiv. However, it's also possible to include results from GitHub repositories where results are documented and reproducible. 6 | 7 | 3. There are different ways you can add results to a paper. You can click on the "Edit" button from the corresponding paper page and an interface will pop up (image below). That's the easy way to add results: 8 | 9 | ![image](https://user-images.githubusercontent.com/7049564/151842889-1fc4f21b-ece0-40c7-b663-f1f26bc1ebfd.png) 10 | 11 | Add Results Interface: 12 | 13 | ![image](https://user-images.githubusercontent.com/7049564/151842790-d1182cc2-bbb5-4ce3-8e0f-398eb6608846.png) 14 | 15 | In some occassions, you will not get the add results interface. But you can still add results using this **second option**. First, you will need to add a task on the paper page: 16 | 17 | ![image](https://user-images.githubusercontent.com/7049564/151843311-6812221e-cf9e-40ce-aa58-224a72189fb7.png) 18 | 19 | The task is required for this second way of adding result as it is a required field in the form that will pop up. Then you go to the "Edit" button and you will see a pop up like below: 20 | 21 | ![image](https://user-images.githubusercontent.com/7049564/151843517-8d29c3bf-80c3-425a-9620-d524689b3737.png) 22 | 23 | Ensure you include all the information that's requested in the form. 24 | 25 | A **third way** of adding results is to do it directly from the leaderboard interface. Assuming you already identified this existing leaderboard, you can click on the "Edit Leaderboard" button, and add the results as a row to the table. You are required to add model name, paper, result, etc. 26 | 27 | ![image](https://user-images.githubusercontent.com/7049564/151843793-bf8c94ff-7928-402d-9681-8c59850b8ccd.png) 28 | 29 | Leaderboard interface: 30 | 31 | ![image](https://user-images.githubusercontent.com/7049564/151844553-e29f3de9-cff6-4e34-9123-1d1e69873192.png) 32 | 33 | Ensure to click on save after adding your result as the table doesn't autosave. You can even add extra columns there if there is a missing metric you want to report results for. 34 | 35 | Leave an [issue](https://github.com/paperswithcode/tutorials/issues/new) if you have any other questions. 36 | -------------------------------------------------------------------------------- /add_task.md: -------------------------------------------------------------------------------- 1 | ### Add Task on Papers with Code 2 | 3 | 1) Create an account on Papers with Code if you don't have one yet. 4 | 5 | 2) Browse to the corresponding paper page for which you want to add a task. 6 | 7 | 3) Click on "Edit" Under **Tasks** 8 | 9 | 4) Then click "+Add". (example below) 10 | 11 | ![image](https://user-images.githubusercontent.com/7049564/158549370-8ea6a35e-7337-4e4a-879b-a1574b1f5d57.png) 12 | 13 | 5) In the popup dialog box, click "+ Create a new task". (example below) 14 | 15 | ![image](https://user-images.githubusercontent.com/7049564/158548061-0a762958-d4c2-4096-aecb-d0b2d0d23a8a.png) 16 | 17 | 6) Before adding a new task, ensure that it doesn't yet exist by trying a search in the **Add** input box. Sometimes the task may exist under a different name. Try to search for synonyms as well. If you are confident the task doesn't exist, add the details for your new task in the form that appears. 18 | 19 | ![image](https://user-images.githubusercontent.com/7049564/158548294-9b59a9c7-c295-4d4c-bee6-b425a1b6df08.png) 20 | 21 | Tip: A good task should be specific enough and have a clear description. 22 | --------------------------------------------------------------------------------