📋 A template README.md for experiment artifacts
This repository is the official implementation of My Paper Title.
📋 Optional: include a graphic explaining your approach/main result, bibtex entry, link to demos, blog posts and tutorials
To install requirements :
pip install -r requirements.txt
📋 Describe how to set up the environment, e.g. pip/conda/docker commands, download datasets, etc...
To setup the experiment in the paper, run this command :
python setup.py
📋 Describe how to set up the experiment, with example commands used in your paper, including the full procedure and appropriate configurations.
To evaluate my experiment, run :
python eval.py
📋 Describe how to evaluate the artifacts as reported in the paper, give commands that produce the results (section below).
Our experiment achieves the following results :
| Category | Result 1 | Result 2 |
|---|---|---|
| Stuff | 85% | 95% |
📋 Include a table of results from your paper. If your main result is a figure, include that figure and link to the command or notebook to reproduce it.
📋 Pick a license and describe how to contribute to your code repository.