julearn 0.3.6.dev33__tar.gz → 0.3.6.dev47__tar.gz

{julearn-0.3.6.dev33 → julearn-0.3.6.dev47}/.github/workflows/ci.yml

@@ -27,16 +27,23 @@ jobs:
 
     steps:
     - uses: actions/checkout@v6
+
     - uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+
     - name: Install Python dependencies
       run: |
-        python -m pip install --upgrade pip setuptools wheel
-        python -m pip install tox tox-gh-actions
+        uv sync --locked --extra dev
+        uv pip install tox-gh-actions
+
     - name: Test with tox
       run: |
-        tox
+        uv run tox
+
     - uses: codecov/codecov-action@v6
       with:
         token: ${{ secrets.CODECOV_TOKEN }}

julearn-0.3.6.dev47/.github/workflows/docs-preview.yml

@@ -0,0 +1,48 @@
+name: Build and preview docs
+
+on:
+  push:
+    branches-ignore:
+      - "main"
+    tags-ignore:
+      - v*
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
+
+concurrency: preview-${{ github.ref }}
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v6
+        if: github.event.action != 'closed' # We don't need the build if we know the preview will be removed
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Install uv
+        if: github.event.action != 'closed' # We don't need the build if we know the preview will be removed
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+
+      - name: Install Python dependencies
+        if: github.event.action != 'closed' # We don't need the build if we know the preview will be removed
+        run: |
+          uv sync --locked --extra docs
+
+      - name: Test build docs
+        if: github.event.action != 'closed' # We don't need the build if we know the preview will be removed
+        run: |
+          uv run make -C docs/ local
+
+      - uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: docs/_build/dev
+        if: github.event_name == 'pull_request'

{julearn-0.3.6.dev33 → julearn-0.3.6.dev47}/.github/workflows/docs.yml

@@ -18,13 +18,19 @@ jobs:
       with:
         # require all of history to see all tagged versions' docs
         fetch-depth: 0
-    - uses: actions/setup-python@v6
+
+    - name: Set up Python
+      uses: actions/setup-python@v6
       with:
-        python-version: "3.x"
+        python-version-file: "pyproject.toml"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+
     - name: Install Python dependencies
       run: |
-        python -m pip install --upgrade pip setuptools wheel
-        python -m pip install -e .[docs,viz]
+        uv sync --locked --extra docs
+
     - name: Checkout gh-pages
       # As we already did a deploy of gh-pages above, it is guaranteed to be there
       # so check it out so we can selectively build docs below
@@ -32,10 +38,11 @@ jobs:
       with:
           ref: gh-pages
           path: docs/_build
+
     - name: Build docs
-      # Use the args we normally pass to sphinx-build, but run sphinx-multiversion
+      # Use the args we normally pass to sphinx-build, but run sphinx-polyversion
       run: |
-        make -C docs/ html
+        uv run make -C docs/ html
         touch docs/_build/.nojekyll
         cp docs/redirect.html docs/_build/index.html
     - uses: peaceiris/actions-gh-pages@v4

{julearn-0.3.6.dev33 → julearn-0.3.6.dev47}/.github/workflows/lint.yml

@@ -11,12 +11,14 @@ jobs:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
-          python-version: "3.x"
+          python-version-file: "pyproject.toml"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
       - name: Install Python dependencies
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install tox "ruff>=0.1.0"
+          uv sync --locked --extra dev
       - name: Run ruff
-        run: ruff check --output-format=github .
+        run: uv run ruff check --output-format=github .
       - name: Run codespell
-        run: tox -e codespell
+        run: uv run tox -e codespell

{julearn-0.3.6.dev33 → julearn-0.3.6.dev47}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: julearn
-Version: 0.3.6.dev33
+Version: 0.3.6.dev47
 Summary: Juelich Machine Learning Library
 Author-email: Fede Raimondo <f.raimondo@fz-juelich.de>, Sami Hamdan <s.hamdan@fz-juelich.de>
 Maintainer-email: Sami Hamdan <s.hamdan@fz-juelich.de>
@@ -34,23 +34,20 @@ Requires-Dist: looseversion==1.3.0; python_version >= "3.12"
 Provides-Extra: dev
 Requires-Dist: tox; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: towncrier; extra == "dev"
-Provides-Extra: docs
-Requires-Dist: furo>=2025.7.19; extra == "docs"
-Requires-Dist: numpydoc>=1.9.0; extra == "docs"
-Requires-Dist: optuna<5.0.0,>=4.0.0; extra == "docs"
-Requires-Dist: optuna-integration<5.0.0,>=4.0.0; extra == "docs"
-Requires-Dist: scikit-optimize<0.11.0,>=0.10.2; extra == "docs"
-Requires-Dist: seaborn<0.14.0,>=0.13.0; extra == "docs"
-Requires-Dist: setuptools-scm<11.0.0,>=10.0.0; extra == "docs"
-Requires-Dist: sphinx<10.0.0,>=8.2.3; extra == "docs"
-Requires-Dist: sphinx-copybutton>=0.5.2; extra == "docs"
-Requires-Dist: sphinx-gallery>=0.21.0; extra == "docs"
-Requires-Dist: sphinx-multiversion>=0.2.4; extra == "docs"
-Requires-Dist: sphinx-autodoc-typehints>=3.6.1; extra == "docs"
-Requires-Dist: sphinxcontrib-towncrier>=0.5.0a0; extra == "docs"
-Requires-Dist: towncrier>=25.8.0; extra == "docs"
+Requires-Dist: ruff<0.16.0,>=0.15.14; extra == "dev"
+Requires-Dist: towncrier>=25.8.0; extra == "dev"
+Provides-Extra: sphinx
+Requires-Dist: furo>=2025.7.19; extra == "sphinx"
+Requires-Dist: numpydoc>=1.9.0; extra == "sphinx"
+Requires-Dist: seaborn<0.14.0,>=0.13.0; extra == "sphinx"
+Requires-Dist: setuptools-scm<11.0.0,>=10.0.0; extra == "sphinx"
+Requires-Dist: sphinx<10.0.0,>=8.2.3; extra == "sphinx"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "sphinx"
+Requires-Dist: sphinx-gallery>=0.21.0; extra == "sphinx"
+Requires-Dist: sphinx-autodoc-typehints>=3.6.1; extra == "sphinx"
+Requires-Dist: sphinx-polyversion>=2.0.0; extra == "sphinx"
+Requires-Dist: sphinxcontrib-towncrier>=0.5.0a0; extra == "sphinx"
+Requires-Dist: towncrier>=25.8.0; extra == "sphinx"
 Provides-Extra: deslib
 Requires-Dist: deslib<0.4.0,>=0.3.5; extra == "deslib"
 Provides-Extra: viz
@@ -62,6 +59,8 @@ Requires-Dist: scikit-optimize<0.11.0,>=0.10.2; extra == "skopt"
 Provides-Extra: optuna
 Requires-Dist: optuna<5.0.0,>=4.0.0; extra == "optuna"
 Requires-Dist: optuna_integration<5.0.0,>=4.0.0; extra == "optuna"
+Provides-Extra: docs
+Requires-Dist: julearn[optuna,skopt,sphinx,viz]; extra == "docs"
 Provides-Extra: all
 Requires-Dist: julearn[optuna,skopt,viz]; extra == "all"
 Dynamic: license-file

julearn-0.3.6.dev47/docs/Makefile

@@ -0,0 +1,44 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXBUILD   = sphinx-build
+POLYBUILD     = sphinx-polyversion
+SOURCEDIR     = .
+BUILDDIR      ?= docs/_build
+SPHINXOPTS    ?= -E -v
+
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) --help "$(SOURCEDIR)" "$(BUILDDIR)" $(O)
+
+.PHONY: help Makefile clean cleanall local _build_local _html
+
+clean:
+	rm -rf $(BUILDDIR)/main
+	rm -rf auto_examples/
+	rm -rf api/generated/
+
+cleanall: clean
+	rm -rf $(BUILDDIR)/*
+
+# For local build
+local:
+	make _build_local; STATUS=$$?; exit $$STATUS
+
+_build_local:
+# 	$(POLYBUILD) ./poly.py -vv -l -o NO_PATCH=True -o OUTPUT_DIR="$(BUILDDIR)" -o SOURCE_DIR="$(SOURCEDIR)" -o TAG_REGEX="^$$"
+	$(SPHINXBUILD) "$(SOURCEDIR)" _build/dev $(SPHINXOPTS) $(O)
+
+html:
+	make _html; STATUS=$$?; exit $$STATUS
+
+_html:
+	$(POLYBUILD) ./poly.py -vv -o OUTPUT_DIR="$(BUILDDIR)" -o SOURCE_DIR="$(SOURCEDIR)"
+
+# 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) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

julearn-0.3.6.dev47/docs/_static/css/version_selector.css

@@ -0,0 +1,126 @@
+/* Furo-native version selector styles.
+   Uses furo CSS variables for full light/dark mode compatibility. */
+
+/* ── Sidebar version selector ────────────────────────────────────────────── */
+
+#version-selector {
+    border-top: 1px solid var(--color-sidebar-search-border);
+    padding-top: calc(var(--sidebar-item-spacing-vertical) / 2);
+}
+
+/* Remove default browser <details> marker */
+.version-details > summary {
+    list-style: none;
+}
+.version-details > summary::-webkit-details-marker {
+    display: none;
+}
+
+/* Summary row: looks like a furo sidebar caption */
+.version-summary {
+    cursor: pointer;
+    display: flex;
+    align-items: center;
+    gap: 0.4em;
+    padding: var(--sidebar-item-spacing-vertical)
+        var(--sidebar-item-spacing-horizontal);
+    font-size: var(--font-size--small--2);
+    font-weight: bold;
+    text-transform: uppercase;
+    letter-spacing: 1px;
+    color: var(--color-sidebar-caption-text);
+    user-select: none;
+}
+
+.version-summary:hover {
+    background-color: var(--color-sidebar-item-background--hover);
+}
+
+/* Chevron: points right when closed, down when open */
+.version-summary::after {
+    content: "▶";
+    font-size: 0.6em;
+    margin-left: auto;
+    transition: transform 0.15s ease;
+    color: var(--color-sidebar-caption-text);
+}
+
+.version-details[open] > .version-summary::after {
+    transform: rotate(90deg);
+}
+
+/* Colored status dot */
+.version-status-dot {
+    width: 8px;
+    height: 8px;
+    border-radius: 50%;
+    display: inline-block;
+    flex-shrink: 0;
+}
+
+.version-status-dot--latest { background-color: #28a745; }
+.version-status-dot--old    { background-color: #dc3545; }
+.version-status-dot--dev    { background-color: #e67e00; }
+
+/* Version list */
+.version-details ul {
+    margin: 0;
+    padding: 0;
+    list-style: none;
+}
+
+.version-details .toctree-l1 > a {
+    display: block;
+    padding: var(--sidebar-item-spacing-vertical)
+        var(--sidebar-item-spacing-horizontal);
+    color: var(--color-sidebar-link-text);
+    font-size: var(--sidebar-item-font-size);
+    text-decoration: none;
+}
+
+.version-details .toctree-l1 > a:hover {
+    background-color: var(--color-sidebar-item-background--hover);
+    color: var(--color-sidebar-link-text--top-level);
+}
+
+.version-details .toctree-l1.current > a {
+    background-color: var(--color-sidebar-item-background--current, transparent);
+    color: var(--color-sidebar-link-text--top-level);
+    font-weight: bold;
+}
+
+.version-details .toctree-l1 > a em {
+    font-size: 0.85em;
+    opacity: 0.75;
+}
+
+/* ── Version banner (toc-drawer / right sidebar) ─────────────────────────── */
+
+.version-banner {
+    padding: 0.6rem 0.75rem;
+    margin: 0.75rem 0.5rem 0;
+    border-radius: 0.2rem;
+    border-left: 3px solid;
+    font-size: var(--font-size--small--2);
+    line-height: 1.4;
+}
+
+.version-banner a {
+    font-weight: bold;
+    color: inherit;
+}
+
+.version-banner--latest {
+    background-color: rgba(40, 167, 69, 0.12);
+    border-left-color: #28a745;
+}
+
+.version-banner--old {
+    background-color: rgba(220, 53, 69, 0.12);
+    border-left-color: #dc3545;
+}
+
+.version-banner--dev {
+    background-color: rgba(230, 126, 0, 0.12);
+    border-left-color: #e67e00;
+}

julearn-0.3.6.dev47/docs/_templates/versions.html

@@ -0,0 +1,11 @@
+{# Furo-native version selector.
+   This placeholder is rendered by Sphinx at build time.
+   poly.py replaces it with the full multi-version list when patching. #}
+<div id="version-selector" class="sidebar-tree version-selector">
+  <details class="version-details" open>
+    <summary class="version-summary">
+      <span class="version-status-dot version-status-dot--latest"></span>
+      <span class="caption-text">Version</span>
+    </summary>
+  </details>
+</div>

{julearn-0.3.6.dev33 → julearn-0.3.6.dev47}/docs/conf.py

@@ -7,30 +7,47 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 import datetime
-from functools import partial
-from pathlib import Path
+import os
 import sys
-
-from setuptools_scm import get_version
-
 import types
+from pathlib import Path
 from typing import TypeAliasType
-from sphinx_autodoc_typehints import format_annotation
 
-# Check if sphinx-multiversion is installed
-use_multiversion = False
-try:
-    import sphinx_multiversion  # noqa: F401
+from setuptools_scm import get_version
+from sphinx_autodoc_typehints import format_annotation
+from sphinx_polyversion.api import load
+from sphinx_polyversion.git import GitRefType
 
-    use_multiversion = True
-except ImportError:
-    pass
 
+if os.getenv("POLYVERSION_DATA") is None:
+    # If POLYVERSION_DATA is not set, we are likely building the docs locally.
+    # In this case, we can use setuptools_scm to get the version information.
+    release = get_version(root=Path(__file__).parents[1].resolve())
+else:
+    load(globals())
+    # This adds the following to the global scope
+    # html_context = {
+    #     "revisions": [GitRef('main', ...), GitRef('v6.8.9', ...), ...],
+    #     "current": GitRef('v1.4.6', ...),
+    # }
+
+    # process the loaded version information as you wish
+    html_context = globals().get("html_context", {})
+
+    if (
+        html_context["current"].type_ == GitRefType.BRANCH
+        and html_context["current"].name == "main"
+    ):
+        release = os.getenv("SETUPTOOLS_SCM_PRETEND_VERSION_FOR_JULEARN")
+    else:
+        release = html_context["current"].name
+
+version = release
 
 # -- Path setup --------------------------------------------------------------
 
 PROJECT_ROOT_DIR = Path(__file__).parents[1].resolve()
-get_scm_version = partial(get_version, root=PROJECT_ROOT_DIR)
+# get_scm_version = partial(get_version, root=PROJECT_ROOT_DIR)
 
 # -- Project information -----------------------------------------------------
 
@@ -44,11 +61,6 @@ project = github_repo_name
 author = f"{project} Contributors"
 copyright = f"{datetime.date.today().year}, {author}"
 
-# The version along with dev tag
-release = get_scm_version(
-    version_scheme="guess-next-dev",
-    local_scheme="no-local-version",
-)
 
 # -- General configuration ---------------------------------------------------
 
@@ -72,12 +84,6 @@ extensions = [
     "sphinx_autodoc_typehints",  # automatically document type hints
 ]
 
-if use_multiversion:
-    print("using sphinx-multiversion for documentation")
-    extensions.append("sphinx_multiversion")
-else:
-    print("sphinx-multiversion not found, building documentation without it")
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = [
     "_templates",
@@ -111,9 +117,20 @@ nitpick_ignore_regex = [
     ("py:class", "sklearn.metrics._scorer.*"),
 ]
 
-to_ignore = ["array-like", "shape", "optional", "or", "the", "options",
-             "n_samples", "default=.*", "n_features", "n_outputs", "True",
-             "False"]
+to_ignore = [
+    "array-like",
+    "shape",
+    "optional",
+    "or",
+    "the",
+    "options",
+    "n_samples",
+    "default=.*",
+    "n_features",
+    "n_outputs",
+    "True",
+    "False",
+]
 
 for i in to_ignore:
     nitpick_ignore_regex.append(("py:class", i))
@@ -134,6 +151,7 @@ html_logo = "images/julearn_logo_it.png"
 # or fully qualified paths (eg. https://...)
 html_css_files = [
     "css/custom.css",
+    "css/version_selector.css",
 ]
 
 html_js_files = [
@@ -168,15 +186,15 @@ autodoc_type_aliases = {
     "ColumnTypes": "julearn.base.column_types.ColumnTypes",
     "Pipeline": "sklearn.pipeline.Pipeline",
     "RandomState": "numpy.random.RandomState",
-#     "ColumnTypesLike": "julearn.utils.typing.ColumnTypesLike",
-#     "DataLike": "julearn.utils.typing.DataLike",
-#     "ScorerLike": "julearn.utils.typing.ScorerLike",
-#     "EstimatorLike": "julearn.utils.typing.EstimatorLike",
-#     "ModelLike": "julearn.utils.typing.ModelLike",
-#     "TransformerLike": "julearn.utils.typing.TransformerLike",
-#     "JuModelLike": "julearn.utils.typing.JuModelLike",
-#     "JuTransformerLike": "julearn.utils.typing.JuTransformerLike",
-#     "CVLike": "julearn.utils.typing.CVLike",
+    #     "ColumnTypesLike": "julearn.utils.typing.ColumnTypesLike",
+    #     "DataLike": "julearn.utils.typing.DataLike",
+    #     "ScorerLike": "julearn.utils.typing.ScorerLike",
+    #     "EstimatorLike": "julearn.utils.typing.EstimatorLike",
+    #     "ModelLike": "julearn.utils.typing.ModelLike",
+    #     "TransformerLike": "julearn.utils.typing.TransformerLike",
+    #     "JuModelLike": "julearn.utils.typing.JuModelLike",
+    #     "JuTransformerLike": "julearn.utils.typing.JuTransformerLike",
+    #     "CVLike": "julearn.utils.typing.CVLike",
 }
 
 
@@ -288,12 +306,6 @@ sphinx_gallery_conf = {
     "download_all_examples": False,
 }
 
-# -- sphinx-multiversion configuration ---------------------------------------
-
-smv_rebuild_tags = False
-smv_tag_whitelist = r"^v\d+\.\d+.\d+$"
-smv_branch_whitelist = r"main"
-smv_released_pattern = r"^tags/v.*$"
 
 # -- sphinxcontrib-towncrier configuration -----------------------------------
 
@@ -301,7 +313,7 @@ towncrier_draft_autoversion_mode = "draft"
 towncrier_draft_include_empty = True
 towncrier_draft_working_directory = PROJECT_ROOT_DIR
 
-# -- sphinx_autodoc_typehints configuration ---------------------------------------
+# -- sphinx_autodoc_typehints configuration ----------------------------------
 always_use_bars_union = True
 simplify_optional_unions = True
 typehints_defaults = "comma"
@@ -315,9 +327,9 @@ typehints_document_rtype_none = False
 # instead of as a separate block
 typehints_use_rtype = False
 
+
 def _get_canonical_type_alias_name(annotation: TypeAliasType) -> str:
-    """
-    Get canonical public qualified name for a TypeAliasType.
+    """Get canonical public qualified name for a TypeAliasType.
 
     For types defined in private modules (e.g. ``numpy._typing.ArrayLike``),
     search ``sys.modules`` for a public re-export