Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
paulbzm committed Jul 17, 2024
1 parent 586e626 commit ac16235
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,32 @@ You can fetch the results automatically by running:

This script attempts to fetch data from the relevant papers and update the tables in the `results` folder. To add a new paper, create an entry in `data_extraction/data_source.yaml`.

It is recommended to the authors to include their results in their Github repository, to ensure that the data is fetched correctly. You can view the expected format [here](https://github.com/fraunhoferhhi/Self-Organizing-Gaussians/tree/main/results). Please provide a submethod name for up to two results per dataset to be displayed in the survey table. Results without a submethod name will only be shown in the plots. Use the keyword "Baseline" to ensure only the name of your approach is shown in the table for these results.
## Including your own Results

It is recommended that authors include their results in a separate folder within their GitHub repository to ensure correct data retrieval. The expected folder structure is:

```
results
├── DeepBlending.csv
├── MipNeRF360.csv
├── SyntheticNeRF.csv
├── TanksAndTemples.csv
```

Please include all datasets on which your method was evaluated in the results folder.

Each CSV file should be structured as follows:

```
Submethod,PSNR,SSIM,LPIPS,Size [Bytes]
Baseline,xx.xx,0.xxx,0.xxx,xxxxxxxx
-SubmethodName,xx.xx,0.xxx,0.xxx,xxxxxxxx
,xx.xx,0.xxx,0.xxx,xxxxxxxx
,xx.xx,0.xxx,0.xxx,xxxxxxxx
,xx.xx,0.xxx,0.xxx,xxxxxxxx
```

Include up to two consistent submethod names for your results across all files to ensure they appear in the survey table. Results without a submethod name will only be displayed in the plots. You can use "Baseline" as a submethod name if you want only the name of your approach to be displayed in the table for these results.

You can view an example [here](https://github.com/fraunhoferhhi/Self-Organizing-Gaussians/tree/main/results)

0 comments on commit ac16235

Please sign in to comment.