Metrics As Scores is open source, and the datasets it can be used with are open access. Therefore, we welcome all contributions, but first and foremost we welcome additional datasets.
Any new dataset must be created using the Text User Interface (TUI) that comes with Metrics As Scores. It ensures compatibility with the application. After installing Metrics As Scores, simply type
> mas
at a prompt to bring up the interface.
You should then upload your dataset at, e.g., Zenodo.
Have a look at the Qualitas.class corpus dataset to get an idea.
The mas command will help you create a bundle that can be uploaded.
Lastly, if you want to make available your dataset to others by having it added to the list of known datasets, open an issue and ask for inclusion. Please ascertain that your dataset fully works with the Web Application prior to opening an issue.
If you wish to contribute to the Metrics As Scores application, you are welcome to open a new issue for
- Suggesting new features
- Reporting errors
- Discuss currently existing features
- Any other questions related to the application
There is no issue template. However, when reporting bugs, make sure to disclose the exact version used, both of Metrics As Scores, your platform, the dataset, etc., and to provide, if possible, a minimum reproducible example.
The most common way to contribute new features, bug fixes, and maintenance patches is to fork the repository and open a pull request.
If you require support, please open a new issue.
Should you decide to post a question to, e.g., StackOverflow, please use the tags python-mas or metrics-as-scores.