-
Notifications
You must be signed in to change notification settings - Fork 0
/
documentation_homepage.html
226 lines (197 loc) · 13.1 KB
/
documentation_homepage.html
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
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Table of Contents — Sketching Mathods for Matrices and Data - Final Project 1.0 documentation</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js "></script>
<script type="text/javascript" src="_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>
</head><body>
<div id="navbar" class="navbar navbar-inverse navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="#"><span><img src="_static/icon.png"></span>
Sketching Mathods for Matrices and Data - Final Project</a>
<span class="navbar-text navbar-version pull-left"><b></b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li><a href="main_doc.html">Documentation</a></li>
<li><a href="https://github.com/RedCrow9564/SketchingMethodsInDataAnalysis-Final-Project.git">Git Repo</a></li>
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="#">Site <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Table of Contents</a></li>
<li class="toctree-l1"><a class="reference internal" href="#sketching-methods-for-analysis-of-matrices-and-data-0372-4004-final-project">Sketching Methods for Analysis of Matrices and Data (0372-4004) - Final Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</ul>
</li>
<li class="dropdown">
<a role="button"
id="dLabelLocalToc"
data-toggle="dropdown"
data-target="#"
href="#">Page <b class="caret"></b></a>
<ul class="dropdown-menu localtoc"
role="menu"
aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">Table of Contents</a></li>
<li><a class="reference internal" href="#sketching-methods-for-analysis-of-matrices-and-data-0372-4004-final-project">Sketching Methods for Analysis of Matrices and Data (0372-4004) - Final Project</a><ul>
<li><a class="reference internal" href="#getting-started">Getting Started</a><ul>
<li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
</ul>
</li>
<li><a class="reference internal" href="#running-the-tests">Running the tests</a></li>
<li><a class="reference internal" href="#acknowledgments">Acknowledgments</a></li>
<li><a class="reference internal" href="#license">License</a></li>
<li><a class="reference internal" href="#references">References</a></li>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</ul>
</li>
<li class="hidden-sm">
<div id="sourcelink">
<a href="_sources/documentation_homepage.rst.txt"
rel="nofollow">Source</a>
</div></li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="table-of-contents">
<h1>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Table of Contents</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="#sketching-methods-for-analysis-of-matrices-and-data-0372-4004-final-project">Sketching Methods for Analysis of Matrices and Data (0372-4004) - Final Project</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#getting-started">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="#running-the-tests">Running the tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="#acknowledgments">Acknowledgments</a></li>
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
<li class="toctree-l2"><a class="reference internal" href="#references">References</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</div>
</div>
<div class="section" id="sketching-methods-for-analysis-of-matrices-and-data-0372-4004-final-project">
<h1>Sketching Methods for Analysis of Matrices and Data (0372-4004) - Final Project<a class="headerlink" href="#sketching-methods-for-analysis-of-matrices-and-data-0372-4004-final-project" title="Permalink to this headline">¶</a></h1>
<a class="reference external image-reference" href="https://colab.research.google.com/github/RedCrow9564/SketchingMethodsInDataAnalysis-Final-Project/blob/master/Sketching_Methods_Final_Project.ipynb"><img alt="Open In Colab" src="https://colab.research.google.com/assets/colab-badge.svg" /></a>
<a class="reference external image-reference" href="https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs"><img alt="MIT License" src="https://img.shields.io/apm/l/atomic-design-ui.svg?" /></a>
<a class="reference external image-reference" href="https://github.com/RedCrow9564/SketchingMethodsInDataAnalysis-Final-Project/workflows/Run%20Unit-Tests/badge.svg?branch=master"><img alt="Run Unit-Tests" src="https://github.com/RedCrow9564/SketchingMethodsInDataAnalysis-Final-Project/workflows/Run%20Unit-Tests/badge.svg?branch=master" /></a>
<a class="reference external image-reference" href="https://github.com/RedCrow9564/SketchingMethodsInDataAnalysis-Final-Project/workflows/Compute%20Code%20Metrics/badge.svg?branch=master"><img alt="Compute Code Metrics" src="https://github.com/RedCrow9564/SketchingMethodsInDataAnalysis-Final-Project/workflows/Compute%20Code%20Metrics/badge.svg?branch=master" /></a>
<a class="reference external image-reference" href="https://img.shields.io/github/last-commit/RedCrow9564/SketchingMethodsInDataAnalysis-Final-Project"><img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/RedCrow9564/SketchingMethodsInDataAnalysis-Final-Project" /></a>
<p>This is a project submitted as a requirement for this course. <a class="reference external" href="https://www30.tau.ac.il/yedion/syllabus.asp?course=0372400401">The course</a> was administered in Fall 2019-2020 (before the Coronavirus outbreak…) in <a class="reference external" href="https://en-exact-sciences.tau.ac.il/math">Tel-Aviv University - School of Mathematical Sciences</a>, and taught by <a class="reference external" href="https://english.tau.ac.il/profile/haimav">Prof. Haim Avron</a>.
This project is a reconstruction of experiments of <a class="reference external" href="#1">[1]</a> about an algorithm for faster computation least-square
solutions accurately. A complete documentation of the code is available here.</p>
<div class="section" id="getting-started">
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
<p>The code can be fetched from <a class="reference external" href="https://github.com/RedCrow9564/SketchingMethodsInDataAnalysis-Final-Project">this repo</a>.
The Jupyter Notebook does the same work, and can be deployed to <a class="reference external" href="https://colab.research.google.com/github/RedCrow9564/SketchingMethodsInDataAnalysis-Final-Project/blob/master/Sketching_Methods_Final_Project.ipynb">Google Colab</a>.
While the the notebook version can be used immediately, this code has some prerequisites.
Any questions about this project may be sent by mail to ‘eladeatah’ at mail.tau.ac.il (replace ‘at’ by @).</p>
<div class="section" id="prerequisites">
<h3>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h3>
<p>This code was developed and tested using the following Python 3.7 dependencies. These dependencies are listed in <a class="reference external" href="requirements.txt">requirements.txt</a>.
All these packages can be installed using the ‘pip’ package manager (when the command window is in the main directory where requirements.txt is located):</p>
<div class="highlight-guess notranslate"><div class="highlight"><pre><span></span>pip install -r requirements.txt
</pre></div>
</div>
<p>All the packages, except for Sacred, are available as well using ‘conda’ package manager.</p>
</div>
</div>
<div class="section" id="running-the-tests">
<h2>Running the tests<a class="headerlink" href="#running-the-tests" title="Permalink to this headline">¶</a></h2>
<p>The Unit-Test files are:</p>
<ul class="simple">
<li><p><a class="reference external" href="UnitTests/test_caratheodory_set.py">test_caratheodory_set.py</a> - Tests the Caratheodory booster method.</p></li>
<li><p><a class="reference external" href="UnitTests/test_coreset_methods.py">test_coreset_methods.py</a> - Tests the method which produces the coreset
for a given matrix.</p></li>
</ul>
<p>Running any of these tests can be performed by:</p>
<div class="highlight-guess notranslate"><div class="highlight"><pre><span></span><python_path> -m unittest <test_file_path>
</pre></div>
</div>
</div>
<div class="section" id="acknowledgments">
<h2>Acknowledgments<a class="headerlink" href="#acknowledgments" title="Permalink to this headline">¶</a></h2>
<p>Credits for the original algorithms, paper and results of <a class="reference external" href="#1">[1]</a> belong to its respectful authors: Alaa Maalouf,
Ibrahim Jubran and Dr. Dan Feldman. The <a class="reference external" href="https://github.com/ibramjub/Fast-and-Accurate-Least-Mean-Squares-Solvers">following repo</a>
contains the original code of these researchers which produced the original results.</p>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
<p>This project is licensed under the MIT License - see the <a class="reference external" href="LICENSE">LICENSE</a> file for details</p>
</div>
<div class="section" id="references">
<h2>References<a class="headerlink" href="#references" title="Permalink to this headline">¶</a></h2>
<p><span class="raw-html-m2r"><a id="1">[1]</a></span> <a class="reference external" href="https://papers.nips.cc/paper/9040-fast-and-accurate-least-mean-squares-solvers.pdf">Fast and Accurate Least-Mean-Squares Solvers.
Maalouf, Jubran and Feldman (NIPS 2019)</a>.</p>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
</p>
<p>
© Copyright 2020, Elad Eatah.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.<br/>
</p>
</div>
</footer>
</body>
</html>