Skip to content

Commit

Permalink
Deployed 7a90226 with MkDocs version: 1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@mmarkakis
mmarkakis committed Oct 22, 2024
1 parent fd1612a commit 36d0b6a
Show file tree
Hide file tree
Showing 13 changed files with 5,979 additions and 5,656 deletions.
45 changes: 25 additions & 20 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -347,27 +347,27 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#demo" class="md-nav__link">
<a href="#openai-integration" class="md-nav__link">
<span class="md-ellipsis">
Demo
OpenAI integration
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#documentation" class="md-nav__link">
<a href="#trying-out-logos" class="md-nav__link">
<span class="md-ellipsis">
Documentation
Trying out LOGos
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#openai-integration" class="md-nav__link">
<a href="#reproducing-our-evaluation" class="md-nav__link">
<span class="md-ellipsis">
OpenAI integration
Reproducing our evaluation
</span>
</a>

Expand Down Expand Up @@ -1067,27 +1067,27 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#demo" class="md-nav__link">
<a href="#openai-integration" class="md-nav__link">
<span class="md-ellipsis">
Demo
OpenAI integration
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#documentation" class="md-nav__link">
<a href="#trying-out-logos" class="md-nav__link">
<span class="md-ellipsis">
Documentation
Trying out LOGos
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#openai-integration" class="md-nav__link">
<a href="#reproducing-our-evaluation" class="md-nav__link">
<span class="md-ellipsis">
OpenAI integration
Reproducing our evaluation
</span>
</a>

Expand All @@ -1109,15 +1109,20 @@


<h1 id="logos">LOGos</h1>
<p>Utilizing system logs to perform causal analysis.</p>
<h3 id="demo">Demo</h3>
<p>You can find a quick demo of the LOGos API at <a href="demo.ipynb">demo.ipynb</a>. </p>
<h3 id="documentation">Documentation</h3>
<p>To view the documentation, run <code>mkdocs serve</code> from the root of this repo and open the corresponding page. </p>
<p>You might need to install the following packages:
<code>pip install mkdocs-material mkdocs-gen-files mkdocs-literate-nav markdown_include pymdown-extensions markdown mkdocs-pymdownx Pygments mkdocs-jupyter mkdocstrings-python mkdocstrings mdx_include</code></p>
<p>Utilizing system logs to perform causal analysis. You can access the documentation <a href="https://mitdbg.github.io/logos">here</a>.</p>
<p>Please begin by installing the Python packages required for this project by running <code>pip install -r requirements.txt</code>.</p>
<h3 id="openai-integration">OpenAI integration</h3>
<p>If you use the LLM-powered capabilites of LOGos, please add a <code>.env</code> file to the root of this repo and define <code>OPENAI_API_KEY</code> appropriately.</p>
<p>In order to use the LLM-powered capabilites of LOGos, please add a <code>.env</code> file to the root of this repo and define <code>OPENAI_API_KEY</code> appropriately.</p>
<h3 id="trying-out-logos">Trying out LOGos</h3>
<p>For an introduction to our Python-based interface at <a href="demo/demo.ipynb"><code>demo/demo.ipynb</code></a>.</p>
<p>We also offer a UI-based demo, which you can launch by running </p>
<h3 id="reproducing-our-evaluation">Reproducing our evaluation</h3>
<p>To reproduce the evaluation from our VLDB paper, please follow the following steps:</p>
<ol>
<li>Follow the instructions in <code>dataset_files/README.md</code> to gain access to our datasets.</li>
<li>Within <code>evaluation/</code>, you will find directories based on each experiment presented in our paper. Based on the experiment you would like to reproduce, switch into the appropriate directory and run the <code>reproduce.sh</code> script (you may need to edit file permissions to make it executable). This will run the experiment and plot the results.</li>
<li>Find the resulting plots in <code>evaluation/repro_plots/</code>. The raw data for each plot will be saved in <code>evaluation/repro_plots_data/</code>.</li>
</ol>



Expand Down
Binary file modified objects.inv
View file
Binary file not shown.
1,848 changes: 924 additions & 924 deletions reference/logos/drain/index.html
View file

Large diffs are not rendered by default.

1,372 changes: 789 additions & 583 deletions reference/logos/edge_occurrence_tree/index.html
View file

Large diffs are not rendered by default.

104 changes: 50 additions & 54 deletions reference/logos/interactive_causal_graph_refiner/index.html
View file

Large diffs are not rendered by default.

6,559 changes: 3,336 additions & 3,223 deletions reference/logos/logos/index.html
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions reference/logos/printer/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1258,7 +1258,7 @@ <h2 id="logos.printer.Printer" class="doc doc-heading">
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11"></a><span class="sd"> A flag indicating whether or not to print messages to the console.</span>
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12"></a><span class="sd"> &quot;&quot;&quot;</span>
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13"></a> <span class="n">SAWMILL_VERBOSE</span> <span class="o">=</span> <span class="kc">False</span>
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13"></a> <span class="n">LOGOS_VERBOSE</span> <span class="o">=</span> <span class="kc">False</span>
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14"></a>
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15"></a> <span class="nd">@classmethod</span>
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16"></a> <span class="k">def</span> <span class="nf">printv</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
Expand All @@ -1268,7 +1268,7 @@ <h2 id="logos.printer.Printer" class="doc doc-heading">
</span><span id="__span-0-20"><a id="__codelineno-0-20" name="__codelineno-0-20"></a><span class="sd"> Parameters:</span>
</span><span id="__span-0-21"><a id="__codelineno-0-21" name="__codelineno-0-21"></a><span class="sd"> msg: The message to be printed.</span>
</span><span id="__span-0-22"><a id="__codelineno-0-22" name="__codelineno-0-22"></a><span class="sd"> &quot;&quot;&quot;</span>
</span><span id="__span-0-23"><a id="__codelineno-0-23" name="__codelineno-0-23"></a> <span class="k">if</span> <span class="n">Printer</span><span class="o">.</span><span class="n">SAWMILL_VERBOSE</span><span class="p">:</span>
</span><span id="__span-0-23"><a id="__codelineno-0-23" name="__codelineno-0-23"></a> <span class="k">if</span> <span class="n">Printer</span><span class="o">.</span><span class="n">LOGOS_VERBOSE</span><span class="p">:</span>
</span><span id="__span-0-24"><a id="__codelineno-0-24" name="__codelineno-0-24"></a> <span class="nb">print</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
</span><span id="__span-0-25"><a id="__codelineno-0-25" name="__codelineno-0-25"></a>
</span><span id="__span-0-26"><a id="__codelineno-0-26" name="__codelineno-0-26"></a> <span class="nd">@classmethod</span>
Expand All @@ -1279,7 +1279,7 @@ <h2 id="logos.printer.Printer" class="doc doc-heading">
</span><span id="__span-0-31"><a id="__codelineno-0-31" name="__codelineno-0-31"></a><span class="sd"> Parameters:</span>
</span><span id="__span-0-32"><a id="__codelineno-0-32" name="__codelineno-0-32"></a><span class="sd"> val: The new verbosity value.</span>
</span><span id="__span-0-33"><a id="__codelineno-0-33" name="__codelineno-0-33"></a><span class="sd"> &quot;&quot;&quot;</span>
</span><span id="__span-0-34"><a id="__codelineno-0-34" name="__codelineno-0-34"></a> <span class="n">Printer</span><span class="o">.</span><span class="n">SAWMILL_VERBOSE</span> <span class="o">=</span> <span class="n">val</span>
</span><span id="__span-0-34"><a id="__codelineno-0-34" name="__codelineno-0-34"></a> <span class="n">Printer</span><span class="o">.</span><span class="n">LOGOS_VERBOSE</span> <span class="o">=</span> <span class="n">val</span>
</span><span id="__span-0-35"><a id="__codelineno-0-35" name="__codelineno-0-35"></a>
</span><span id="__span-0-36"><a id="__codelineno-0-36" name="__codelineno-0-36"></a> <span class="nd">@staticmethod</span>
</span><span id="__span-0-37"><a id="__codelineno-0-37" name="__codelineno-0-37"></a> <span class="k">def</span> <span class="nf">set_warnings_to</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
Expand Down Expand Up @@ -1377,7 +1377,7 @@ <h3 id="logos.printer.Printer.printv" class="doc doc-heading">
</span><span id="__span-0-20"><a id="__codelineno-0-20" name="__codelineno-0-20"></a><span class="sd"> Parameters:</span>
</span><span id="__span-0-21"><a id="__codelineno-0-21" name="__codelineno-0-21"></a><span class="sd"> msg: The message to be printed.</span>
</span><span id="__span-0-22"><a id="__codelineno-0-22" name="__codelineno-0-22"></a><span class="sd"> &quot;&quot;&quot;</span>
</span><span id="__span-0-23"><a id="__codelineno-0-23" name="__codelineno-0-23"></a> <span class="k">if</span> <span class="n">Printer</span><span class="o">.</span><span class="n">SAWMILL_VERBOSE</span><span class="p">:</span>
</span><span id="__span-0-23"><a id="__codelineno-0-23" name="__codelineno-0-23"></a> <span class="k">if</span> <span class="n">Printer</span><span class="o">.</span><span class="n">LOGOS_VERBOSE</span><span class="p">:</span>
</span><span id="__span-0-24"><a id="__codelineno-0-24" name="__codelineno-0-24"></a> <span class="nb">print</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
</span></code></pre></div></td></tr></table></div>
</details>
Expand Down Expand Up @@ -1449,7 +1449,7 @@ <h3 id="logos.printer.Printer.set_verbose" class="doc doc-heading">
</span><span id="__span-0-31"><a id="__codelineno-0-31" name="__codelineno-0-31"></a><span class="sd"> Parameters:</span>
</span><span id="__span-0-32"><a id="__codelineno-0-32" name="__codelineno-0-32"></a><span class="sd"> val: The new verbosity value.</span>
</span><span id="__span-0-33"><a id="__codelineno-0-33" name="__codelineno-0-33"></a><span class="sd"> &quot;&quot;&quot;</span>
</span><span id="__span-0-34"><a id="__codelineno-0-34" name="__codelineno-0-34"></a> <span class="n">Printer</span><span class="o">.</span><span class="n">SAWMILL_VERBOSE</span> <span class="o">=</span> <span class="n">val</span>
</span><span id="__span-0-34"><a id="__codelineno-0-34" name="__codelineno-0-34"></a> <span class="n">Printer</span><span class="o">.</span><span class="n">LOGOS_VERBOSE</span> <span class="o">=</span> <span class="n">val</span>
</span></code></pre></div></td></tr></table></div>
</details>
</div>
Expand Down
4 changes: 2 additions & 2 deletions reference/logos/pruner/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1535,7 +1535,7 @@ <h2 id="logos.pruner.Pruner" class="doc doc-heading">
</span><span id="__span-0-147"><a id="__codelineno-0-147" name="__codelineno-0-147"></a> <span class="p">)</span>
</span><span id="__span-0-148"><a id="__codelineno-0-148" name="__codelineno-0-148"></a> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">force</span><span class="p">:</span>
</span><span id="__span-0-149"><a id="__codelineno-0-149" name="__codelineno-0-149"></a> <span class="n">df</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s2">&quot;rb&quot;</span><span class="p">))</span>
</span><span id="__span-0-150"><a id="__codelineno-0-150" name="__codelineno-0-150"></a> <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Found pickled file&quot;</span><span class="p">)</span>
</span><span id="__span-0-150"><a id="__codelineno-0-150" name="__codelineno-0-150"></a> <span class="n">Printer</span><span class="o">.</span><span class="n">printv</span><span class="p">(</span><span class="s2">&quot;Found pickled file&quot;</span><span class="p">)</span>
</span><span id="__span-0-151"><a id="__codelineno-0-151" name="__codelineno-0-151"></a> <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">df</span><span class="o">.</span><span class="n">index</span><span class="p">[:</span><span class="n">top_n</span><span class="p">]</span><span class="o">.</span><span class="n">values</span><span class="p">)</span>
</span><span id="__span-0-152"><a id="__codelineno-0-152" name="__codelineno-0-152"></a>
</span><span id="__span-0-153"><a id="__codelineno-0-153" name="__codelineno-0-153"></a> <span class="n">Printer</span><span class="o">.</span><span class="n">printv</span><span class="p">(</span><span class="s2">&quot;Starting to prune using triangle method&quot;</span><span class="p">)</span>
Expand Down Expand Up @@ -2273,7 +2273,7 @@ <h3 id="logos.pruner.Pruner.prune_with_triangle" class="doc doc-heading">
</span><span id="__span-0-147"><a id="__codelineno-0-147" name="__codelineno-0-147"></a> <span class="p">)</span>
</span><span id="__span-0-148"><a id="__codelineno-0-148" name="__codelineno-0-148"></a> <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">force</span><span class="p">:</span>
</span><span id="__span-0-149"><a id="__codelineno-0-149" name="__codelineno-0-149"></a> <span class="n">df</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s2">&quot;rb&quot;</span><span class="p">))</span>
</span><span id="__span-0-150"><a id="__codelineno-0-150" name="__codelineno-0-150"></a> <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Found pickled file&quot;</span><span class="p">)</span>
</span><span id="__span-0-150"><a id="__codelineno-0-150" name="__codelineno-0-150"></a> <span class="n">Printer</span><span class="o">.</span><span class="n">printv</span><span class="p">(</span><span class="s2">&quot;Found pickled file&quot;</span><span class="p">)</span>
</span><span id="__span-0-151"><a id="__codelineno-0-151" name="__codelineno-0-151"></a> <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">df</span><span class="o">.</span><span class="n">index</span><span class="p">[:</span><span class="n">top_n</span><span class="p">]</span><span class="o">.</span><span class="n">values</span><span class="p">)</span>
</span><span id="__span-0-152"><a id="__codelineno-0-152" name="__codelineno-0-152"></a>
</span><span id="__span-0-153"><a id="__codelineno-0-153" name="__codelineno-0-153"></a> <span class="n">Printer</span><span class="o">.</span><span class="n">printv</span><span class="p">(</span><span class="s2">&quot;Starting to prune using triangle method&quot;</span><span class="p">)</span>
Expand Down
Loading

0 comments on commit 36d0b6a

Please sign in to comment.