Skip to content

Commit 64ad81e

Browse files
ChadLin9596ChadLin9596
committed
deploy: a54d0f9 
1 parent 016799c commit 64ad81e

19 files changed

+670
-349
lines changed

‎_sources/api.rst.txt‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎_sources/api/index.rst.txt‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
API Reference
2+
=============
3+
4+
Each submodule provides independent functionality and has its own
5+
optional dependencies.
6+
7+
.. toctree::
8+
:maxdepth: 1
9+
10+
utils_segmentation

‎_sources/api/utils_segmentation.rst.txt‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
py_utils.utils_segmentation
2+
===========================
3+
4+
.. automodule:: py_utils.utils_segmentation
5+
:no-members:
6+
7+
8+
-------------------------------------------
9+
Sliding Window Utilities
10+
-------------------------------------------
11+
12+
.. autofunction:: py_utils.utils_segmentation.compute_sliding_window_indices
13+
.. autofunction:: py_utils.utils_segmentation.sliding_window
14+
15+
16+
-------------------------------------------
17+
Segmented Reduction Utilities
18+
-------------------------------------------
19+
20+
.. autofunction:: py_utils.utils_segmentation.segmented_argmin
21+
.. autofunction:: py_utils.utils_segmentation.segmented_argmax
22+
.. autofunction:: py_utils.utils_segmentation.segmented_min
23+
.. autofunction:: py_utils.utils_segmentation.segmented_max
24+
25+
.. autofunction:: py_utils.utils_segmentation.segmented_count
26+
.. autofunction:: py_utils.utils_segmentation.segmented_sum
27+
.. autofunction:: py_utils.utils_segmentation.segmented_mean
28+
29+
.. autofunction:: py_utils.utils_segmentation.segmented_where
30+

‎_sources/dependency.rst.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Dependencies
2+
============
3+
4+
Below are module-level dependencies and links to full API details.
5+
6+
7+
Segmentation Utils
8+
------------------
9+
10+
:mod:`py_utils.utils_segmentation`
11+
12+
.. automodule:: py_utils.utils_segmentation
13+
:no-members:
14+
:no-undoc-members:
15+
:no-index:

‎_sources/generated/py_utils.utils_segmentation.rst.txt‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎_sources/index.rst.txt‎

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,29 @@
1-
.. py_utils documentation master file, created by
2-
sphinx-quickstart on Tue Nov 11 10:15:30 2025.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
1+
.. note::
2+
This project is under active development. Documentation may change frequently.
53

6-
py_utils Documentation
7-
======================
4+
`GitHub Repository`_.
85

9-
Add your content using ``reStructuredText`` syntax. See the
10-
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
11-
documentation for details.
126

13-
Check out the :doc:`usage` section for further information, including how to
14-
:ref:`install <installation>` the project.
7+
Getting Started
8+
===============
159

16-
.. note::
17-
This project is under active development. Documentation may change frequently.
10+
.. Check out the :doc:`usage` section for further information, including how to
11+
.. :ref:`install <installation>` the project.
1812
1913
.. toctree::
20-
:maxdepth: 2
21-
:caption: Contents:
14+
:maxdepth: 1
15+
16+
installation
17+
dependency
18+
api/index
19+
20+
Indices and Tables
21+
==================
22+
23+
* :ref:`genindex`
24+
* :ref:`modindex`
25+
* :ref:`search`
26+
2227

23-
usage
24-
api
28+
.. comment: list link used in the file above
29+
.. _GitHub Repository: https://github.com/ChadLin9596/python_utils

‎_sources/installation.rst.txt‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
Installation
2+
============
3+
4+
Install from GitHub
5+
-------------------
6+
7+
.. code-block:: bash
8+
9+
$ pip install git+https://github.com/ChadLin9596/python_utils.git
10+
11+
Custom Installation
12+
-------------------
13+
14+
``python_utils`` is modular. Each submodule has its own optional
15+
dependencies. You only need to install the dependencies for the parts you
16+
use.
17+
18+
Check the full module-level dependency list here:
19+
20+
:doc:`Dependency Overview <dependency>`
21+
22+
23+
Examples
24+
--------
25+
26+
** Install only segmentation utilities:**
27+
28+
.. code-block:: bash
29+
30+
pip install numpy_reduceat_ext numpy
31+
32+
then use
33+
34+
.. code-block:: python
35+
36+
import py_utils.utils_segmentation
37+
38+
39+
Notes
40+
-----
41+
42+
- Importing a submodule does **not** pull dependencies from other modules.
43+
- If you don’t import a heavy module (e.g., ``utils_torch``), its dependencies are never loaded.
44+
- Each module’s required dependencies are documented at the top of its API page and in the :doc:`dependency` page.

‎_sources/usage.rst.txt‎

Lines changed: 0 additions & 38 deletions
This file was deleted.

‎api/index.html‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
2+
<!DOCTYPE html>
3+
4+
<html xmlns="http://www.w3.org/1999/xhtml">
5+
<head>
6+
<meta charset="utf-8" />
7+
<title>API Reference &#8212; py_utils 0.1.0 documentation</title>
8+
<link rel="stylesheet" href="../_static/haiku.css" type="text/css" />
9+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
10+
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
11+
<script src="../_static/jquery.js"></script>
12+
<script src="../_static/underscore.js"></script>
13+
<script src="../_static/doctools.js"></script>
14+
<script src="../_static/language_data.js"></script>
15+
<link rel="index" title="Index" href="../genindex.html" />
16+
<link rel="search" title="Search" href="../search.html" />
17+
<link rel="next" title="py_utils.utils_segmentation" href="utils_segmentation.html" />
18+
<link rel="prev" title="Dependencies" href="../dependency.html" />
19+
</head><body>
20+
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
21+
<span>py_utils 0.1.0 documentation</span></a></h1>
22+
<h2 class="heading"><span>API Reference</span></h2>
23+
</div>
24+
<div class="topnav" role="navigation" aria-label="top navigation">
25+
26+
<p>
27+
«&#160;&#160;<a href="../dependency.html">Dependencies</a>
28+
&#160;&#160;::&#160;&#160;
29+
<a class="uplink" href="../index.html">Contents</a>
30+
&#160;&#160;::&#160;&#160;
31+
<a href="utils_segmentation.html">py_utils.utils_segmentation</a>&#160;&#160;»
32+
</p>
33+
34+
</div>
35+
<div class="content" role="main">
36+
37+
38+
<div class="section" id="api-reference">
39+
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline"></a></h1>
40+
<p>Each submodule provides independent functionality and has its own
41+
optional dependencies.</p>
42+
<div class="toctree-wrapper compound">
43+
<ul>
44+
<li class="toctree-l1"><a class="reference internal" href="utils_segmentation.html">py_utils.utils_segmentation</a></li>
45+
</ul>
46+
</div>
47+
</div>
48+
49+
50+
</div>
51+
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
52+
53+
<p>
54+
«&#160;&#160;<a href="../dependency.html">Dependencies</a>
55+
&#160;&#160;::&#160;&#160;
56+
<a class="uplink" href="../index.html">Contents</a>
57+
&#160;&#160;::&#160;&#160;
58+
<a href="utils_segmentation.html">py_utils.utils_segmentation</a>&#160;&#160;»
59+
</p>
60+
61+
</div>
62+
63+
<div class="footer" role="contentinfo">
64+
&#169; Copyright 2025, Chad Lin.
65+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
66+
</div>
67+
</body>
68+
</html>

0 commit comments

Comments
 (0)