PySATL · Kirill-maker · Jun 12, 2025 · Jun 12, 2025 · Jun 25, 2025 · Jun 25, 2025
diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml
@@ -23,4 +23,4 @@ jobs:
       - name: "Mypy"
         run: mypy
       - name: "Pytest"
-        run: python -m pytest -v -m ci
+        run: PYTHONPATH=src python -m pytest -v -m ci
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree
diff --git a/docs/build/doctrees/src.algorithms.doctree b/docs/build/doctrees/src.algorithms.doctree
diff --git a/docs/build/doctrees/src.algorithms.param_algorithms.doctree b/docs/build/doctrees/src.algorithms.param_algorithms.doctree
diff --git a/docs/build/doctrees/src.algorithms.param_algorithms.nm_param_algorithms.doctree b/docs/build/doctrees/src.algorithms.param_algorithms.nm_param_algorithms.doctree
diff --git a/docs/build/doctrees/src.algorithms.param_algorithms.nv_param_algorithms.doctree b/docs/build/doctrees/src.algorithms.param_algorithms.nv_param_algorithms.doctree
diff --git a/docs/build/doctrees/src.algorithms.param_algorithms.nvm_param_algorithms.doctree b/docs/build/doctrees/src.algorithms.param_algorithms.nvm_param_algorithms.doctree
diff --git a/docs/build/doctrees/src.algorithms.semiparam_algorithms.doctree b/docs/build/doctrees/src.algorithms.semiparam_algorithms.doctree
diff --git a/docs/build/doctrees/src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.doctree b/docs/build/doctrees/src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.doctree
diff --git a/docs/build/doctrees/src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.doctree b/docs/build/doctrees/src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.doctree
diff --git a/docs/build/doctrees/src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.doctree b/docs/build/doctrees/src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.doctree
diff --git a/docs/build/doctrees/src.doctree b/docs/build/doctrees/src.doctree
diff --git a/docs/build/doctrees/src.estimators.doctree b/docs/build/doctrees/src.estimators.doctree
diff --git a/docs/build/doctrees/src.estimators.parametric.doctree b/docs/build/doctrees/src.estimators.parametric.doctree
diff --git a/docs/build/doctrees/src.estimators.semiparametric.doctree b/docs/build/doctrees/src.estimators.semiparametric.doctree
diff --git a/docs/build/doctrees/src.generators.doctree b/docs/build/doctrees/src.generators.doctree
diff --git a/docs/build/doctrees/src.mixtures.doctree b/docs/build/doctrees/src.mixtures.doctree
diff --git a/docs/build/doctrees/src.register.doctree b/docs/build/doctrees/src.register.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 70a6495f3e4db176140ed488f4751adc
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/.buildinfo.bak b/docs/build/html/.buildinfo.bak
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b9b03528914d37e51042eacc9f42bead
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/.doctrees/environment.pickle b/docs/build/html/.doctrees/environment.pickle
diff --git a/docs/build/html/.doctrees/index.doctree b/docs/build/html/.doctrees/index.doctree
diff --git a/docs/build/html/.doctrees/modules.doctree b/docs/build/html/.doctrees/modules.doctree
diff --git a/docs/build/html/.doctrees/src.algorithms.doctree b/docs/build/html/.doctrees/src.algorithms.doctree
diff --git a/docs/build/html/.doctrees/src.algorithms.param_algorithms.doctree b/docs/build/html/.doctrees/src.algorithms.param_algorithms.doctree
diff --git a/docs/build/html/.doctrees/src.algorithms.param_algorithms.nm_param_algorithms.doctree b/docs/build/html/.doctrees/src.algorithms.param_algorithms.nm_param_algorithms.doctree
diff --git a/docs/build/html/.doctrees/src.algorithms.param_algorithms.nv_param_algorithms.doctree b/docs/build/html/.doctrees/src.algorithms.param_algorithms.nv_param_algorithms.doctree
diff --git a/docs/build/html/.doctrees/src.algorithms.param_algorithms.nvm_param_algorithms.doctree b/docs/build/html/.doctrees/src.algorithms.param_algorithms.nvm_param_algorithms.doctree
diff --git a/docs/build/html/.doctrees/src.algorithms.semiparam_algorithms.doctree b/docs/build/html/.doctrees/src.algorithms.semiparam_algorithms.doctree
diff --git a/...build/html/.doctrees/src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.doctree b/...build/html/.doctrees/src.algorithms.semiparam_algorithms.nm_semi_param_algorithms.doctree
diff --git a/...build/html/.doctrees/src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.doctree b/...build/html/.doctrees/src.algorithms.semiparam_algorithms.nv_semi_param_algorithms.doctree
diff --git a/...uild/html/.doctrees/src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.doctree b/...uild/html/.doctrees/src.algorithms.semiparam_algorithms.nvm_semi_param_algorithms.doctree
diff --git a/docs/build/html/.doctrees/src.doctree b/docs/build/html/.doctrees/src.doctree
diff --git a/docs/build/html/.doctrees/src.estimators.doctree b/docs/build/html/.doctrees/src.estimators.doctree
diff --git a/docs/build/html/.doctrees/src.estimators.parametric.doctree b/docs/build/html/.doctrees/src.estimators.parametric.doctree
diff --git a/docs/build/html/.doctrees/src.estimators.semiparametric.doctree b/docs/build/html/.doctrees/src.estimators.semiparametric.doctree
diff --git a/docs/build/html/.doctrees/src.generators.doctree b/docs/build/html/.doctrees/src.generators.doctree
diff --git a/docs/build/html/.doctrees/src.mixtures.doctree b/docs/build/html/.doctrees/src.mixtures.doctree
diff --git a/docs/build/html/.doctrees/src.register.doctree b/docs/build/html/.doctrees/src.register.doctree
diff --git a/docs/build/html/_modules/estimators/abstract_estimator.html b/docs/build/html/_modules/estimators/abstract_estimator.html
@@ -0,0 +1,202 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>estimators.abstract_estimator &mdash; ka 0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
+      <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
+
+
+      <script src="../../_static/jquery.js?v=5d32c60e"></script>
+      <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="../../_static/documentation_options.js?v=8dde47fa"></script>
+      <script src="../../_static/doctools.js?v=9bcbadda"></script>
+      <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../genindex.html" />
+    <link rel="search" title="Search" href="../../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../../index.html" class="icon icon-home">
+            ka
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../modules.html">src</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../src.html">src package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../src.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../../src.algorithms.html">algorithms package</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../src.estimators.html">estimators package</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../src.generators.html">generators package</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../src.mixtures.html">mixtures package</a></li>
+<li class="toctree-l4"><a class="reference internal" href="../../src.register.html">register package</a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="../../src.html#module-contents">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../index.html">ka</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">estimators.abstract_estimator</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>Source code for estimators.abstract_estimator</h1><div class="highlight"><pre>
+<span></span><span class="sd">&quot;&quot;&quot;Abstract estimator base class module.</span>
+
+<span class="sd">This module defines the AbstractEstimator base class that provides</span>
+<span class="sd">common functionality for all parametric and semiparametric estimators.</span>
+<span class="sd">&quot;&quot;&quot;</span>
+
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Self</span>
+
+<span class="kn">from</span><span class="w"> </span><span class="nn">numpy</span><span class="w"> </span><span class="kn">import</span> <span class="n">_typing</span>
+
+<span class="kn">from</span><span class="w"> </span><span class="nn">algorithms</span><span class="w"> </span><span class="kn">import</span> <span class="n">ALGORITHM_REGISTRY</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">estimators.estimate_result</span><span class="w"> </span><span class="kn">import</span> <span class="n">EstimateResult</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">register.algorithm_purpose</span><span class="w"> </span><span class="kn">import</span> <span class="n">AlgorithmPurpose</span>
+
+
+<div class="viewcode-block" id="AbstractEstimator">
+<a class="viewcode-back" href="../../src.estimators.html#estimators.abstract_estimator.AbstractEstimator">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">AbstractEstimator</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Base class for Estimators</span>
+
+<span class="sd">    Attributes:</span>
+<span class="sd">        algorithm_name: A string indicating chosen algorithm.</span>
+<span class="sd">        params: A dictionary of algorithm parameters.</span>
+<span class="sd">        estimate_result: Estimation result.</span>
+<span class="sd">        _registry: Registry that contains classes of all algorithms.</span>
+<span class="sd">        _purpose: Defines purpose of algorithm, one of the registry key.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">algorithm_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">params</span><span class="p">:</span> <span class="nb">dict</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Initializes the instance based on algorithm name and params.</span>
+
+<span class="sd">        Args:</span>
+<span class="sd">            algorithm_name: A string indicating chosen algorithm.</span>
+<span class="sd">            params: A dictionary of algorithm parameters.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">algorithm_name</span> <span class="o">=</span> <span class="n">algorithm_name</span>
+        <span class="k">if</span> <span class="n">params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="n">params</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">estimate_result</span> <span class="o">=</span> <span class="n">EstimateResult</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_registry</span> <span class="o">=</span> <span class="n">ALGORITHM_REGISTRY</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_purpose</span> <span class="o">=</span> <span class="n">AlgorithmPurpose</span><span class="o">.</span><span class="n">DEFAULT</span>
+
+<div class="viewcode-block" id="AbstractEstimator.get_params">
+<a class="viewcode-back" href="../../src.estimators.html#estimators.abstract_estimator.AbstractEstimator.get_params">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_params</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
+        <span class="k">return</span> <span class="p">{</span><span class="s2">&quot;algorithm_name&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">algorithm_name</span><span class="p">,</span> <span class="s2">&quot;params&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">,</span> <span class="s2">&quot;estimated_result&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">estimate_result</span><span class="p">}</span></div>
+
+
+<div class="viewcode-block" id="AbstractEstimator.set_params">
+<a class="viewcode-back" href="../../src.estimators.html#estimators.abstract_estimator.AbstractEstimator.set_params">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">set_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">algorithm_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">params</span><span class="p">:</span> <span class="nb">dict</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Self</span><span class="p">:</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">algorithm_name</span> <span class="o">=</span> <span class="n">algorithm_name</span>
+        <span class="k">if</span> <span class="n">params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="n">params</span>
+        <span class="k">return</span> <span class="bp">self</span></div>
+
+
+<div class="viewcode-block" id="AbstractEstimator.get_available_algorithms">
+<a class="viewcode-back" href="../../src.estimators.html#estimators.abstract_estimator.AbstractEstimator.get_available_algorithms">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">get_available_algorithms</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Get all algorithms that can be used for current estimator class&quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="p">[</span><span class="n">key</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_registry</span><span class="o">.</span><span class="n">register_of_names</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> <span class="k">if</span> <span class="n">key</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">_purpose</span><span class="p">]</span></div>
+
+
+<div class="viewcode-block" id="AbstractEstimator.estimate">
+<a class="viewcode-back" href="../../src.estimators.html#estimators.abstract_estimator.AbstractEstimator.estimate">[docs]</a>
+    <span class="k">def</span><span class="w"> </span><span class="nf">estimate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sample</span><span class="p">:</span> <span class="n">_typing</span><span class="o">.</span><span class="n">ArrayLike</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">EstimateResult</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Applies an algorithm to the given sample</span>
+
+<span class="sd">        Args:</span>
+<span class="sd">            sample: sample of the analysed distribution</span>
+
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="bp">cls</span> <span class="o">=</span> <span class="kc">None</span>
+        <span class="k">if</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">algorithm_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_purpose</span><span class="p">)</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_registry</span><span class="o">.</span><span class="n">register_of_names</span><span class="p">:</span>
+            <span class="bp">cls</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_registry</span><span class="o">.</span><span class="n">dispatch</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">algorithm_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_purpose</span><span class="p">)(</span><span class="n">sample</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">)</span>
+        <span class="k">if</span> <span class="bp">cls</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;This algorithm does not exist&quot;</span><span class="p">)</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">estimate_result</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">algorithm</span><span class="p">(</span><span class="n">sample</span><span class="p">)</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">estimate_result</span></div>
+</div>
+
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2025, kira.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>