Skip to content

Commit

Permalink
[AUTOGEN] Render the updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Francisco Moraleda committed Dec 4, 2024
1 parent a8cfb8a commit 1dc807b
Show file tree
Hide file tree
Showing 6 changed files with 143 additions and 110 deletions.
Binary file added site/images/mercury_graph.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 25 additions & 24 deletions site/reference/embeddings/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1451,6 +1451,7 @@ <h2 id="mercury.graph.embeddings.GraphEmbedding" class="doc doc-heading">


<p>Create an embedding mapping the nodes of a graph.</p>
<p>Includes contributions by David Muelas Recuenco.</p>


<p><span class="doc-section-title">Parameters:</span></p>
Expand Down Expand Up @@ -1576,9 +1577,7 @@ <h2 id="mercury.graph.embeddings.GraphEmbedding" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>mercury/graph/embeddings/graphembeddings.py</code></summary>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 88</span>
<span class="normal"> 89</span>
<span class="normal"> 90</span>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 90</span>
<span class="normal"> 91</span>
<span class="normal"> 92</span>
<span class="normal"> 93</span>
Expand All @@ -1600,7 +1599,9 @@ <h2 id="mercury.graph.embeddings.GraphEmbedding" class="doc doc-heading">
<span class="normal">109</span>
<span class="normal">110</span>
<span class="normal">111</span>
<span class="normal">112</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="normal">112</span>
<span class="normal">113</span>
<span class="normal">114</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">dimension</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">n_jumps</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
Expand Down Expand Up @@ -1709,9 +1710,7 @@ <h3 id="mercury.graph.embeddings.GraphEmbedding.__getitem__" class="doc doc-head

<details class="quote">
<summary>Source code in <code>mercury/graph/embeddings/graphembeddings.py</code></summary>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">114</span>
<span class="normal">115</span>
<span class="normal">116</span>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">116</span>
<span class="normal">117</span>
<span class="normal">118</span>
<span class="normal">119</span>
Expand All @@ -1720,7 +1719,9 @@ <h3 id="mercury.graph.embeddings.GraphEmbedding.__getitem__" class="doc doc-head
<span class="normal">122</span>
<span class="normal">123</span>
<span class="normal">124</span>
<span class="normal">125</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">arg</span><span class="p">):</span>
<span class="normal">125</span>
<span class="normal">126</span>
<span class="normal">127</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">arg</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Method to access rows in the embedding by ID.</span>

Expand Down Expand Up @@ -1776,17 +1777,17 @@ <h3 id="mercury.graph.embeddings.GraphEmbedding.embedding" class="doc doc-headin

<details class="quote">
<summary>Source code in <code>mercury/graph/embeddings/graphembeddings.py</code></summary>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">203</span>
<span class="normal">204</span>
<span class="normal">205</span>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">205</span>
<span class="normal">206</span>
<span class="normal">207</span>
<span class="normal">208</span>
<span class="normal">209</span>
<span class="normal">210</span>
<span class="normal">211</span>
<span class="normal">212</span>
<span class="normal">213</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">embedding</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="normal">213</span>
<span class="normal">214</span>
<span class="normal">215</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">embedding</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Return the internal Embeddings object.</span>

Expand Down Expand Up @@ -1879,9 +1880,7 @@ <h3 id="mercury.graph.embeddings.GraphEmbedding.fit" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>mercury/graph/embeddings/graphembeddings.py</code></summary>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">127</span>
<span class="normal">128</span>
<span class="normal">129</span>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">129</span>
<span class="normal">130</span>
<span class="normal">131</span>
<span class="normal">132</span>
Expand Down Expand Up @@ -1953,7 +1952,9 @@ <h3 id="mercury.graph.embeddings.GraphEmbedding.fit" class="doc doc-heading">
<span class="normal">198</span>
<span class="normal">199</span>
<span class="normal">200</span>
<span class="normal">201</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">fit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">g</span><span class="p">:</span> <span class="n">Graph</span><span class="p">):</span>
<span class="normal">201</span>
<span class="normal">202</span>
<span class="normal">203</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">fit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">g</span><span class="p">:</span> <span class="n">Graph</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Train the embedding by doing random walks.</span>

Expand Down Expand Up @@ -2161,9 +2162,7 @@ <h3 id="mercury.graph.embeddings.GraphEmbedding.get_most_similar_nodes" class="d

<details class="quote">
<summary>Source code in <code>mercury/graph/embeddings/graphembeddings.py</code></summary>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">215</span>
<span class="normal">216</span>
<span class="normal">217</span>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">217</span>
<span class="normal">218</span>
<span class="normal">219</span>
<span class="normal">220</span>
Expand All @@ -2188,7 +2187,9 @@ <h3 id="mercury.graph.embeddings.GraphEmbedding.get_most_similar_nodes" class="d
<span class="normal">239</span>
<span class="normal">240</span>
<span class="normal">241</span>
<span class="normal">242</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">get_most_similar_nodes</span><span class="p">(</span>
<span class="normal">242</span>
<span class="normal">243</span>
<span class="normal">244</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">get_most_similar_nodes</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">node_id</span><span class="p">,</span> <span class="n">k</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">metric</span><span class="o">=</span><span class="s2">&quot;cosine&quot;</span><span class="p">,</span> <span class="n">return_as_indices</span><span class="o">=</span><span class="kc">False</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
Expand Down Expand Up @@ -2287,9 +2288,7 @@ <h3 id="mercury.graph.embeddings.GraphEmbedding.save" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>mercury/graph/embeddings/graphembeddings.py</code></summary>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">244</span>
<span class="normal">245</span>
<span class="normal">246</span>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">246</span>
<span class="normal">247</span>
<span class="normal">248</span>
<span class="normal">249</span>
Expand All @@ -2316,7 +2315,9 @@ <h3 id="mercury.graph.embeddings.GraphEmbedding.save" class="doc doc-heading">
<span class="normal">270</span>
<span class="normal">271</span>
<span class="normal">272</span>
<span class="normal">273</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_name</span><span class="p">,</span> <span class="n">save_embedding</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="normal">273</span>
<span class="normal">274</span>
<span class="normal">275</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_name</span><span class="p">,</span> <span class="n">save_embedding</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Saves a GraphEmbedding to a compressed binary file with or without the embedding itself. It saves the graph&#39;s node names</span>
<span class="sd"> and the adjacency matrix as a sparse matrix.</span>
Expand Down
39 changes: 21 additions & 18 deletions site/reference/ml/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -774,6 +774,8 @@ <h2 id="mercury.graph.ml.LouvainCommunities" class="doc doc-heading">
all nodes are reassigned at the same time and conflicts (i.e., 1 -&gt; C2 and
2 -&gt; C1) are resolved with a simple tie-breaking rule. This version also
introduces the resolution parameter <em>gamma</em>, as in <sup id="mercury.graph.ml.LouvainCommunities--fnref:2"><a class="footnote-ref" href="#mercury.graph.ml.LouvainCommunities--fn:2">2</a></sup>.</p>
<p>Contributed by Arturo Soberon Cedillo, Jose Antonio Guzman Vazquez and
Isaac Dodanim Hernandez Garcia.</p>
<div class="footnote">
<hr />
<ol>
Expand Down Expand Up @@ -916,10 +918,7 @@ <h2 id="mercury.graph.ml.LouvainCommunities" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>mercury/graph/ml/louvain.py</code></summary>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">67</span>
<span class="normal">68</span>
<span class="normal">69</span>
<span class="normal">70</span>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">70</span>
<span class="normal">71</span>
<span class="normal">72</span>
<span class="normal">73</span>
Expand All @@ -935,7 +934,10 @@ <h2 id="mercury.graph.ml.LouvainCommunities" class="doc doc-heading">
<span class="normal">83</span>
<span class="normal">84</span>
<span class="normal">85</span>
<span class="normal">86</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="normal">86</span>
<span class="normal">87</span>
<span class="normal">88</span>
<span class="normal">89</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">min_modularity_gain</span><span class="o">=</span><span class="mf">1e-03</span><span class="p">,</span>
<span class="n">max_pass</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span>
Expand Down Expand Up @@ -1038,10 +1040,7 @@ <h3 id="mercury.graph.ml.LouvainCommunities.fit" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>mercury/graph/ml/louvain.py</code></summary>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">102</span>
<span class="normal">103</span>
<span class="normal">104</span>
<span class="normal">105</span>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">105</span>
<span class="normal">106</span>
<span class="normal">107</span>
<span class="normal">108</span>
Expand Down Expand Up @@ -1157,7 +1156,10 @@ <h3 id="mercury.graph.ml.LouvainCommunities.fit" class="doc doc-heading">
<span class="normal">218</span>
<span class="normal">219</span>
<span class="normal">220</span>
<span class="normal">221</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">fit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">g</span><span class="p">:</span> <span class="n">Graph</span><span class="p">):</span>
<span class="normal">221</span>
<span class="normal">222</span>
<span class="normal">223</span>
<span class="normal">224</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">fit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">g</span><span class="p">:</span> <span class="n">Graph</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Args:</span>
<span class="sd"> g (Graph): A mercury graph structure.</span>
Expand Down Expand Up @@ -1940,6 +1942,7 @@ <h2 id="mercury.graph.ml.SpectralClustering" class="doc doc-heading">


<p>Implementation of the spectral clustering algorithm which detect communities inside a graph.</p>
<p>Contributed by Gibran Gabriel Otazo Sanchez.</p>


<p><span class="doc-section-title">Parameters:</span></p>
Expand Down Expand Up @@ -2028,16 +2031,16 @@ <h2 id="mercury.graph.ml.SpectralClustering" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>mercury/graph/ml/spectral.py</code></summary>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">24</span>
<span class="normal">25</span>
<span class="normal">26</span>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">26</span>
<span class="normal">27</span>
<span class="normal">28</span>
<span class="normal">29</span>
<span class="normal">30</span>
<span class="normal">31</span>
<span class="normal">32</span>
<span class="normal">33</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="normal">33</span>
<span class="normal">34</span>
<span class="normal">35</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">n_clusters</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s2">&quot;networkx&quot;</span><span class="p">,</span> <span class="n">max_iterations</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">random_state</span><span class="o">=</span><span class="mi">0</span>
<span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">n_clusters</span> <span class="o">=</span> <span class="n">n_clusters</span>
Expand Down Expand Up @@ -2132,9 +2135,7 @@ <h3 id="mercury.graph.ml.SpectralClustering.fit" class="doc doc-heading">

<details class="quote">
<summary>Source code in <code>mercury/graph/ml/spectral.py</code></summary>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">49</span>
<span class="normal">50</span>
<span class="normal">51</span>
<div class="codehilite"><table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">51</span>
<span class="normal">52</span>
<span class="normal">53</span>
<span class="normal">54</span>
Expand All @@ -2149,7 +2150,9 @@ <h3 id="mercury.graph.ml.SpectralClustering.fit" class="doc doc-heading">
<span class="normal">63</span>
<span class="normal">64</span>
<span class="normal">65</span>
<span class="normal">66</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">fit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">graph</span><span class="p">:</span> <span class="n">Graph</span><span class="p">):</span>
<span class="normal">66</span>
<span class="normal">67</span>
<span class="normal">68</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">fit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">graph</span><span class="p">:</span> <span class="n">Graph</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Find the optimal clusters of a given graph. The function returns nothing, but saves the clusters and</span>
<span class="sd"> the modularity in the object self.</span>
Expand Down
Loading

0 comments on commit 1dc807b

Please sign in to comment.