/
ParameterObserverCV.h
110 lines (95 loc) · 3.33 KB
/
ParameterObserverCV.h
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
/*
* BSD 3-Clause License
*
* Copyright (c) 2017, Shogun-Toolbox e.V. <shogun-team@shogun-toolbox.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Written (W) 2017 Giovanni De Toni
*
*/
#ifndef SHOGUN_PARAMETEROBSERVERCV_H
#define SHOGUN_PARAMETEROBSERVERCV_H
#include <shogun/base/SGObject.h>
#include <shogun/evaluation/CrossValidationStorage.h>
#include <shogun/lib/parameter_observers/ParameterObserverInterface.h>
namespace shogun
{
/**
* Base ParameterObserver class for CrossValidation.
*/
class CParameterObserverCV : public ParameterObserverInterface,
public CSGObject
{
public:
CParameterObserverCV(bool verbose = false);
virtual ~CParameterObserverCV();
virtual void on_next(const TimedObservedValue& value);
virtual void on_error(std::exception_ptr ptr);
virtual void on_complete();
/* Erase all observations done so far */
virtual void clear();
/**
* Get the total number of cross validation runs received
* by this observer.
* @return number of runs.
*/
const int get_num_observations() const;
/**
* Get a CrossValidationStorage object which will store
* the result of a CrossValidation run.
* @param run index of the run
* @return a CrossValidationStorage object
*/
CrossValidationStorage* get_observation(int run) const;
/**
* Print data contained into a CrossValidationStorage object.
* @param value CrossValidationStorage object
*/
void print_observed_value(CrossValidationStorage* value) const;
/**
* Get class name.
* @return class name
*/
virtual const char* get_name() const
{
return "ParameterObserverCV";
}
private:
void print_machine_information(CMachine* machine) const;
protected:
/**
* Observation's vector
*/
std::vector<CrossValidationStorage*> m_observations;
/**
* enable printing of information
*/
bool m_verbose;
};
}
#endif // SHOGUN_PARAMETEROBSERVERCV_H