/usr/include/vigra/random_forest_deprec.hxx is in libvigraimpex-dev 1.9.0+dfsg-10+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 | /************************************************************************/
/* */
/* Copyright 2008 by Ullrich Koethe */
/* */
/* This file is part of the VIGRA computer vision library. */
/* The VIGRA Website is */
/* http://hci.iwr.uni-heidelberg.de/vigra/ */
/* Please direct questions, bug reports, and contributions to */
/* ullrich.koethe@iwr.uni-heidelberg.de or */
/* vigra@informatik.uni-hamburg.de */
/* */
/* Permission is hereby granted, free of charge, to any person */
/* obtaining a copy of this software and associated documentation */
/* files (the "Software"), to deal in the Software without */
/* restriction, including without limitation the rights to use, */
/* copy, modify, merge, publish, distribute, sublicense, and/or */
/* sell copies of the Software, and to permit persons to whom the */
/* Software is furnished to do so, subject to the following */
/* conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the */
/* Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES */
/* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND */
/* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT */
/* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, */
/* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING */
/* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR */
/* OTHER DEALINGS IN THE SOFTWARE. */
/* */
/************************************************************************/
#ifndef VIGRA_RANDOM_FOREST_DEPREC_HXX
#define VIGRA_RANDOM_FOREST_DEPREC_HXX
#include <algorithm>
#include <map>
#include <numeric>
#include <iostream>
#include <ctime>
#include <cstdlib>
#include "vigra/mathutil.hxx"
#include "vigra/array_vector.hxx"
#include "vigra/sized_int.hxx"
#include "vigra/matrix.hxx"
#include "vigra/random.hxx"
#include "vigra/functorexpression.hxx"
namespace vigra
{
/** \addtogroup MachineLearning
**/
//@{
namespace detail
{
template<class DataMatrix>
class RandomForestDeprecFeatureSorter
{
DataMatrix const & data_;
MultiArrayIndex sortColumn_;
public:
RandomForestDeprecFeatureSorter(DataMatrix const & data, MultiArrayIndex sortColumn)
: data_(data),
sortColumn_(sortColumn)
{}
void setColumn(MultiArrayIndex sortColumn)
{
sortColumn_ = sortColumn;
}
bool operator()(MultiArrayIndex l, MultiArrayIndex r) const
{
return data_(l, sortColumn_) < data_(r, sortColumn_);
}
};
template<class LabelArray>
class RandomForestDeprecLabelSorter
{
LabelArray const & labels_;
public:
RandomForestDeprecLabelSorter(LabelArray const & labels)
: labels_(labels)
{}
bool operator()(MultiArrayIndex l, MultiArrayIndex r) const
{
return labels_[l] < labels_[r];
}
};
template <class CountArray>
class RandomForestDeprecClassCounter
{
ArrayVector<int> const & labels_;
CountArray & counts_;
public:
RandomForestDeprecClassCounter(ArrayVector<int> const & labels, CountArray & counts)
: labels_(labels),
counts_(counts)
{
reset();
}
void reset()
{
counts_.init(0);
}
void operator()(MultiArrayIndex l) const
{
++counts_[labels_[l]];
}
};
struct DecisionTreeDeprecCountNonzeroFunctor
{
double operator()(double old, double other) const
{
if(other != 0.0)
++old;
return old;
}
};
struct DecisionTreeDeprecNode
{
DecisionTreeDeprecNode(int t, MultiArrayIndex bestColumn)
: thresholdIndex(t), splitColumn(bestColumn)
{}
int children[2];
int thresholdIndex;
Int32 splitColumn;
};
template <class INT>
struct DecisionTreeDeprecNodeProxy
{
DecisionTreeDeprecNodeProxy(ArrayVector<INT> const & tree, INT n)
: node(const_cast<ArrayVector<INT> &>(tree).begin()+n)
{}
INT & child(INT l) const
{
return node[l];
}
INT & decisionWeightsIndex() const
{
return node[2];
}
typename ArrayVector<INT>::iterator decisionColumns() const
{
return node+3;
}
mutable typename ArrayVector<INT>::iterator node;
};
struct DecisionTreeDeprecAxisSplitFunctor
{
ArrayVector<Int32> splitColumns;
ArrayVector<double> classCounts, currentCounts[2], bestCounts[2], classWeights;
double threshold;
double totalCounts[2], bestTotalCounts[2];
int mtry, classCount, bestSplitColumn;
bool pure[2], isWeighted;
void init(int mtry, int cols, int classCount, ArrayVector<double> const & weights)
{
this->mtry = mtry;
splitColumns.resize(cols);
for(int k=0; k<cols; ++k)
splitColumns[k] = k;
this->classCount = classCount;
classCounts.resize(classCount);
currentCounts[0].resize(classCount);
currentCounts[1].resize(classCount);
bestCounts[0].resize(classCount);
bestCounts[1].resize(classCount);
isWeighted = weights.size() > 0;
if(isWeighted)
classWeights = weights;
else
classWeights.resize(classCount, 1.0);
}
bool isPure(int k) const
{
return pure[k];
}
unsigned int totalCount(int k) const
{
return (unsigned int)bestTotalCounts[k];
}
int sizeofNode() const { return 4; }
int writeSplitParameters(ArrayVector<Int32> & tree,
ArrayVector<double> &terminalWeights)
{
int currentWeightIndex = terminalWeights.size();
terminalWeights.push_back(threshold);
int currentNodeIndex = tree.size();
tree.push_back(-1); // left child
tree.push_back(-1); // right child
tree.push_back(currentWeightIndex);
tree.push_back(bestSplitColumn);
return currentNodeIndex;
}
void writeWeights(int l, ArrayVector<double> &terminalWeights)
{
for(int k=0; k<classCount; ++k)
terminalWeights.push_back(isWeighted
? bestCounts[l][k]
: bestCounts[l][k] / totalCount(l));
}
template <class U, class C, class AxesIterator, class WeightIterator>
bool decideAtNode(MultiArrayView<2, U, C> const & features,
AxesIterator a, WeightIterator w) const
{
return (features(0, *a) < *w);
}
template <class U, class C, class IndexIterator, class Random>
IndexIterator findBestSplit(MultiArrayView<2, U, C> const & features,
ArrayVector<int> const & labels,
IndexIterator indices, int exampleCount,
Random & randint);
};
template <class U, class C, class IndexIterator, class Random>
IndexIterator
DecisionTreeDeprecAxisSplitFunctor::findBestSplit(MultiArrayView<2, U, C> const & features,
ArrayVector<int> const & labels,
IndexIterator indices, int exampleCount,
Random & randint)
{
// select columns to be tried for split
for(int k=0; k<mtry; ++k)
std::swap(splitColumns[k], splitColumns[k+randint(columnCount(features)-k)]);
RandomForestDeprecFeatureSorter<MultiArrayView<2, U, C> > sorter(features, 0);
RandomForestDeprecClassCounter<ArrayVector<double> > counter(labels, classCounts);
std::for_each(indices, indices+exampleCount, counter);
// find the best gini index
double minGini = NumericTraits<double>::max();
IndexIterator bestSplit = indices;
for(int k=0; k<mtry; ++k)
{
sorter.setColumn(splitColumns[k]);
std::sort(indices, indices+exampleCount, sorter);
currentCounts[0].init(0);
std::transform(classCounts.begin(), classCounts.end(), classWeights.begin(),
currentCounts[1].begin(), std::multiplies<double>());
totalCounts[0] = 0;
totalCounts[1] = std::accumulate(currentCounts[1].begin(), currentCounts[1].end(), 0.0);
for(int m = 0; m < exampleCount-1; ++m)
{
int label = labels[indices[m]];
double w = classWeights[label];
currentCounts[0][label] += w;
totalCounts[0] += w;
currentCounts[1][label] -= w;
totalCounts[1] -= w;
if (m < exampleCount-2 &&
features(indices[m], splitColumns[k]) == features(indices[m+1], splitColumns[k]))
continue ;
double gini = 0.0;
if(classCount == 2)
{
gini = currentCounts[0][0]*currentCounts[0][1] / totalCounts[0] +
currentCounts[1][0]*currentCounts[1][1] / totalCounts[1];
}
else
{
for(int l=0; l<classCount; ++l)
gini += currentCounts[0][l]*(1.0 - currentCounts[0][l] / totalCounts[0]) +
currentCounts[1][l]*(1.0 - currentCounts[1][l] / totalCounts[1]);
}
if(gini < minGini)
{
minGini = gini;
bestSplit = indices+m;
bestSplitColumn = splitColumns[k];
bestCounts[0] = currentCounts[0];
bestCounts[1] = currentCounts[1];
}
}
}
//std::cerr << minGini << " " << bestSplitColumn << std::endl;
// split using the best feature
sorter.setColumn(bestSplitColumn);
std::sort(indices, indices+exampleCount, sorter);
for(int k=0; k<2; ++k)
{
bestTotalCounts[k] = std::accumulate(bestCounts[k].begin(), bestCounts[k].end(), 0.0);
}
threshold = (features(bestSplit[0], bestSplitColumn) + features(bestSplit[1], bestSplitColumn)) / 2.0;
++bestSplit;
counter.reset();
std::for_each(indices, bestSplit, counter);
pure[0] = 1.0 == std::accumulate(classCounts.begin(), classCounts.end(), 0.0, DecisionTreeDeprecCountNonzeroFunctor());
counter.reset();
std::for_each(bestSplit, indices+exampleCount, counter);
pure[1] = 1.0 == std::accumulate(classCounts.begin(), classCounts.end(), 0.0, DecisionTreeDeprecCountNonzeroFunctor());
return bestSplit;
}
enum { DecisionTreeDeprecNoParent = -1 };
template <class Iterator>
struct DecisionTreeDeprecStackEntry
{
DecisionTreeDeprecStackEntry(Iterator i, int c,
int lp = DecisionTreeDeprecNoParent, int rp = DecisionTreeDeprecNoParent)
: indices(i), exampleCount(c),
leftParent(lp), rightParent(rp)
{}
Iterator indices;
int exampleCount, leftParent, rightParent;
};
class DecisionTreeDeprec
{
public:
typedef Int32 TreeInt;
ArrayVector<TreeInt> tree_;
ArrayVector<double> terminalWeights_;
unsigned int classCount_;
DecisionTreeDeprecAxisSplitFunctor split;
public:
DecisionTreeDeprec(unsigned int classCount)
: classCount_(classCount)
{}
void reset(unsigned int classCount = 0)
{
if(classCount)
classCount_ = classCount;
tree_.clear();
terminalWeights_.clear();
}
template <class U, class C, class Iterator, class Options, class Random>
void learn(MultiArrayView<2, U, C> const & features,
ArrayVector<int> const & labels,
Iterator indices, int exampleCount,
Options const & options,
Random & randint);
template <class U, class C>
ArrayVector<double>::const_iterator
predict(MultiArrayView<2, U, C> const & features) const
{
int nodeindex = 0;
for(;;)
{
DecisionTreeDeprecNodeProxy<TreeInt> node(tree_, nodeindex);
nodeindex = split.decideAtNode(features, node.decisionColumns(),
terminalWeights_.begin() + node.decisionWeightsIndex())
? node.child(0)
: node.child(1);
if(nodeindex <= 0)
return terminalWeights_.begin() + (-nodeindex);
}
}
template <class U, class C>
int
predictLabel(MultiArrayView<2, U, C> const & features) const
{
ArrayVector<double>::const_iterator weights = predict(features);
return argMax(weights, weights+classCount_) - weights;
}
template <class U, class C>
int
leafID(MultiArrayView<2, U, C> const & features) const
{
int nodeindex = 0;
for(;;)
{
DecisionTreeDeprecNodeProxy<TreeInt> node(tree_, nodeindex);
nodeindex = split.decideAtNode(features, node.decisionColumns(),
terminalWeights_.begin() + node.decisionWeightsIndex())
? node.child(0)
: node.child(1);
if(nodeindex <= 0)
return -nodeindex;
}
}
void depth(int & maxDep, int & interiorCount, int & leafCount, int k = 0, int d = 1) const
{
DecisionTreeDeprecNodeProxy<TreeInt> node(tree_, k);
++interiorCount;
++d;
for(int l=0; l<2; ++l)
{
int child = node.child(l);
if(child > 0)
depth(maxDep, interiorCount, leafCount, child, d);
else
{
++leafCount;
if(maxDep < d)
maxDep = d;
}
}
}
void printStatistics(std::ostream & o) const
{
int maxDep = 0, interiorCount = 0, leafCount = 0;
depth(maxDep, interiorCount, leafCount);
o << "interior nodes: " << interiorCount <<
", terminal nodes: " << leafCount <<
", depth: " << maxDep << "\n";
}
void print(std::ostream & o, int k = 0, std::string s = "") const
{
DecisionTreeDeprecNodeProxy<TreeInt> node(tree_, k);
o << s << (*node.decisionColumns()) << " " << terminalWeights_[node.decisionWeightsIndex()] << "\n";
for(int l=0; l<2; ++l)
{
int child = node.child(l);
if(child <= 0)
o << s << " weights " << terminalWeights_[-child] << " "
<< terminalWeights_[-child+1] << "\n";
else
print(o, child, s+" ");
}
}
};
template <class U, class C, class Iterator, class Options, class Random>
void DecisionTreeDeprec::learn(MultiArrayView<2, U, C> const & features,
ArrayVector<int> const & labels,
Iterator indices, int exampleCount,
Options const & options,
Random & randint)
{
ArrayVector<double> const & classLoss = options.class_weights;
vigra_precondition(classLoss.size() == 0 || classLoss.size() == classCount_,
"DecisionTreeDeprec2::learn(): class weights array has wrong size.");
reset();
unsigned int mtry = options.mtry;
MultiArrayIndex cols = columnCount(features);
split.init(mtry, cols, classCount_, classLoss);
typedef DecisionTreeDeprecStackEntry<Iterator> Entry;
ArrayVector<Entry> stack;
stack.push_back(Entry(indices, exampleCount));
while(!stack.empty())
{
// std::cerr << "*";
indices = stack.back().indices;
exampleCount = stack.back().exampleCount;
int leftParent = stack.back().leftParent,
rightParent = stack.back().rightParent;
stack.pop_back();
Iterator bestSplit = split.findBestSplit(features, labels, indices, exampleCount, randint);
int currentNode = split.writeSplitParameters(tree_, terminalWeights_);
if(leftParent != DecisionTreeDeprecNoParent)
DecisionTreeDeprecNodeProxy<TreeInt>(tree_, leftParent).child(0) = currentNode;
if(rightParent != DecisionTreeDeprecNoParent)
DecisionTreeDeprecNodeProxy<TreeInt>(tree_, rightParent).child(1) = currentNode;
leftParent = currentNode;
rightParent = DecisionTreeDeprecNoParent;
for(int l=0; l<2; ++l)
{
if(!split.isPure(l) && split.totalCount(l) >= options.min_split_node_size)
{
// sample is still large enough and not yet perfectly separated => split
stack.push_back(Entry(indices, split.totalCount(l), leftParent, rightParent));
}
else
{
DecisionTreeDeprecNodeProxy<TreeInt>(tree_, currentNode).child(l) = -(TreeInt)terminalWeights_.size();
split.writeWeights(l, terminalWeights_);
}
std::swap(leftParent, rightParent);
indices = bestSplit;
}
}
// std::cerr << "\n";
}
} // namespace detail
class RandomForestOptionsDeprec
{
public:
/** Initialize all options with default values.
*/
RandomForestOptionsDeprec()
: training_set_proportion(1.0),
mtry(0),
min_split_node_size(1),
training_set_size(0),
sample_with_replacement(true),
sample_classes_individually(false),
treeCount(255)
{}
/** Number of features considered in each node.
If \a n is 0 (the default), the number of features tried in every node
is determined by the square root of the total number of features.
According to Breiman, this quantity should always be optimized by means
of the out-of-bag error.<br>
Default: 0 (use <tt>sqrt(columnCount(featureMatrix))</tt>)
*/
RandomForestOptionsDeprec & featuresPerNode(unsigned int n)
{
mtry = n;
return *this;
}
/** How to sample the subset of the training data for each tree.
Each tree is only trained with a subset of the entire training data.
If \a r is <tt>true</tt>, this subset is sampled from the entire training set with
replacement.<br>
Default: <tt>true</tt> (use sampling with replacement))
*/
RandomForestOptionsDeprec & sampleWithReplacement(bool r)
{
sample_with_replacement = r;
return *this;
}
RandomForestOptionsDeprec & setTreeCount(unsigned int cnt)
{
treeCount = cnt;
return *this;
}
/** Proportion of training examples used for each tree.
If \a p is 1.0 (the default), and samples are drawn with replacement,
the training set of each tree will contain as many examples as the entire
training set, but some are drawn multiply and others not at all. On average,
each tree is actually trained on about 65% of the examples in the full
training set. Changing the proportion makes mainly sense when
sampleWithReplacement() is set to <tt>false</tt>. trainingSetSizeProportional() gets
overridden by trainingSetSizeAbsolute().<br>
Default: 1.0
*/
RandomForestOptionsDeprec & trainingSetSizeProportional(double p)
{
vigra_precondition(p >= 0.0 && p <= 1.0,
"RandomForestOptionsDeprec::trainingSetSizeProportional(): proportion must be in [0, 1].");
if(training_set_size == 0) // otherwise, absolute size gets priority
training_set_proportion = p;
return *this;
}
/** Size of the training set for each tree.
If this option is set, it overrides the proportion set by
trainingSetSizeProportional(). When classes are sampled individually,
the number of examples is divided by the number of classes (rounded upwards)
to determine the number of examples drawn from every class.<br>
Default: <tt>0</tt> (determine size by proportion)
*/
RandomForestOptionsDeprec & trainingSetSizeAbsolute(unsigned int s)
{
training_set_size = s;
if(s > 0)
training_set_proportion = 0.0;
return *this;
}
/** Are the classes sampled individually?
If \a s is <tt>false</tt> (the default), the training set for each tree is sampled
without considering class labels. Otherwise, samples are drawn from each
class independently. The latter is especially useful in connection
with the specification of an absolute training set size: then, the same number of
examples is drawn from every class. This can be used as a counter-measure when the
classes are very unbalanced in size.<br>
Default: <tt>false</tt>
*/
RandomForestOptionsDeprec & sampleClassesIndividually(bool s)
{
sample_classes_individually = s;
return *this;
}
/** Number of examples required for a node to be split.
When the number of examples in a node is below this number, the node is not
split even if class separation is not yet perfect. Instead, the node returns
the proportion of each class (among the remaining examples) during the
prediction phase.<br>
Default: 1 (complete growing)
*/
RandomForestOptionsDeprec & minSplitNodeSize(unsigned int n)
{
if(n == 0)
n = 1;
min_split_node_size = n;
return *this;
}
/** Use a weighted random forest.
This is usually used to penalize the errors for the minority class.
Weights must be convertible to <tt>double</tt>, and the array of weights
must contain as many entries as there are classes.<br>
Default: do not use weights
*/
template <class WeightIterator>
RandomForestOptionsDeprec & weights(WeightIterator weights, unsigned int classCount)
{
class_weights.clear();
if(weights != 0)
class_weights.insert(weights, classCount);
return *this;
}
RandomForestOptionsDeprec & oobData(MultiArrayView<2, UInt8>& data)
{
oob_data =data;
return *this;
}
MultiArrayView<2, UInt8> oob_data;
ArrayVector<double> class_weights;
double training_set_proportion;
unsigned int mtry, min_split_node_size, training_set_size;
bool sample_with_replacement, sample_classes_individually;
unsigned int treeCount;
};
/*****************************************************************/
/* */
/* RandomForestDeprec */
/* */
/*****************************************************************/
template <class ClassLabelType>
class RandomForestDeprec
{
public:
ArrayVector<ClassLabelType> classes_;
ArrayVector<detail::DecisionTreeDeprec> trees_;
MultiArrayIndex columnCount_;
RandomForestOptionsDeprec options_;
public:
//First two constructors are straight forward.
//they take either the iterators to an Array of Classlabels or the values
template<class ClassLabelIterator>
RandomForestDeprec(ClassLabelIterator cl, ClassLabelIterator cend,
unsigned int treeCount = 255,
RandomForestOptionsDeprec const & options = RandomForestOptionsDeprec())
: classes_(cl, cend),
trees_(treeCount, detail::DecisionTreeDeprec(classes_.size())),
columnCount_(0),
options_(options)
{
vigra_precondition(options.training_set_proportion == 0.0 ||
options.training_set_size == 0,
"RandomForestOptionsDeprec: absolute and proportional training set sizes "
"cannot be specified at the same time.");
vigra_precondition(classes_.size() > 1,
"RandomForestOptionsDeprec::weights(): need at least two classes.");
vigra_precondition(options.class_weights.size() == 0 || options.class_weights.size() == classes_.size(),
"RandomForestOptionsDeprec::weights(): wrong number of classes.");
}
RandomForestDeprec(ClassLabelType const & c1, ClassLabelType const & c2,
unsigned int treeCount = 255,
RandomForestOptionsDeprec const & options = RandomForestOptionsDeprec())
: classes_(2),
trees_(treeCount, detail::DecisionTreeDeprec(2)),
columnCount_(0),
options_(options)
{
vigra_precondition(options.class_weights.size() == 0 || options.class_weights.size() == 2,
"RandomForestOptionsDeprec::weights(): wrong number of classes.");
classes_[0] = c1;
classes_[1] = c2;
}
//This is esp. For the CrosValidator Class
template<class ClassLabelIterator>
RandomForestDeprec(ClassLabelIterator cl, ClassLabelIterator cend,
RandomForestOptionsDeprec const & options )
: classes_(cl, cend),
trees_(options.treeCount , detail::DecisionTreeDeprec(classes_.size())),
columnCount_(0),
options_(options)
{
vigra_precondition(options.training_set_proportion == 0.0 ||
options.training_set_size == 0,
"RandomForestOptionsDeprec: absolute and proportional training set sizes "
"cannot be specified at the same time.");
vigra_precondition(classes_.size() > 1,
"RandomForestOptionsDeprec::weights(): need at least two classes.");
vigra_precondition(options.class_weights.size() == 0 || options.class_weights.size() == classes_.size(),
"RandomForestOptionsDeprec::weights(): wrong number of classes.");
}
//Not understood yet
//Does not use the options object but the columnCount object.
template<class ClassLabelIterator, class TreeIterator, class WeightIterator>
RandomForestDeprec(ClassLabelIterator cl, ClassLabelIterator cend,
unsigned int treeCount, unsigned int columnCount,
TreeIterator trees, WeightIterator weights)
: classes_(cl, cend),
trees_(treeCount, detail::DecisionTreeDeprec(classes_.size())),
columnCount_(columnCount)
{
for(unsigned int k=0; k<treeCount; ++k, ++trees, ++weights)
{
trees_[k].tree_ = *trees;
trees_[k].terminalWeights_ = *weights;
}
}
int featureCount() const
{
vigra_precondition(columnCount_ > 0,
"RandomForestDeprec::featureCount(): Random forest has not been trained yet.");
return columnCount_;
}
int labelCount() const
{
return classes_.size();
}
int treeCount() const
{
return trees_.size();
}
// loss == 0.0 means unweighted random forest
template <class U, class C, class Array, class Random>
double learn(MultiArrayView<2, U, C> const & features, Array const & labels,
Random const& random);
template <class U, class C, class Array>
double learn(MultiArrayView<2, U, C> const & features, Array const & labels)
{
RandomNumberGenerator<> generator(RandomSeed);
return learn(features, labels, generator);
}
template <class U, class C>
ClassLabelType predictLabel(MultiArrayView<2, U, C> const & features) const;
template <class U, class C1, class T, class C2>
void predictLabels(MultiArrayView<2, U, C1> const & features,
MultiArrayView<2, T, C2> & labels) const
{
vigra_precondition(features.shape(0) == labels.shape(0),
"RandomForestDeprec::predictLabels(): Label array has wrong size.");
for(int k=0; k<features.shape(0); ++k)
labels(k,0) = predictLabel(rowVector(features, k));
}
template <class U, class C, class Iterator>
ClassLabelType predictLabel(MultiArrayView<2, U, C> const & features,
Iterator priors) const;
template <class U, class C1, class T, class C2>
void predictProbabilities(MultiArrayView<2, U, C1> const & features,
MultiArrayView<2, T, C2> & prob) const;
template <class U, class C1, class T, class C2>
void predictNodes(MultiArrayView<2, U, C1> const & features,
MultiArrayView<2, T, C2> & NodeIDs) const;
};
template <class ClassLabelType>
template <class U, class C1, class Array, class Random>
double
RandomForestDeprec<ClassLabelType>::learn(MultiArrayView<2, U, C1> const & features,
Array const & labels,
Random const& random)
{
unsigned int classCount = classes_.size();
unsigned int m = rowCount(features);
unsigned int n = columnCount(features);
vigra_precondition((unsigned int)(m) == (unsigned int)labels.size(),
"RandomForestDeprec::learn(): Label array has wrong size.");
vigra_precondition(options_.training_set_size <= m || options_.sample_with_replacement,
"RandomForestDeprec::learn(): Requested training set size exceeds total number of examples.");
MultiArrayIndex mtry = (options_.mtry == 0)
? int(std::floor(std::sqrt(double(n)) + 0.5))
: options_.mtry;
vigra_precondition(mtry <= (MultiArrayIndex)n,
"RandomForestDeprec::learn(): mtry must be less than number of features.");
MultiArrayIndex msamples = options_.training_set_size;
if(options_.sample_classes_individually)
msamples = int(std::ceil(double(msamples) / classCount));
ArrayVector<int> intLabels(m), classExampleCounts(classCount);
// verify the input labels
int minClassCount;
{
typedef std::map<ClassLabelType, int > LabelChecker;
typedef typename LabelChecker::iterator LabelCheckerIterator;
LabelChecker labelChecker;
for(unsigned int k=0; k<classCount; ++k)
labelChecker[classes_[k]] = k;
for(unsigned int k=0; k<m; ++k)
{
LabelCheckerIterator found = labelChecker.find(labels[k]);
vigra_precondition(found != labelChecker.end(),
"RandomForestDeprec::learn(): Unknown class label encountered.");
intLabels[k] = found->second;
++classExampleCounts[intLabels[k]];
}
minClassCount = *argMin(classExampleCounts.begin(), classExampleCounts.end());
vigra_precondition(minClassCount > 0,
"RandomForestDeprec::learn(): At least one class is missing in the training set.");
if(msamples > 0 && options_.sample_classes_individually &&
!options_.sample_with_replacement)
{
vigra_precondition(msamples <= minClassCount,
"RandomForestDeprec::learn(): Too few examples in smallest class to reach "
"requested training set size.");
}
}
columnCount_ = n;
ArrayVector<int> indices(m);
for(unsigned int k=0; k<m; ++k)
indices[k] = k;
if(options_.sample_classes_individually)
{
detail::RandomForestDeprecLabelSorter<ArrayVector<int> > sorter(intLabels);
std::sort(indices.begin(), indices.end(), sorter);
}
ArrayVector<int> usedIndices(m), oobCount(m), oobErrorCount(m);
UniformIntRandomFunctor<Random> randint(0, m-1, random);
//std::cerr << "Learning a RF \n";
for(unsigned int k=0; k<trees_.size(); ++k)
{
//std::cerr << "Learning tree " << k << " ...\n";
ArrayVector<int> trainingSet;
usedIndices.init(0);
if(options_.sample_classes_individually)
{
int first = 0;
for(unsigned int l=0; l<classCount; ++l)
{
int lc = classExampleCounts[l];
int lsamples = (msamples == 0)
? int(std::ceil(options_.training_set_proportion*lc))
: msamples;
if(options_.sample_with_replacement)
{
for(int ll=0; ll<lsamples; ++ll)
{
trainingSet.push_back(indices[first+randint(lc)]);
++usedIndices[trainingSet.back()];
}
}
else
{
for(int ll=0; ll<lsamples; ++ll)
{
std::swap(indices[first+ll], indices[first+ll+randint(lc-ll)]);
trainingSet.push_back(indices[first+ll]);
++usedIndices[trainingSet.back()];
}
//std::sort(indices.begin(), indices.begin()+lsamples);
}
first += lc;
}
}
else
{
if(msamples == 0)
msamples = int(std::ceil(options_.training_set_proportion*m));
if(options_.sample_with_replacement)
{
for(int l=0; l<msamples; ++l)
{
trainingSet.push_back(indices[randint(m)]);
++usedIndices[trainingSet.back()];
}
}
else
{
for(int l=0; l<msamples; ++l)
{
std::swap(indices[l], indices[l+randint(m-l)/*oikas*/]);
trainingSet.push_back(indices[l]);
++usedIndices[trainingSet.back()];
}
}
}
trees_[k].learn(features, intLabels,
trainingSet.begin(), trainingSet.size(),
options_.featuresPerNode(mtry), randint);
// for(unsigned int l=0; l<m; ++l)
// {
// if(!usedIndices[l])
// {
// ++oobCount[l];
// if(trees_[k].predictLabel(rowVector(features, l)) != intLabels[l])
// ++oobErrorCount[l];
// }
// }
for(unsigned int l=0; l<m; ++l)
{
if(!usedIndices[l])
{
++oobCount[l];
if(trees_[k].predictLabel(rowVector(features, l)) != intLabels[l])
{
++oobErrorCount[l];
if(options_.oob_data.data() != 0)
options_.oob_data(l, k) = 2;
}
else if(options_.oob_data.data() != 0)
{
options_.oob_data(l, k) = 1;
}
}
}
// TODO: default value for oob_data
// TODO: implement variable importance
//if(!options_.sample_with_replacement){
//std::cerr << "done\n";
//trees_[k].print(std::cerr);
#ifdef VIGRA_RF_VERBOSE
trees_[k].printStatistics(std::cerr);
#endif
}
double oobError = 0.0;
int totalOobCount = 0;
for(unsigned int l=0; l<m; ++l)
if(oobCount[l])
{
oobError += double(oobErrorCount[l]) / oobCount[l];
++totalOobCount;
}
return oobError / totalOobCount;
}
template <class ClassLabelType>
template <class U, class C>
ClassLabelType
RandomForestDeprec<ClassLabelType>::predictLabel(MultiArrayView<2, U, C> const & features) const
{
vigra_precondition(columnCount(features) >= featureCount(),
"RandomForestDeprec::predictLabel(): Too few columns in feature matrix.");
vigra_precondition(rowCount(features) == 1,
"RandomForestDeprec::predictLabel(): Feature matrix must have a single row.");
Matrix<double> prob(1, classes_.size());
predictProbabilities(features, prob);
return classes_[argMax(prob)];
}
//Same thing as above with priors for each label !!!
template <class ClassLabelType>
template <class U, class C, class Iterator>
ClassLabelType
RandomForestDeprec<ClassLabelType>::predictLabel(MultiArrayView<2, U, C> const & features,
Iterator priors) const
{
using namespace functor;
vigra_precondition(columnCount(features) >= featureCount(),
"RandomForestDeprec::predictLabel(): Too few columns in feature matrix.");
vigra_precondition(rowCount(features) == 1,
"RandomForestDeprec::predictLabel(): Feature matrix must have a single row.");
Matrix<double> prob(1,classes_.size());
predictProbabilities(features, prob);
std::transform(prob.begin(), prob.end(), priors, prob.begin(), Arg1()*Arg2());
return classes_[argMax(prob)];
}
template <class ClassLabelType>
template <class U, class C1, class T, class C2>
void
RandomForestDeprec<ClassLabelType>::predictProbabilities(MultiArrayView<2, U, C1> const & features,
MultiArrayView<2, T, C2> & prob) const
{
//Features are n xp
//prob is n x NumOfLabel probability for each feature in each class
vigra_precondition(rowCount(features) == rowCount(prob),
"RandomForestDeprec::predictProbabilities(): Feature matrix and probability matrix size mismatch.");
// num of features must be bigger than num of features in Random forest training
// but why bigger?
vigra_precondition(columnCount(features) >= featureCount(),
"RandomForestDeprec::predictProbabilities(): Too few columns in feature matrix.");
vigra_precondition(columnCount(prob) == (MultiArrayIndex)labelCount(),
"RandomForestDeprec::predictProbabilities(): Probability matrix must have as many columns as there are classes.");
//Classify for each row.
for(int row=0; row < rowCount(features); ++row)
{
//contains the weights returned by a single tree???
//thought that one tree has only one vote???
//Pruning???
ArrayVector<double>::const_iterator weights;
//totalWeight == totalVoteCount!
double totalWeight = 0.0;
//Set each VoteCount = 0 - prob(row,l) contains vote counts until
//further normalisation
for(unsigned int l=0; l<classes_.size(); ++l)
prob(row, l) = 0.0;
//Let each tree classify...
for(unsigned int k=0; k<trees_.size(); ++k)
{
//get weights predicted by single tree
weights = trees_[k].predict(rowVector(features, row));
//update votecount.
for(unsigned int l=0; l<classes_.size(); ++l)
{
prob(row, l) += detail::RequiresExplicitCast<T>::cast(weights[l]);
//every weight in totalWeight.
totalWeight += weights[l];
}
}
//Normalise votes in each row by total VoteCount (totalWeight
for(unsigned int l=0; l<classes_.size(); ++l)
prob(row, l) /= detail::RequiresExplicitCast<T>::cast(totalWeight);
}
}
template <class ClassLabelType>
template <class U, class C1, class T, class C2>
void
RandomForestDeprec<ClassLabelType>::predictNodes(MultiArrayView<2, U, C1> const & features,
MultiArrayView<2, T, C2> & NodeIDs) const
{
vigra_precondition(columnCount(features) >= featureCount(),
"RandomForestDeprec::getNodesRF(): Too few columns in feature matrix.");
vigra_precondition(rowCount(features) <= rowCount(NodeIDs),
"RandomForestDeprec::getNodesRF(): Too few rows in NodeIds matrix");
vigra_precondition(columnCount(NodeIDs) >= treeCount(),
"RandomForestDeprec::getNodesRF(): Too few columns in NodeIds matrix.");
NodeIDs.init(0);
for(unsigned int k=0; k<trees_.size(); ++k)
{
for(int row=0; row < rowCount(features); ++row)
{
NodeIDs(row,k) = trees_[k].leafID(rowVector(features, row));
}
}
}
//@}
} // namespace vigra
#endif // VIGRA_RANDOM_FOREST_HXX
|