Updating documentation

Signed-off-by: Julio Faracco <[email protected]>
discovery-unicamp · Sep 29, 2024 · d3a81df · d3a81df
1 parent 52f1e2d
commit d3a81df
Show file tree

Hide file tree

Showing 195 changed files with 8,264 additions and 1,197 deletions.
diff --git a/docs/.doctrees/autoapi/dasf/datasets/base/index.doctree b/docs/.doctrees/autoapi/dasf/datasets/base/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/datasets/download/index.doctree b/docs/.doctrees/autoapi/dasf/datasets/download/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/datasets/index.doctree b/docs/.doctrees/autoapi/dasf/datasets/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/debug/debug/index.doctree b/docs/.doctrees/autoapi/dasf/debug/debug/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/debug/index.doctree b/docs/.doctrees/autoapi/dasf/debug/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/feature_extraction/histogram/index.doctree b/docs/.doctrees/autoapi/dasf/feature_extraction/histogram/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/feature_extraction/index.doctree b/docs/.doctrees/autoapi/dasf/feature_extraction/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/index.doctree b/docs/.doctrees/autoapi/dasf/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/cluster/agglomerative/index.doctree b/docs/.doctrees/autoapi/dasf/ml/cluster/agglomerative/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/cluster/dbscan/index.doctree b/docs/.doctrees/autoapi/dasf/ml/cluster/dbscan/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/cluster/hdbscan/index.doctree b/docs/.doctrees/autoapi/dasf/ml/cluster/hdbscan/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/cluster/index.doctree b/docs/.doctrees/autoapi/dasf/ml/cluster/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/cluster/kmeans/index.doctree b/docs/.doctrees/autoapi/dasf/ml/cluster/kmeans/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/cluster/som/index.doctree b/docs/.doctrees/autoapi/dasf/ml/cluster/som/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/cluster/spectral/index.doctree b/docs/.doctrees/autoapi/dasf/ml/cluster/spectral/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/decomposition/index.doctree b/docs/.doctrees/autoapi/dasf/ml/decomposition/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/decomposition/pca/index.doctree b/docs/.doctrees/autoapi/dasf/ml/decomposition/pca/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/dl/clusters/dask/index.doctree b/docs/.doctrees/autoapi/dasf/ml/dl/clusters/dask/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/dl/clusters/index.doctree b/docs/.doctrees/autoapi/dasf/ml/dl/clusters/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/dl/index.doctree b/docs/.doctrees/autoapi/dasf/ml/dl/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/dl/lightning_fit/index.doctree b/docs/.doctrees/autoapi/dasf/ml/dl/lightning_fit/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/dl/models/devconvnet/index.doctree b/docs/.doctrees/autoapi/dasf/ml/dl/models/devconvnet/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/dl/models/index.doctree b/docs/.doctrees/autoapi/dasf/ml/dl/models/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/dl/pytorch_lightning/index.doctree b/docs/.doctrees/autoapi/dasf/ml/dl/pytorch_lightning/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/inference/loader/base/index.doctree b/docs/.doctrees/autoapi/dasf/ml/inference/loader/base/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/inference/loader/torch/index.doctree b/docs/.doctrees/autoapi/dasf/ml/inference/loader/torch/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/mixture/gmm/index.doctree b/docs/.doctrees/autoapi/dasf/ml/mixture/gmm/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/model_selection/split/index.doctree b/docs/.doctrees/autoapi/dasf/ml/model_selection/split/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/neighbors/index.doctree b/docs/.doctrees/autoapi/dasf/ml/neighbors/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/neighbors/neighbors/index.doctree b/docs/.doctrees/autoapi/dasf/ml/neighbors/neighbors/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/preprocessing/index.doctree b/docs/.doctrees/autoapi/dasf/ml/preprocessing/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/preprocessing/standardscaler/index.doctree b/docs/.doctrees/autoapi/dasf/ml/preprocessing/standardscaler/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/svm/index.doctree b/docs/.doctrees/autoapi/dasf/ml/svm/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/svm/svm/index.doctree b/docs/.doctrees/autoapi/dasf/ml/svm/svm/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/xgboost/index.doctree b/docs/.doctrees/autoapi/dasf/ml/xgboost/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/ml/xgboost/xgboost/index.doctree b/docs/.doctrees/autoapi/dasf/ml/xgboost/xgboost/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/pipeline/executors/dask/index.doctree b/docs/.doctrees/autoapi/dasf/pipeline/executors/dask/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/pipeline/executors/index.doctree b/docs/.doctrees/autoapi/dasf/pipeline/executors/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/pipeline/executors/ray/index.doctree b/docs/.doctrees/autoapi/dasf/pipeline/executors/ray/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/pipeline/executors/wrapper/index.doctree b/docs/.doctrees/autoapi/dasf/pipeline/executors/wrapper/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/pipeline/index.doctree b/docs/.doctrees/autoapi/dasf/pipeline/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/pipeline/pipeline/index.doctree b/docs/.doctrees/autoapi/dasf/pipeline/pipeline/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/profile/analysis/index.doctree b/docs/.doctrees/autoapi/dasf/profile/analysis/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/profile/index.doctree b/docs/.doctrees/autoapi/dasf/profile/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/profile/plugins/index.doctree b/docs/.doctrees/autoapi/dasf/profile/plugins/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/profile/profiler/index.doctree b/docs/.doctrees/autoapi/dasf/profile/profiler/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/profile/utils/index.doctree b/docs/.doctrees/autoapi/dasf/profile/utils/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/transforms/base/index.doctree b/docs/.doctrees/autoapi/dasf/transforms/base/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/transforms/index.doctree b/docs/.doctrees/autoapi/dasf/transforms/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/transforms/memory/index.doctree b/docs/.doctrees/autoapi/dasf/transforms/memory/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/transforms/operations/index.doctree b/docs/.doctrees/autoapi/dasf/transforms/operations/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/transforms/transforms/index.doctree b/docs/.doctrees/autoapi/dasf/transforms/transforms/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/utils/benchmark/index.doctree b/docs/.doctrees/autoapi/dasf/utils/benchmark/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/utils/funcs/index.doctree b/docs/.doctrees/autoapi/dasf/utils/funcs/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/utils/index.doctree b/docs/.doctrees/autoapi/dasf/utils/index.doctree
diff --git a/docs/.doctrees/autoapi/dasf/utils/labels/index.doctree b/docs/.doctrees/autoapi/dasf/utils/labels/index.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/_modules/dasf/datasets/base.html b/docs/_modules/dasf/datasets/base.html
diff --git a/docs/_modules/dasf/datasets/datasets.html b/docs/_modules/dasf/datasets/datasets.html
@@ -90,7 +90,7 @@ <h1>Source code for dasf.datasets.datasets</h1><div class="highlight"><pre>
     <span class="kn">import</span> <span class="nn">cupy</span> <span class="k">as</span> <span class="nn">cp</span>
     <span class="kn">from</span> <span class="nn">cuml.dask.datasets</span> <span class="kn">import</span> <span class="n">make_blobs</span> <span class="k">as</span> <span class="n">make_blobs_MGPU</span>
     <span class="kn">from</span> <span class="nn">cuml.datasets</span> <span class="kn">import</span> <span class="n">make_blobs</span> <span class="k">as</span> <span class="n">make_blobs_GPU</span>
-<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> <span class="c1"># pragma: no cover</span>
+<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>  <span class="c1"># pragma: no cover</span>
     <span class="k">pass</span>
 
 <span class="kn">from</span> <span class="nn">dask_ml.datasets</span> <span class="kn">import</span> <span class="n">make_classification</span> <span class="k">as</span> <span class="n">make_classification_MCPU</span>
@@ -99,7 +99,7 @@ <h1>Source code for dasf.datasets.datasets</h1><div class="highlight"><pre>
 <span class="k">try</span><span class="p">:</span>
     <span class="kn">from</span> <span class="nn">cuml.dask.datasets</span> <span class="kn">import</span> <span class="n">make_classification</span> <span class="k">as</span> <span class="n">make_classification_MGPU</span>
     <span class="kn">from</span> <span class="nn">cuml.datasets</span> <span class="kn">import</span> <span class="n">make_classification</span> <span class="k">as</span> <span class="n">make_classification_GPU</span>
-<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> <span class="c1"># pragma: no cover</span>
+<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>  <span class="c1"># pragma: no cover</span>
     <span class="k">pass</span>
 
 <span class="kn">from</span> <span class="nn">dask_ml.datasets</span> <span class="kn">import</span> <span class="n">make_regression</span> <span class="k">as</span> <span class="n">make_regression_MCPU</span>
@@ -108,7 +108,7 @@ <h1>Source code for dasf.datasets.datasets</h1><div class="highlight"><pre>
 <span class="k">try</span><span class="p">:</span>
     <span class="kn">from</span> <span class="nn">cuml.dask.datasets</span> <span class="kn">import</span> <span class="n">make_regression</span> <span class="k">as</span> <span class="n">make_regression_MGPU</span>
     <span class="kn">from</span> <span class="nn">cuml.datasets</span> <span class="kn">import</span> <span class="n">make_regression</span> <span class="k">as</span> <span class="n">make_regression_GPU</span>
-<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> <span class="c1"># pragma: no cover</span>
+<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>  <span class="c1"># pragma: no cover</span>
     <span class="k">pass</span>
 
 <span class="kn">from</span> <span class="nn">dasf.utils.funcs</span> <span class="kn">import</span> <span class="n">is_dask_gpu_supported</span><span class="p">,</span> <span class="n">is_dask_supported</span><span class="p">,</span> <span class="n">is_gpu_supported</span>

diff --git a/docs/_modules/dasf/feature_extraction/histogram.html b/docs/_modules/dasf/feature_extraction/histogram.html
@@ -79,15 +79,15 @@
            <div itemprop="articleBody">
 
   <h1>Source code for dasf.feature_extraction.histogram</h1><div class="highlight"><pre>
-<span></span><span class="sd">&quot;&quot;&quot; Histogram module. &quot;&quot;&quot;</span>
-<span class="c1">#!/usr/bin/env python3</span>
+<span></span><span class="ch">#!/usr/bin/env python3</span>
+<span class="sd">&quot;&quot;&quot; Histogram module. &quot;&quot;&quot;</span>
 
 <span class="kn">import</span> <span class="nn">dask.array</span> <span class="k">as</span> <span class="nn">da</span>
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
 
 <span class="k">try</span><span class="p">:</span>
     <span class="kn">import</span> <span class="nn">cupy</span> <span class="k">as</span> <span class="nn">cp</span>
-<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> <span class="c1"># pragma: no cover</span>
+<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>  <span class="c1"># pragma: no cover</span>
     <span class="k">pass</span>
 
 <span class="kn">from</span> <span class="nn">dasf.transforms.base</span> <span class="kn">import</span> <span class="n">TargeteredTransform</span><span class="p">,</span> <span class="n">Transform</span>
@@ -143,7 +143,9 @@ <h1>Source code for dasf.feature_extraction.histogram</h1><div class="highlight"
         <span class="bp">self</span><span class="o">.</span><span class="n">_weights</span> <span class="o">=</span> <span class="n">weights</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_density</span> <span class="o">=</span> <span class="n">density</span>
 
-    <span class="k">def</span> <span class="nf">__lazy_transform_generic</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">):</span>
+<div class="viewcode-block" id="Histogram._lazy_transform_generic">
+<a class="viewcode-back" href="../../../autoapi/dasf/feature_extraction/index.html#dasf.feature_extraction.histogram.Histogram._lazy_transform_generic">[docs]</a>
+    <span class="k">def</span> <span class="nf">_lazy_transform_generic</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Compute the histogram of a dataset using Dask.</span>
 
@@ -161,16 +163,22 @@ <h1>Source code for dasf.feature_extraction.histogram</h1><div class="highlight"
 <span class="sd">        bin_edges : array of dtype float</span>
 <span class="sd">            Return the bin edges ``(length(hist)+1)``.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Argument `range` cannot be None for Dask based methods.&quot;</span><span class="p">)</span>
+
         <span class="k">return</span> <span class="n">da</span><span class="o">.</span><span class="n">histogram</span><span class="p">(</span>
             <span class="n">X</span><span class="p">,</span>
             <span class="n">bins</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_bins</span><span class="p">,</span>
             <span class="nb">range</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="p">,</span>
             <span class="n">normed</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_normed</span><span class="p">,</span>
             <span class="n">weights</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_weights</span><span class="p">,</span>
             <span class="n">density</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_density</span><span class="p">,</span>
-        <span class="p">)</span>
+        <span class="p">)</span></div>
+
 
-    <span class="k">def</span> <span class="nf">__transform_generic</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">,</span> <span class="n">xp</span><span class="p">):</span>
+<div class="viewcode-block" id="Histogram._transform_generic">
+<a class="viewcode-back" href="../../../autoapi/dasf/feature_extraction/index.html#dasf.feature_extraction.histogram.Histogram._transform_generic">[docs]</a>
+    <span class="k">def</span> <span class="nf">_transform_generic</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">X</span><span class="p">,</span> <span class="n">xp</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Compute the histogram of a dataset using local libraries.</span>
 
@@ -188,14 +196,19 @@ <h1>Source code for dasf.feature_extraction.histogram</h1><div class="highlight"
 <span class="sd">        bin_edges : array of dtype float</span>
 <span class="sd">            Return the bin edges ``(length(hist)+1)``.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">kwargs</span> <span class="o">=</span> <span class="p">{}</span>
+        <span class="k">if</span> <span class="n">xp</span> <span class="o">==</span> <span class="n">np</span><span class="p">:</span>
+            <span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;normed&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_normed</span>
+
         <span class="k">return</span> <span class="n">xp</span><span class="o">.</span><span class="n">histogram</span><span class="p">(</span>
             <span class="n">X</span><span class="p">,</span>
             <span class="n">bins</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_bins</span><span class="p">,</span>
             <span class="nb">range</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_range</span><span class="p">,</span>
-            <span class="n">normed</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_normed</span><span class="p">,</span>
             <span class="n">weights</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_weights</span><span class="p">,</span>
             <span class="n">density</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_density</span><span class="p">,</span>
-        <span class="p">)</span>
+            <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
+        <span class="p">)</span></div>
+
 
 <div class="viewcode-block" id="Histogram._lazy_transform_cpu">
 <a class="viewcode-back" href="../../../autoapi/dasf/feature_extraction/index.html#dasf.feature_extraction.histogram.Histogram._lazy_transform_cpu">[docs]</a>
@@ -217,7 +230,7 @@ <h1>Source code for dasf.feature_extraction.histogram</h1><div class="highlight"
 <span class="sd">        bin_edges : array of dtype float</span>
 <span class="sd">            Return the bin edges ``(length(hist)+1)``.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__lazy_transform_generic</span><span class="p">(</span><span class="n">X</span><span class="p">)</span></div>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lazy_transform_generic</span><span class="p">(</span><span class="n">X</span><span class="p">)</span></div>
 
 
 <div class="viewcode-block" id="Histogram._lazy_transform_gpu">
@@ -240,7 +253,7 @@ <h1>Source code for dasf.feature_extraction.histogram</h1><div class="highlight"
 <span class="sd">        bin_edges : array of dtype float</span>
 <span class="sd">            Return the bin edges ``(length(hist)+1)``.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__lazy_transform_generic</span><span class="p">(</span><span class="n">X</span><span class="p">)</span></div>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lazy_transform_generic</span><span class="p">(</span><span class="n">X</span><span class="p">)</span></div>
 
 
 <div class="viewcode-block" id="Histogram._transform_cpu">
@@ -263,7 +276,7 @@ <h1>Source code for dasf.feature_extraction.histogram</h1><div class="highlight"
 <span class="sd">        bin_edges : array of dtype float</span>
 <span class="sd">            Return the bin edges ``(length(hist)+1)``.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__transform_generic</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">np</span><span class="p">)</span></div>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transform_generic</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">np</span><span class="p">)</span></div>
 
 
 <div class="viewcode-block" id="Histogram._transform_gpu">
@@ -286,7 +299,7 @@ <h1>Source code for dasf.feature_extraction.histogram</h1><div class="highlight"
 <span class="sd">        bin_edges : array of dtype float</span>
 <span class="sd">            Return the bin edges ``(length(hist)+1)``.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__transform_generic</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">cp</span><span class="p">)</span></div>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_transform_generic</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">cp</span><span class="p">)</span></div>
 </div>
 
 </pre></div>