julearn 0.3.6.dev42__tar.gz → 0.3.6.dev72__tar.gz

julearn-0.3.6.dev72/.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.dev42 → julearn-0.3.6.dev72}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: julearn
-Version: 0.3.6.dev42
+Version: 0.3.6.dev72
 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>
@@ -59,10 +59,12 @@ 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: xgboost
+Requires-Dist: xgboost<4.0.0,>=3.0.0; extra == "xgboost"
 Provides-Extra: docs
-Requires-Dist: julearn[optuna,skopt,sphinx,viz]; extra == "docs"
+Requires-Dist: julearn[optuna,skopt,sphinx,viz,xgboost]; extra == "docs"
 Provides-Extra: all
-Requires-Dist: julearn[optuna,skopt,viz]; extra == "all"
+Requires-Dist: julearn[optuna,skopt,viz,xgboost]; extra == "all"
 Dynamic: license-file
 
 # julearn

{julearn-0.3.6.dev42 → julearn-0.3.6.dev72}/docs/api/models.rst

@@ -19,6 +19,21 @@ Functions
     register_model
     reset_model_register
 
+Julearn custom models
+---------------------
+
+This is a list of models implemented by Julearn that are not simple wrappers
+around existing models in other libraries but rather variants of existing
+models or novel models.
+
+.. autosummary::
+   :nosignatures:
+   :toctree: generated/
+   :template: class.rst
+
+   xgb_cvearlystopping.XGBClassifierCVEarlyStopping
+   xgb_cvearlystopping.XGBRegressorCVEarlyStopping
+
 Dynamic Selection (DESLib)
 ==========================
 

{julearn-0.3.6.dev42 → julearn-0.3.6.dev72}/docs/available_pipeline_steps.rst

@@ -235,6 +235,20 @@ Ensemble
      - Y
      - Y
      - Y
+   * - ``xgb``
+     - XGBoost
+     - | :class:`~xgboost.XGBClassifier` and
+       | :class:`~xgboost.XGBRegressor`
+     - Y
+     - Y
+     - Y
+   * - ``xgb_cvearlystopping``
+     - XGBoost with Cross-Validation and Early Stopping
+     - | :class:`~julearn.models.xgb_cvearlystopping.XGBClassifierCVEarlyStopping` and
+       | :class:`~julearn.models.xgb_cvearlystopping.XGBRegressorCVEarlyStopping`
+     - Y
+     - Y
+     - Y
 
 Gaussian Processes
 ~~~~~~~~~~~~~~~~~~

{julearn-0.3.6.dev42 → julearn-0.3.6.dev72}/docs/conf.py

@@ -34,25 +34,11 @@ else:
     # process the loaded version information as you wish
     html_context = globals().get("html_context", {})
 
-    tag_revisions = [
-        rev
-        for rev in html_context["revisions"]
-        if rev.type_ == GitRefType.TAG and rev.name.startswith("v")
-    ]
-
-    latest = sorted(tag_revisions, key=lambda x: x.name)[
-        -1
-    ]  # latest by version
-
     if (
         html_context["current"].type_ == GitRefType.BRANCH
         and html_context["current"].name == "main"
     ):
-        major, minor, revision = latest.name.split("v")[-1].split(
-            "."
-        )  # get version number from tag name
-        next_dev_version = f"{major}.{minor}.{int(revision) + 1}.dev0"
-        release = next_dev_version
+        release = os.getenv("SETUPTOOLS_SCM_PRETEND_VERSION_FOR_JULEARN")
     else:
         release = html_context["current"].name
 
@@ -245,6 +231,7 @@ intersphinx_mapping = {
         None,
     ),
     "panel": ("https://panel.holoviz.org/", None),
+    "xgboost": ("https://xgboost.readthedocs.io/en/stable/", None),
 }
 
 # -- sphinx.ext.extlinks configuration ---------------------------------------

{julearn-0.3.6.dev42 → julearn-0.3.6.dev72}/docs/poly.py

@@ -18,7 +18,7 @@ from sphinx_polyversion.git import (
 )
 from sphinx_polyversion.pyvenv import Pip
 from sphinx_polyversion.setuptools_scm import SetuptoolsScmDriver
-from sphinx_polyversion.sphinx import SphinxBuilder
+from sphinx_polyversion.sphinx import Placeholder, SphinxBuilder
 
 
 #: Regex matching the branches to build docs for
@@ -69,9 +69,16 @@ out_dir = root / OUTPUT_DIR
 logger.info(f"Docs Source directory: {docs_src}")
 logger.info(f"Output directory: {out_dir}")
 
+
+# Command to ensure that the output directory is clean before building
+# (otherswise old files may remain if they were removed in the new version).
+pre_cmd = ["rm", "-r", Placeholder.OUTPUT_DIR]
+
 # Builders by version:
 BUILDER = {
-    None: SphinxBuilder(docs_src, args=SPHINX_ARGS.split()),  # default
+    None: SphinxBuilder(
+        docs_src, args=SPHINX_ARGS.split(), pre_cmd=pre_cmd
+    ),  # default
 }
 
 
@@ -311,6 +318,7 @@ if not BUILD_ALL:
     logger.info(f"Updated TAG_REGEX to: {TAG_REGEX}")
 
 
+#
 #: Data passed to templates
 def data(driver, rev, env):
     """Create a factory for data passed to templates.
@@ -362,7 +370,7 @@ SetuptoolsScmDriver(
     # static_dir=static_dir,
     data_factory=data,
     root_data_factory=root_data,
-).run()
+).run(sequential=SEQUENTIAL)
 
 if NO_PATCH:
     logger.info("NO_PATCH is set, skipping HTML patching.")
@@ -538,13 +546,11 @@ for built_dir in out_dir.iterdir():
     if built_dir.is_dir():
         if built_dir.name.startswith("v"):
             logger.info(f"Patching built version directory: {built_dir.name}")
-            current_version = next(
-                [
-                    tag
-                    for tag in built_versions["tags"]
-                    if tag.name == built_dir.name
-                ]
-            )
+            current_version = [  # noqa: RUF015
+                tag
+                for tag in built_versions["tags"]
+                if tag.name == built_dir.name
+            ][0]
             if int(built_dir.name.split(".")[1]) < 3:
                 # Old read_the_docs template
                 version_rtd_html = versions_rtd_template.render(

{julearn-0.3.6.dev42 → julearn-0.3.6.dev72}/julearn/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.3.6.dev42'
-__version_tuple__ = version_tuple = (0, 3, 6, 'dev42')
+__version__ = version = '0.3.6.dev72'
+__version_tuple__ = version_tuple = (0, 3, 6, 'dev72')
 
-__commit_id__ = commit_id = 'g9e05fcdb2'
+__commit_id__ = commit_id = 'gbc239b21b'

{julearn-0.3.6.dev42 → julearn-0.3.6.dev72}/julearn/models/available_models.py

@@ -46,6 +46,19 @@ from sklearn.naive_bayes import (
 )
 from sklearn.svm import SVC, SVR
 
+
+try:  # pragma: no cover
+    from xgboost import XGBClassifier, XGBRegressor
+
+    from .xgb_cvearlystopping import (
+        XGBClassifierCVEarlyStopping,
+        XGBRegressorCVEarlyStopping,
+    )
+
+    _has_xgboost = True
+except ImportError:
+    _has_xgboost = False
+
 from ..utils import logger, raise_error, warn_with_log
 from ..utils.logging import DelayedFmtMessage as __
 from ..utils.typing import ModelLike
@@ -137,6 +150,24 @@ _available_models: dict[str, dict[str, Any]] = {
     },
 }
 
+if _has_xgboost is True:
+    _available_models["xgb"] = {
+        "regression": XGBRegressor,
+        "classification": XGBClassifier,
+    }
+    _available_models["xgb_cvearlystopping"] = {
+        "regression": XGBRegressorCVEarlyStopping,
+        "classification": XGBClassifierCVEarlyStopping,
+    }
+    logger.info(
+        "XGBoost is available and has been added to the model registry."
+    )
+else:
+    logger.info(
+        "XGBoost is not available and has not been added to the model "
+        "registry. To use XGBoost models, please install the xgboost package."
+    )
+
 _available_models_reset = deepcopy(_available_models)