1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
package de.lmu.ifi.dbs.elki;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2015
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import java.util.Collection;
import de.lmu.ifi.dbs.elki.application.KDDCLIApplication;
import de.lmu.ifi.dbs.elki.database.Database;
import de.lmu.ifi.dbs.elki.result.ResultHierarchy;
import de.lmu.ifi.dbs.elki.result.SettingsResult;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.Parameterization;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.TrackParameters;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.TrackedParameter;
import de.lmu.ifi.dbs.elki.workflow.AlgorithmStep;
import de.lmu.ifi.dbs.elki.workflow.EvaluationStep;
import de.lmu.ifi.dbs.elki.workflow.InputStep;
import de.lmu.ifi.dbs.elki.workflow.OutputStep;
/**
* KDDTask encapsulates the common workflow of an <i>unsupervised</i> knowledge
* discovery task.
*
* @author Arthur Zimek
*
* @apiviz.composedOf InputStep
* @apiviz.composedOf AlgorithmStep
* @apiviz.composedOf EvaluationStep
* @apiviz.composedOf OutputStep
*/
public class KDDTask {
/**
* The settings used, for settings reporting.
*/
private Collection<TrackedParameter> settings;
/**
* The data input step
*/
private InputStep inputStep;
/**
* The algorithm (data mining) step.
*/
private AlgorithmStep algorithmStep;
/**
* The evaluation step.
*/
private EvaluationStep evaluationStep;
/**
* The output/visualization step
*/
private OutputStep outputStep;
/**
* The result hierarchy.
*/
private ResultHierarchy hier;
/**
* Constructor.
*
* @param inputStep
* @param algorithmStep
* @param evaluationStep
* @param outputStep
* @param settings
*/
public KDDTask(InputStep inputStep, AlgorithmStep algorithmStep, EvaluationStep evaluationStep, OutputStep outputStep, Collection<TrackedParameter> settings) {
super();
this.inputStep = inputStep;
this.algorithmStep = algorithmStep;
this.evaluationStep = evaluationStep;
this.outputStep = outputStep;
this.settings = settings;
}
/**
* Method to run the specified algorithm using the specified database
* connection.
*/
public void run() {
// Input step
Database db = inputStep.getDatabase();
hier = db.getHierarchy();
// Algorithms - Data Mining Step
algorithmStep.runAlgorithms(db);
// TODO: this could be nicer
hier.add(db, new SettingsResult(settings));
// Evaluation
evaluationStep.runEvaluators(hier, db);
// Output / Visualization
outputStep.runResultHandlers(hier, db);
}
/**
* Get the algorithms result hierarchy.
*
* @return the result hierarchy
*/
public ResultHierarchy getResultHierarchy() {
return hier;
}
/**
* Parameterization class.
*
* @author Erich Schubert
*
* @apiviz.exclude
*/
public static class Parameterizer extends AbstractParameterizer {
InputStep inputStep = null;
AlgorithmStep algorithmStep = null;
EvaluationStep evaluationStep = null;
Collection<TrackedParameter> settings = null;
OutputStep outputStep = null;
@Override
protected void makeOptions(Parameterization config) {
super.makeOptions(config);
// Track the key parameters for reporting the settings.
TrackParameters track = new TrackParameters(config);
inputStep = track.tryInstantiate(InputStep.class);
algorithmStep = track.tryInstantiate(AlgorithmStep.class);
evaluationStep = track.tryInstantiate(EvaluationStep.class);
// We don't include output parameters
settings = track.getAllParameters();
// configure output with the original parameterization
outputStep = config.tryInstantiate(OutputStep.class);
}
@Override
protected KDDTask makeInstance() {
return new KDDTask(inputStep, algorithmStep, evaluationStep, outputStep, settings);
}
}
/**
* Runs a KDD task accordingly to the specified parameters.
*
* @param args parameter list according to description
*/
public static void main(String[] args) {
KDDCLIApplication.runCLIApplication(KDDCLIApplication.class, args);
}
}
|
