deploy: 60a9dbd

Author: reidjohnson

_sources/getting_started/developers.rst.txt

@@ -5,15 +5,24 @@ Developer's Guide
 
 Development Dependencies
 ~~~~~~~~~~~~~~~~~~~~~~~~
+
 Building the package from source additionally requires the following dependencies:
 
 * cython (>=3.0a4)
 
 We also use pre-commit hooks to identify simple issues before submission.
 
-To install these dependencies, run::
+Setting Up Your Environment
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To contribute to the `quantile-forest` source code, start by forking and then cloning the repository (i.e. `git clone [email protected]:YourUsername/quantile-forest.git`).
+
+Once inside the repository, you can prepare a development environment. Using conda::
 
-  pip install cython pre-commit
+  conda create -n qf python=3.12
+  conda activate qf
+  conda install pre-commit
+  pre-commit install
 
 Development Installation
 ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -38,25 +47,25 @@ Test and Coverage
 
 Ensure that `pytest` and `pytest-cov` are installed::
 
-  $ pip install pytest pytest-cov
+  pip install pytest pytest-cov
 
 To test the code::
 
-  $ python -m pytest quantile_forest -v
+  python -m pytest quantile_forest -v
 
 To test the code and produce a coverage report::
 
-  $ python -m pytest quantile_forest --cov-report html --cov=quantile_forest
+  python -m pytest quantile_forest --cov-report html --cov=quantile_forest
 
 To test the documentation::
 
-  $ python -m pytest --doctest-glob="*.rst" --doctest-modules docs
+  python -m pytest --doctest-glob="*.rst" --doctest-modules docs
 
 Documentation
 ~~~~~~~~~~~~~
 
 To build the documentation, run::
 
-  $ pip install -r ./docs/sphinx_requirements.txt
-  $ mkdir -p ./docs/_images
-  $ sphinx-build -b html ./docs ./docs/_build
+  pip install -r ./docs/sphinx_requirements.txt
+  mkdir -p ./docs/_images
+  sphinx-build -b html ./docs ./docs/_build

_sources/getting_started/installation.rst.txt

@@ -8,9 +8,9 @@ Prerequisites
 
 The quantile-forest package requires the following dependencies:
 
-* python (>=3.8)
+* python (>=3.9)
 * numpy (>=1.23)
-* scikit-learn (>=1.0)
+* scikit-learn (>=1.5)
 * scipy (>=1.4)
 
 Installation

generated/quantile_forest.ExtraTreesQuantileRegressor.html

@@ -594,19 +594,13 @@ <h1>ExtraTreesQuantileRegressor<a class="headerlink" href="#extratreesquantilere
 </ul>
 </dd>
 </dl>
-<div class="versionadded">
-<p><span class="versionmodified added">New in scikit-learn version 1.4. </span></p>
-</div>
 </dd>
 </dl>
 </dd>
 <dt class="field-even">Attributes<span class="colon">:</span></dt>
 <dd class="field-even"><dl>
 <dt><strong>estimator_</strong><span class="classifier"><a class="reference external" href="https://scikit-learn.org/stable/modules/generated/sklearn.tree.ExtraTreeRegressor.html#sklearn.tree.ExtraTreeRegressor" title="(in scikit-learn v1.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExtraTreeRegressor</span></code></a></span></dt><dd><p>The child estimator template used to create the collection of fitted
 sub-estimators.</p>
-<div class="versionadded">
-<p><span class="versionmodified added">New in scikit-learn version 1.2:  </span><code class="docutils literal notranslate"><span class="pre">base_estimator_</span></code> was renamed to <code class="docutils literal notranslate"><span class="pre">estimator_</span></code>.</p>
-</div>
 </dd>
 <dt><strong>estimators_</strong><span class="classifier">list of DecisionTreeRegressor</span></dt><dd><p>The collection of fitted sub-estimators.</p>
 </dd>

generated/quantile_forest.RandomForestQuantileRegressor.html

@@ -592,19 +592,13 @@ <h1>RandomForestQuantileRegressor<a class="headerlink" href="#randomforestquanti
 </ul>
 </dd>
 </dl>
-<div class="versionadded">
-<p><span class="versionmodified added">New in scikit-learn version 1.4. </span></p>
-</div>
 </dd>
 </dl>
 </dd>
 <dt class="field-even">Attributes<span class="colon">:</span></dt>
 <dd class="field-even"><dl>
 <dt><strong>estimator_</strong><span class="classifier"><a class="reference external" href="https://scikit-learn.org/stable/modules/generated/sklearn.tree.DecisionTreeRegressor.html#sklearn.tree.DecisionTreeRegressor" title="(in scikit-learn v1.5)"><code class="xref py py-class docutils literal notranslate"><span class="pre">DecisionTreeRegressor</span></code></a></span></dt><dd><p>The child estimator template used to create the collection of fitted
 sub-estimators.</p>
-<div class="versionadded">
-<p><span class="versionmodified added">New in scikit-learn version 1.2:  </span><code class="docutils literal notranslate"><span class="pre">base_estimator_</span></code> was renamed to <code class="docutils literal notranslate"><span class="pre">estimator_</span></code>.</p>
-</div>
 </dd>
 <dt><strong>estimators_</strong><span class="classifier">list of DecisionTreeRegressor</span></dt><dd><p>The collection of fitted sub-estimators.</p>
 </dd>

getting_started/developers.html

@@ -435,8 +435,15 @@ <h2>Development Dependencies<a class="headerlink" href="#development-dependencie
 <li><p>cython (&gt;=3.0a4)</p></li>
 </ul>
 <p>We also use pre-commit hooks to identify simple issues before submission.</p>
-<p>To install these dependencies, run:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">cython</span> <span class="n">pre</span><span class="o">-</span><span class="n">commit</span>
+</section>
+<section id="setting-up-your-environment">
+<h2>Setting Up Your Environment<a class="headerlink" href="#setting-up-your-environment" title="Link to this heading">#</a></h2>
+<p>To contribute to the <code class="docutils literal notranslate"><span class="pre">quantile-forest</span></code> source code, start by forking and then cloning the repository (i.e. <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">git&#64;github.com:YourUsername/quantile-forest.git</span></code>).</p>
+<p>Once inside the repository, you can prepare a development environment. Using conda:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">create</span> <span class="o">-</span><span class="n">n</span> <span class="n">qf</span> <span class="n">python</span><span class="o">=</span><span class="mf">3.12</span>
+<span class="n">conda</span> <span class="n">activate</span> <span class="n">qf</span>
+<span class="n">conda</span> <span class="n">install</span> <span class="n">pre</span><span class="o">-</span><span class="n">commit</span>
+<span class="n">pre</span><span class="o">-</span><span class="n">commit</span> <span class="n">install</span>
 </pre></div>
 </div>
 </section>
@@ -460,28 +467,28 @@ <h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to
 <section id="test-and-coverage">
 <h2>Test and Coverage<a class="headerlink" href="#test-and-coverage" title="Link to this heading">#</a></h2>
 <p>Ensure that <code class="docutils literal notranslate"><span class="pre">pytest</span></code> and <code class="docutils literal notranslate"><span class="pre">pytest-cov</span></code> are installed:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pip install pytest pytest-cov
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">pytest</span> <span class="n">pytest</span><span class="o">-</span><span class="n">cov</span>
 </pre></div>
 </div>
 <p>To test the code:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ python -m pytest quantile_forest -v
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">pytest</span> <span class="n">quantile_forest</span> <span class="o">-</span><span class="n">v</span>
 </pre></div>
 </div>
 <p>To test the code and produce a coverage report:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ python -m pytest quantile_forest --cov-report html --cov=quantile_forest
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">pytest</span> <span class="n">quantile_forest</span> <span class="o">--</span><span class="n">cov</span><span class="o">-</span><span class="n">report</span> <span class="n">html</span> <span class="o">--</span><span class="n">cov</span><span class="o">=</span><span class="n">quantile_forest</span>
 </pre></div>
 </div>
 <p>To test the documentation:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ python -m pytest --doctest-glob=&quot;*.rst&quot; --doctest-modules docs
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">pytest</span> <span class="o">--</span><span class="n">doctest</span><span class="o">-</span><span class="n">glob</span><span class="o">=</span><span class="s2">&quot;*.rst&quot;</span> <span class="o">--</span><span class="n">doctest</span><span class="o">-</span><span class="n">modules</span> <span class="n">docs</span>
 </pre></div>
 </div>
 </section>
 <section id="documentation">
 <h2>Documentation<a class="headerlink" href="#documentation" title="Link to this heading">#</a></h2>
 <p>To build the documentation, run:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pip install -r ./docs/sphinx_requirements.txt
-$ mkdir -p ./docs/_images
-$ sphinx-build -b html ./docs ./docs/_build
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">r</span> <span class="o">./</span><span class="n">docs</span><span class="o">/</span><span class="n">sphinx_requirements</span><span class="o">.</span><span class="n">txt</span>
+<span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="o">./</span><span class="n">docs</span><span class="o">/</span><span class="n">_images</span>
+<span class="n">sphinx</span><span class="o">-</span><span class="n">build</span> <span class="o">-</span><span class="n">b</span> <span class="n">html</span> <span class="o">./</span><span class="n">docs</span> <span class="o">./</span><span class="n">docs</span><span class="o">/</span><span class="n">_build</span>
 </pre></div>
 </div>
 </section>
@@ -534,6 +541,7 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Link to this
   <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#development-dependencies">Development Dependencies</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setting-up-your-environment">Setting Up Your Environment</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#development-installation">Development Installation</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#troubleshooting">Troubleshooting</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#test-and-coverage">Test and Coverage</a></li>

getting_started/installation.html

@@ -429,9 +429,9 @@
 <h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Link to this heading">#</a></h2>
 <p>The quantile-forest package requires the following dependencies:</p>
 <ul class="simple">
-<li><p>python (&gt;=3.8)</p></li>
+<li><p>python (&gt;=3.9)</p></li>
 <li><p>numpy (&gt;=1.23)</p></li>
-<li><p>scikit-learn (&gt;=1.0)</p></li>
+<li><p>scikit-learn (&gt;=1.5)</p></li>
 <li><p>scipy (&gt;=1.4)</p></li>
 </ul>
 </section>