- What is MIML library?
- Repository description
- Getting the library
- Tutorials and documentation
- Methods included
- MIML library data format
- Citation
- License
- Reporting bugs
MIML is a modular Java library whose aim is to ease the development, testing and comparison of classification algorithms for multi-instance multi-label learning (MIML). It includes 32 classification algorithms for solving MIML problems. Algorithms are included on three different approaches for solving a MIML problem: transforming the problem to multi-instance, transforming the problem to multi-label, and solving directly the MIML problem. Besides, it provides holdout and cross-validation procedures, standard metrics for performance evaluation as well as report generation. Algorithms can be executed by means of xml configuration files. It is platform-independent, extensible, free and open source. It is based in both Weka and Mulan frameworks.
In this Github repository, you can find the following folders:
- documentation. A folder with the documentation of the library:
- user's manual. The user's manual in pdf.
- apidoc. It contains the javadoc documentation of the API in html format.
- dist. It contains the distribution of the MIML library as a jar file. Concretely, the folder contains:
- configurations. It contains an example of xml configuration file for each algorithm included in the library.
- data. It contains some examples of datasets. Particularly, birds dataset in included with the distribution of the library.
- miml-1.0.jar. The jar file packaged with all its dependencies.
- mavenProject. It contains the distribution of the MIML library as a Maven project with the following folders:
- configurations. It contains an example of xml configuration file for each of the algorithms included in the library.
- data. It contains some examples of datasets. Particularly, birds dataset is included with the distribution of the library.
- results. It contains the report files generated by each example in configurations folder.
- src. It contains the source code of the distribution.
- pom.xml. File to load the Maven project.
The project can be download using maven tool or from a compiled version (jar file). Detailed information about getting and running the library can be consulted in user's manual.
Before downloading the library, it is necessary to have Java 1.8 installed. Besides, the following versions of dependencies are needed:
| Dependency | Version |
|---|---|
| Weka | 3.7.10 |
| Mulan | 1.5 |
| citationKNN | 1.0.1 |
| multiInstanceLearning | 1.0.9 |
| multiInstanceFilters | 1.0.10 |
| commons-tex | 1.6 |
| commons-logging | 1.2 |
| commons-lang | 3.8.1 |
| commons-configuration | 2.4 |
| commons-collections | 4.2 |
| commons-beanutils | 1.9.3 |
MIML user's manual can be found in the documentation folder and includes:
- Detailed steps for getting and running the library.
- A description of MIML library architecture.
- Examples for managing MIML data.
- Examples for running each classification MIML algorithm included in the library.
- Examples for developing new classification MIML algorithm in the library.
MIML API can be found in the documentation folder.
Moreover, the source code includes the tutorial folder where there are java examples of different functionalities of MIML library. Finally, in configuration folder, it can be found configuration files to run any library algorithm. These files can be used as a basis to modify any configuration parameter in the experimentation of these algorithms.
MIML includes a set of algorithms according to the following three approaches:
1 MIML to MI approach. This approach transforms the MIML problem to MI and then uses any MI algorithm to solve the problem. To this end, a transformation at labels level is applied. Currently two label transformations have been included: BR and LP.
- BR transformation. The following MI algorithms can be used with this transformation:
- CitationkNN, MDD, MIDD, MIBoost, MILR, MIOptimalBall, MIRI, MISMO, MISVM, MITI, MIWrapper, SimpleMI.
- LP transformation. The following MI algorithms can be used with this transformation:
- CitationkNN, MIWrapper, SimpleMI.
- Note that if MDD, MIDD, MIBoost, MILR, MIOptimalBall, MIRI, MISMO, MISVM or MITI are run with LP transformation the following execution error is raised Cannot handle multi-valued nominalclass!. This is due to the philosophy of the LP method which obtains one multi-class dataset and these algorithms are only able to deal with binary class data.
- CitationkNN, MIWrapper, SimpleMI.
2 MIML to ML approach. This approach transforms the MIML problem to ML and then uses any ML algorithm to solve the problem. To this end, a transformation at bag level is performed. Currently, three bag transformations have been included: arithmetic, geometric and min-max. The following are the ML algorithms considered by the library. The following ML algorithms can be used with these transformations:
- BR, LP, RPC, CLR, BRkNN, DMLkNN, IBLR, MLkNN, HOMER, RAkEL, PS, EPS, CC, ECC, MLStacking.
3 MIML solving without transformation. Currently the following algorithms have been included:
- Bagging, MIMLkNN
The format of data is based on the Weka's format for MI learning and on the Mulan's format for ML learning. Concretely, each data set is represented by two files:
- An xml file based on Mulan's format containing the description of labels. Its aim is to identify those attributes in the arff file representing labels. Note that the class attributes do not need to be the last attributes in the arff file and also their order in both at the arff and the xml file does not matter. A hierarchy of labels can be represented by nesting the label tags. The following is an example of xml file with 4 labels:
<?xml version="1.0" encoding="utf-8"?>
<labels xmlns="http://mulan.sourceforge.net/labels">
<label name="label1"></label>
<label name="label2"></label>
<label name="label3"></label>
<label name="label4"></label>
</labels>The following is an example of xml file with a hierarchy of labels:
<?xml version="1.0" encoding="utf-8"?>
<labels xmlns="http://mulan.sourceforge.net/labels">
<label name="sports">
<label name="football"></label>
<label name="basketball"></label>
</label>
<label name="arts">
<label name="sculpture"></label>
<label name="photography"></label>
</label>
</labels>-
An arff (Attribute-Relation File Format) file based on Weka's multi-instance format containing the data. This file is organized in two parts: header and data.
-
Header: it contains the name of the relation and a list with the attributes and their data types.
- The first line of the file contains the @relation <relation-name> sentence, which defines the name of the dataset. This is a string and it must be quoted if the relation-name includes spaces.
- Next, on the first level, there are defined only two attributes and the attributes corresponding to the labels.
- <bag-id>. Nominal attribute. Unique bag identifier for each bag.
- <bag>. Relational attribute. Contains instances attributes.
- <labels>. One binary attribute for each label (nominal with 0 or 1 value).
Attributes are defined with @attribute <attribute-name> <data-type> sentences. There is a line per attribute.
- Numeric attributes are specified by numeric.
- In case of nominal attributes, the list of values must be specified with curly brackets and separated by commas: {value_1, value_2, ..., value_N}.
-
Data: it begins with @data and describes each example (bag) in a line. The order of attributes in each line must be the same in which they were defined in the previous header. Each attribute value is separated by comma (,) and all lines must have the same number of attributes. Decimal position is marked with a dot (.). The data of the relational attribute is surrounded by single (') or double (") quotes, Weka recognizes both formats, and the single instances inside the bag are separated by line-feeds ('\n').
Next, an example of arff file is shown. In the example, each bag contains instances described by 3 numeric attributes and there are 4 labels. The dataset has two bags, the first one with 3 instances and the second one with 2 instances.
-
@relation toy
@attribute id {bag1,bag2}
@attribute bag relational
@attribute f1 numeric
@attribute f2 numeric
@attribute f3 numeric
@end bag
@attribute label1 {0,1}
@attribute label2 {0,1}
@attribute label3 {0,1}
@attribute label4 {0,1}
@data
bag1,"42,-198,-109\n42.9,-191,-142\n3,4,6",1,0,0,1
bag2,"12,-98,10\n42.5,-19,-12",0,1,1,0
This work has been performed by A. Belmonte, A. Zafra and E. Gibaja and is currently in a reviewing process.
MIML library is released under the GNU General Public License GPLv3.
Feel free to open an issue at Github if anything is not working as expected. Merge request are also encouraged, it will be carefully reviewed and merged if everything is all right.