How to Donate your Datasets or Software
We appreciate your contribution to the PROMISE repository. Please send an email to
promise AT site DOT uottawa DOT ca
with a Subject line Donation
us know about your intent to donate your software or datasets. We will email you back
with more detailed instruction for submitting your files.
Please make sure that your donation includes enough documentation that allows people
other than the author(s) of the software to use it. Also, please include the following
files in your donation package.
README (or README.txt) Provides a brief description of what the software does, as well as
the name of authors, where it was developed, whether it is platform dependent or not, etc.
INSTALL (or INSTALL.txt) Tells the users how to install the software on their system.
To promote uniformity and ease of use, as well as reduce the burden and the possibility of error
in converting datasets from one format to another, we ask you to please comply with the
Recommended dataset format is Attribute-Relation File Format (ARFF).
For an example of such a dataset see Cocomo NASA/Software cost estimation in the PROMISE Software Engineering Repository
However, if ARFF is not the appropriate format for your data, please
provide detailed description of your data format in an accompanying .desc
file as mentioned below.
Each dataset should be properly documented. A guideline from UCI Machine Learning repository
for documenting datasets can be found here.
This information is placed before the actual data when using ARFF format.
However, if you are using an alternative format that does not support
comments in the dataset, provide this info in a separate file with