retreval 0.1 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,54 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8
+
9
+ <title>File: retreval [RDoc Documentation]</title>
10
+
11
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="../js/jquery.js" type="text/javascript"
14
+ charset="utf-8"></script>
15
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
16
+ charset="utf-8"></script>
17
+ <script src="../js/quicksearch.js" type="text/javascript"
18
+ charset="utf-8"></script>
19
+ <script src="../js/darkfish.js" type="text/javascript"
20
+ charset="utf-8"></script>
21
+ </head>
22
+
23
+ <body class="file file-popup">
24
+ <div id="metadata">
25
+ <dl>
26
+ <dt class="modified-date">Last Modified</dt>
27
+ <dd class="modified-date">2011-03-13 00:09:50 +0100</dd>
28
+
29
+
30
+ <dt class="requires">Requires</dt>
31
+ <dd class="requires">
32
+ <ul>
33
+
34
+ <li>retreval/runner</li>
35
+
36
+ </ul>
37
+ </dd>
38
+
39
+
40
+
41
+ </dl>
42
+ </div>
43
+
44
+ <div id="documentation">
45
+
46
+ <div class="description">
47
+ <h2>Description</h2>
48
+
49
+ </div>
50
+
51
+ </div>
52
+ </body>
53
+ </html>
54
+
@@ -0,0 +1,10 @@
1
+ Wed, 06 Apr 2011 10:35:35 +0200
2
+ ./bin/retreval Sun, 13 Mar 2011 00:09:50 +0100
3
+ ./CHANGELOG Sun, 13 Mar 2011 11:19:06 +0100
4
+ ./lib/retreval/gold_standard.rb Wed, 06 Apr 2011 10:29:49 +0200
5
+ ./lib/retreval/options.rb Sun, 13 Mar 2011 00:12:22 +0100
6
+ ./lib/retreval/query_result.rb Wed, 06 Apr 2011 10:34:20 +0200
7
+ ./lib/retreval/runner.rb Tue, 05 Apr 2011 15:22:49 +0200
8
+ ./test/test_gold_standard.rb Tue, 05 Apr 2011 15:32:54 +0200
9
+ ./test/test_query_result.rb Tue, 05 Apr 2011 15:32:58 +0200
10
+ ./TODO Wed, 06 Apr 2011 10:35:25 +0200
@@ -0,0 +1,218 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8
+
9
+ <title>RDoc Documentation</title>
10
+
11
+ <link type="text/css" media="screen" href="rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="js/jquery.js" type="text/javascript" charset="utf-8"></script>
14
+ <script src="js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
15
+ <script src="js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
16
+ <script src="js/darkfish.js" type="text/javascript" charset="utf-8"></script>
17
+
18
+ </head>
19
+ <body class="indexpage">
20
+
21
+
22
+ <h1>RDoc Documentation</h1>
23
+
24
+
25
+ <p>This is the API documentation for 'RDoc Documentation'.</p>
26
+
27
+
28
+
29
+
30
+ <h2>Files</h2>
31
+ <ul>
32
+
33
+ <li class="file"><a href="CHANGELOG.html">CHANGELOG</a></li>
34
+
35
+ <li class="file"><a href="TODO.html">TODO</a></li>
36
+
37
+ </ul>
38
+
39
+
40
+ <h2 id="classes">Classes/Modules</h2>
41
+ <ul>
42
+
43
+ <li class="module"><a href="Retreval.html">Retreval</a></li>
44
+
45
+ <li class="class"><a href="Retreval/Document.html">Retreval::Document</a></li>
46
+
47
+ <li class="class"><a href="Retreval/GoldStandard.html">Retreval::GoldStandard</a></li>
48
+
49
+ <li class="class"><a href="Retreval/Judgement.html">Retreval::Judgement</a></li>
50
+
51
+ <li class="class"><a href="Retreval/Options.html">Retreval::Options</a></li>
52
+
53
+ <li class="class"><a href="Retreval/Query.html">Retreval::Query</a></li>
54
+
55
+ <li class="class"><a href="Retreval/QueryResult.html">Retreval::QueryResult</a></li>
56
+
57
+ <li class="class"><a href="Retreval/QueryResultSet.html">Retreval::QueryResultSet</a></li>
58
+
59
+ <li class="class"><a href="Retreval/RankedQueryResult.html">Retreval::RankedQueryResult</a></li>
60
+
61
+ <li class="class"><a href="Retreval/ResultDocument.html">Retreval::ResultDocument</a></li>
62
+
63
+ <li class="class"><a href="Retreval/Runner.html">Retreval::Runner</a></li>
64
+
65
+ <li class="class"><a href="Retreval/UnrankedQueryResult.html">Retreval::UnrankedQueryResult</a></li>
66
+
67
+ <li class="class"><a href="Retreval/User.html">Retreval::User</a></li>
68
+
69
+ <li class="class"><a href="TestGoldStandard.html">TestGoldStandard</a></li>
70
+
71
+ <li class="class"><a href="TestQueryResult.html">TestQueryResult</a></li>
72
+
73
+ </ul>
74
+
75
+ <h2 id="methods">Methods</h2>
76
+ <ul>
77
+
78
+ <li><a href="Retreval/GoldStandard.html#method-c-new">::new &mdash; Retreval::GoldStandard</a></li>
79
+
80
+ <li><a href="Retreval/QueryResult.html#method-c-new">::new &mdash; Retreval::QueryResult</a></li>
81
+
82
+ <li><a href="Retreval/QueryResultSet.html#method-c-new">::new &mdash; Retreval::QueryResultSet</a></li>
83
+
84
+ <li><a href="Retreval/RankedQueryResult.html#method-c-new">::new &mdash; Retreval::RankedQueryResult</a></li>
85
+
86
+ <li><a href="Retreval/Query.html#method-c-new">::new &mdash; Retreval::Query</a></li>
87
+
88
+ <li><a href="Retreval/Options.html#method-c-new">::new &mdash; Retreval::Options</a></li>
89
+
90
+ <li><a href="Retreval/Document.html#method-c-new">::new &mdash; Retreval::Document</a></li>
91
+
92
+ <li><a href="Retreval/Judgement.html#method-c-new">::new &mdash; Retreval::Judgement</a></li>
93
+
94
+ <li><a href="Retreval/Runner.html#method-c-new">::new &mdash; Retreval::Runner</a></li>
95
+
96
+ <li><a href="Retreval/ResultDocument.html#method-c-new">::new &mdash; Retreval::ResultDocument</a></li>
97
+
98
+ <li><a href="Retreval/UnrankedQueryResult.html#method-c-new">::new &mdash; Retreval::UnrankedQueryResult</a></li>
99
+
100
+ <li><a href="Retreval/User.html#method-c-new">::new &mdash; Retreval::User</a></li>
101
+
102
+ <li><a href="Retreval/GoldStandard.html#method-i-%3C%3C">#<< &mdash; Retreval::GoldStandard</a></li>
103
+
104
+ <li><a href="Retreval/QueryResult.html#method-i-%3C%3C">#<< &mdash; Retreval::QueryResult</a></li>
105
+
106
+ <li><a href="Retreval/Query.html#method-i-%3D%3D">#== &mdash; Retreval::Query</a></li>
107
+
108
+ <li><a href="Retreval/Judgement.html#method-i-%3D%3D">#== &mdash; Retreval::Judgement</a></li>
109
+
110
+ <li><a href="Retreval/User.html#method-i-%3D%3D">#== &mdash; Retreval::User</a></li>
111
+
112
+ <li><a href="Retreval/Document.html#method-i-%3D%3D">#== &mdash; Retreval::Document</a></li>
113
+
114
+ <li><a href="Retreval/QueryResult.html#method-i-add_document">#add_document &mdash; Retreval::QueryResult</a></li>
115
+
116
+ <li><a href="Retreval/GoldStandard.html#method-i-add_judgement">#add_judgement &mdash; Retreval::GoldStandard</a></li>
117
+
118
+ <li><a href="Retreval/User.html#method-i-add_judgement">#add_judgement &mdash; Retreval::User</a></li>
119
+
120
+ <li><a href="TestQueryResult.html#method-i-add_ranked_query_result">#add_ranked_query_result &mdash; TestQueryResult</a></li>
121
+
122
+ <li><a href="Retreval/QueryResultSet.html#method-i-add_result">#add_result &mdash; Retreval::QueryResultSet</a></li>
123
+
124
+ <li><a href="TestGoldStandard.html#method-i-add_test_judgement">#add_test_judgement &mdash; TestGoldStandard</a></li>
125
+
126
+ <li><a href="TestQueryResult.html#method-i-add_test_judgements">#add_test_judgements &mdash; TestQueryResult</a></li>
127
+
128
+ <li><a href="TestQueryResult.html#method-i-add_unranked_query_result">#add_unranked_query_result &mdash; TestQueryResult</a></li>
129
+
130
+ <li><a href="Retreval/RankedQueryResult.html#method-i-average_precision">#average_precision &mdash; Retreval::RankedQueryResult</a></li>
131
+
132
+ <li><a href="Retreval/Runner.html#method-i-begin_calculations">#begin_calculations &mdash; Retreval::Runner</a></li>
133
+
134
+ <li><a href="Retreval/QueryResult.html#method-i-calculate">#calculate &mdash; Retreval::QueryResult</a></li>
135
+
136
+ <li><a href="Retreval/QueryResult.html#method-i-cleanup">#cleanup &mdash; Retreval::QueryResult</a></li>
137
+
138
+ <li><a href="Retreval/GoldStandard.html#method-i-contains_document%3F">#contains_document? &mdash; Retreval::GoldStandard</a></li>
139
+
140
+ <li><a href="Retreval/GoldStandard.html#method-i-contains_judgement%3F">#contains_judgement? &mdash; Retreval::GoldStandard</a></li>
141
+
142
+ <li><a href="Retreval/GoldStandard.html#method-i-contains_query%3F">#contains_query? &mdash; Retreval::GoldStandard</a></li>
143
+
144
+ <li><a href="Retreval/GoldStandard.html#method-i-contains_user%3F">#contains_user? &mdash; Retreval::GoldStandard</a></li>
145
+
146
+ <li><a href="Retreval/RankedQueryResult.html#method-i-eleven_point_precision">#eleven_point_precision &mdash; Retreval::RankedQueryResult</a></li>
147
+
148
+ <li><a href="Retreval/QueryResult.html#method-i-f_measure">#f_measure &mdash; Retreval::QueryResult</a></li>
149
+
150
+ <li><a href="Retreval/GoldStandard.html#method-i-kappa">#kappa &mdash; Retreval::GoldStandard</a></li>
151
+
152
+ <li><a href="Retreval/GoldStandard.html#method-i-load_from_plaintext_file">#load_from_plaintext_file &mdash; Retreval::GoldStandard</a></li>
153
+
154
+ <li><a href="Retreval/GoldStandard.html#method-i-load_from_yaml_file">#load_from_yaml_file &mdash; Retreval::GoldStandard</a></li>
155
+
156
+ <li><a href="Retreval/QueryResultSet.html#method-i-load_from_yaml_file">#load_from_yaml_file &mdash; Retreval::QueryResultSet</a></li>
157
+
158
+ <li><a href="Retreval/QueryResult.html#method-i-load_from_yaml_file">#load_from_yaml_file &mdash; Retreval::QueryResult</a></li>
159
+
160
+ <li><a href="Retreval/Runner.html#method-i-load_gold_standard">#load_gold_standard &mdash; Retreval::Runner</a></li>
161
+
162
+ <li><a href="Retreval/Runner.html#method-i-load_query_result_set">#load_query_result_set &mdash; Retreval::Runner</a></li>
163
+
164
+ <li><a href="Retreval/QueryResultSet.html#method-i-mean_average_precision">#mean_average_precision &mdash; Retreval::QueryResultSet</a></li>
165
+
166
+ <li><a href="Retreval/GoldStandard.html#method-i-pairwise_kappa">#pairwise_kappa &mdash; Retreval::GoldStandard</a></li>
167
+
168
+ <li><a href="Retreval/Options.html#method-i-parse">#parse &mdash; Retreval::Options</a></li>
169
+
170
+ <li><a href="Retreval/QueryResult.html#method-i-print_contingency_table">#print_contingency_table &mdash; Retreval::QueryResult</a></li>
171
+
172
+ <li><a href="Retreval/RankedQueryResult.html#method-i-print_eleven_point_precision_table">#print_eleven_point_precision_table &mdash; Retreval::RankedQueryResult</a></li>
173
+
174
+ <li><a href="Retreval/RankedQueryResult.html#method-i-print_ranked_table">#print_ranked_table &mdash; Retreval::RankedQueryResult</a></li>
175
+
176
+ <li><a href="Retreval/GoldStandard.html#method-i-relevant%3F">#relevant? &mdash; Retreval::GoldStandard</a></li>
177
+
178
+ <li><a href="Retreval/Runner.html#method-i-run">#run &mdash; Retreval::Runner</a></li>
179
+
180
+ <li><a href="Retreval/RankedQueryResult.html#method-i-statistics">#statistics &mdash; Retreval::RankedQueryResult</a></li>
181
+
182
+ <li><a href="Retreval/UnrankedQueryResult.html#method-i-statistics">#statistics &mdash; Retreval::UnrankedQueryResult</a></li>
183
+
184
+ <li><a href="TestGoldStandard.html#method-i-test_document">#test_document &mdash; TestGoldStandard</a></li>
185
+
186
+ <li><a href="TestQueryResult.html#method-i-test_eleven_point_precision">#test_eleven_point_precision &mdash; TestQueryResult</a></li>
187
+
188
+ <li><a href="TestGoldStandard.html#method-i-test_judgement">#test_judgement &mdash; TestGoldStandard</a></li>
189
+
190
+ <li><a href="TestGoldStandard.html#method-i-test_kappa_ir_book">#test_kappa_ir_book &mdash; TestGoldStandard</a></li>
191
+
192
+ <li><a href="TestGoldStandard.html#method-i-test_kappa_wikipedia">#test_kappa_wikipedia &mdash; TestGoldStandard</a></li>
193
+
194
+ <li><a href="TestGoldStandard.html#method-i-test_query">#test_query &mdash; TestGoldStandard</a></li>
195
+
196
+ <li><a href="TestQueryResult.html#method-i-test_ranked_precision">#test_ranked_precision &mdash; TestQueryResult</a></li>
197
+
198
+ <li><a href="TestQueryResult.html#method-i-test_ranked_recall">#test_ranked_recall &mdash; TestQueryResult</a></li>
199
+
200
+ <li><a href="TestGoldStandard.html#method-i-test_relevant">#test_relevant &mdash; TestGoldStandard</a></li>
201
+
202
+ <li><a href="TestQueryResult.html#method-i-test_unranked_precision">#test_unranked_precision &mdash; TestQueryResult</a></li>
203
+
204
+ <li><a href="TestQueryResult.html#method-i-test_unranked_recall">#test_unranked_recall &mdash; TestQueryResult</a></li>
205
+
206
+ <li><a href="TestGoldStandard.html#method-i-test_user">#test_user &mdash; TestGoldStandard</a></li>
207
+
208
+ <li><a href="Retreval/Runner.html#method-i-write_to_yaml_file">#write_to_yaml_file &mdash; Retreval::Runner</a></li>
209
+
210
+ </ul>
211
+
212
+ <div id="validator-badges">
213
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
214
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
215
+ Rdoc Generator</a> 1.1.6</small>.</p>
216
+ </div>
217
+ </body>
218
+ </html>
@@ -0,0 +1,52 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8
+
9
+ <title>File: gold_standard.rb [RDoc Documentation]</title>
10
+
11
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="../../js/jquery.js" type="text/javascript"
14
+ charset="utf-8"></script>
15
+ <script src="../../js/thickbox-compressed.js" type="text/javascript"
16
+ charset="utf-8"></script>
17
+ <script src="../../js/quicksearch.js" type="text/javascript"
18
+ charset="utf-8"></script>
19
+ <script src="../../js/darkfish.js" type="text/javascript"
20
+ charset="utf-8"></script>
21
+ </head>
22
+
23
+ <body class="file file-popup">
24
+ <div id="metadata">
25
+ <dl>
26
+ <dt class="modified-date">Last Modified</dt>
27
+ <dd class="modified-date">2011-04-06 10:29:49 +0200</dd>
28
+
29
+
30
+ <dt class="requires">Requires</dt>
31
+ <dd class="requires">
32
+ <ul>
33
+
34
+ </ul>
35
+ </dd>
36
+
37
+
38
+
39
+ </dl>
40
+ </div>
41
+
42
+ <div id="documentation">
43
+
44
+ <div class="description">
45
+ <h2>Description</h2>
46
+
47
+ </div>
48
+
49
+ </div>
50
+ </body>
51
+ </html>
52
+
@@ -0,0 +1,56 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8
+
9
+ <title>File: options.rb [RDoc Documentation]</title>
10
+
11
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="../../js/jquery.js" type="text/javascript"
14
+ charset="utf-8"></script>
15
+ <script src="../../js/thickbox-compressed.js" type="text/javascript"
16
+ charset="utf-8"></script>
17
+ <script src="../../js/quicksearch.js" type="text/javascript"
18
+ charset="utf-8"></script>
19
+ <script src="../../js/darkfish.js" type="text/javascript"
20
+ charset="utf-8"></script>
21
+ </head>
22
+
23
+ <body class="file file-popup">
24
+ <div id="metadata">
25
+ <dl>
26
+ <dt class="modified-date">Last Modified</dt>
27
+ <dd class="modified-date">2011-03-13 00:12:22 +0100</dd>
28
+
29
+
30
+ <dt class="requires">Requires</dt>
31
+ <dd class="requires">
32
+ <ul>
33
+
34
+ <li>optparse</li>
35
+
36
+ <li>ostruct</li>
37
+
38
+ </ul>
39
+ </dd>
40
+
41
+
42
+
43
+ </dl>
44
+ </div>
45
+
46
+ <div id="documentation">
47
+
48
+ <div class="description">
49
+ <h2>Description</h2>
50
+
51
+ </div>
52
+
53
+ </div>
54
+ </body>
55
+ </html>
56
+
@@ -0,0 +1,54 @@
1
+ <?xml version="1.0" encoding="utf-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+
5
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
+ <head>
7
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8
+
9
+ <title>File: query_result.rb [RDoc Documentation]</title>
10
+
11
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
12
+
13
+ <script src="../../js/jquery.js" type="text/javascript"
14
+ charset="utf-8"></script>
15
+ <script src="../../js/thickbox-compressed.js" type="text/javascript"
16
+ charset="utf-8"></script>
17
+ <script src="../../js/quicksearch.js" type="text/javascript"
18
+ charset="utf-8"></script>
19
+ <script src="../../js/darkfish.js" type="text/javascript"
20
+ charset="utf-8"></script>
21
+ </head>
22
+
23
+ <body class="file file-popup">
24
+ <div id="metadata">
25
+ <dl>
26
+ <dt class="modified-date">Last Modified</dt>
27
+ <dd class="modified-date">2011-04-06 10:34:20 +0200</dd>
28
+
29
+
30
+ <dt class="requires">Requires</dt>
31
+ <dd class="requires">
32
+ <ul>
33
+
34
+ <li>ostruct</li>
35
+
36
+ </ul>
37
+ </dd>
38
+
39
+
40
+
41
+ </dl>
42
+ </div>
43
+
44
+ <div id="documentation">
45
+
46
+ <div class="description">
47
+ <h2>Description</h2>
48
+
49
+ </div>
50
+
51
+ </div>
52
+ </body>
53
+ </html>
54
+