coli-saar / am-parser

Modular implementation of an AM dependency parser in AllenNLP.
Apache License 2.0
30 stars 10 forks source link

Document experiments more precisely #85

Open alexanderkoller opened 4 years ago

alexanderkoller commented 4 years ago

We have now used the code in this repository in multiple papers. We should set up a separate Wiki page for each paper to document precisely how to reproduce our experiments. This should include

It seems like a good idea to link to the Wiki pages for e.g. evaluating and converting, if the instructions in those pages are valid for the version of am-parser that is referenced in that experiment.

We should then make a habit out of creating another Wiki page like that every time we submit another paper.

Once we have moved the reproducibility documentation to the Wiki, we should clean up the README.md, which then doesn't need to be about reproducing experiments any more, but can simply be an entry point for potential users of the parser.

alexanderkoller commented 4 years ago

This could perhaps be a good first Hiwi project for Pauline, because it would give her an opportunity to use all parts of the parser without having to understand the internals very deeply.