docs

Signed-off-by: Xin Wang <[email protected]>

Author: takojunior

docs/_modules/sequential/seq2pat.html

@@ -70,7 +70,7 @@ <h1>Source code for sequential.seq2pat</h1><div class="highlight"><pre>
 <span class="c1"># SPDX-License-Identifier: GPL-2.0</span>
 
 <span class="kn">import</span> <span class="nn">gc</span>
-<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">NamedTuple</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">NoReturn</span><span class="p">,</span> <span class="n">Union</span>
+<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">NamedTuple</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">NoReturn</span><span class="p">,</span> <span class="n">Optional</span>
 
 <span class="kn">from</span> <span class="nn">sequential.backend</span> <span class="kn">import</span> <span class="n">seq_to_pat</span> <span class="k">as</span> <span class="n">stp</span>
 <span class="kn">from</span> <span class="nn">sequential.utils</span> <span class="kn">import</span> <span class="n">Num</span><span class="p">,</span> <span class="n">check_true</span><span class="p">,</span> <span class="n">get_max_column_size</span><span class="p">,</span> \
@@ -345,15 +345,15 @@ <h1>Source code for sequential.seq2pat</h1><div class="highlight"><pre>
 <span class="sd">    sequences : List[list]</span>
 <span class="sd">        A list of sequences each with a list of events.</span>
 <span class="sd">        The event values can be all strings or all integers.</span>
-<span class="sd">    max_span: Union[int, None]</span>
+<span class="sd">    max_span: Optional[int]</span>
 <span class="sd">        The value for applying a built-in maximum span constraint to the length of items in mining, max_span=10 by</span>
 <span class="sd">        default (10 items). This is going to avoid regular users to run into a scaling issue when data contains long</span>
 <span class="sd">        sequences but no constraints are used to run the mining efficiently and practically.</span>
 <span class="sd">        Power users can choose to drop this constraint by setting it to be None or increase the maximum span</span>
 <span class="sd">        as the system has resources to support.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
-    <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">sequences</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">list</span><span class="p">],</span> <span class="n">max_span</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="mi">10</span><span class="p">):</span>
+    <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">sequences</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">list</span><span class="p">],</span> <span class="n">max_span</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="mi">10</span><span class="p">):</span>
         <span class="c1"># Validate input</span>
         <span class="n">validate_sequences</span><span class="p">(</span><span class="n">sequences</span><span class="p">)</span>
         <span class="n">validate_max_span</span><span class="p">(</span><span class="n">max_span</span><span class="p">)</span>

docs/api.html

@@ -119,7 +119,7 @@
 <dt>sequences<span class="classifier">List[list]</span></dt><dd><p>A list of sequences each with a list of events.
 The event values can be all strings or all integers.</p>
 </dd>
-<dt>max_span: Union[int, None]</dt><dd><p>The value for applying a built-in maximum span constraint to the length of items in mining, max_span=10 by
+<dt>max_span: Optional[int]</dt><dd><p>The value for applying a built-in maximum span constraint to the length of items in mining, max_span=10 by
 default (10 items). This is going to avoid regular users to run into a scaling issue when data contains long
 sequences but no constraints are used to run the mining efficiently and practically.
 Power users can choose to drop this constraint by setting it to be None or increase the maximum span