relarena-core 0.0.1__tar.gz

relarena_core-0.0.1/LICENSE

@@ -0,0 +1,200 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 PriorLabs GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and

relarena_core-0.0.1/NOTICE

@@ -0,0 +1,16 @@
+RelArena Core
+Copyright 2026 PriorLabs GmbH
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file.
+
+The shared Deep Feature Synthesis and tabular-foundation-model fitting recipe
+is a method adaptation of RDBLearn, licensed under Apache-2.0:
+Copyright (c) HKU Shanghai X-Lab
+https://github.com/HKUSHXLab/rdblearn
+
+The non-stratified train downsampling in src/relarena_core/tfm.py is the closest
+adaptation. The implementation is original code; no RDBLearn source files are
+copied into this distribution.
+
+Datasets and model weights are not distributed with this package. Dependencies,
+downloaded datasets and inference backends retain their own upstream terms.

relarena_core-0.0.1/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: relarena-core
+Version: 0.0.1
+Summary: Shared contracts, temporal validation and predictive queries for relational models.
+Author: Prior Labs
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: relbench==2.1.2
+Requires-Dist: numpy>=1.24
+Requires-Dist: pandas>=2.3.3,<3.0
+Requires-Dist: scikit-learn>=1.3
+Requires-Dist: configspace>=1.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: jsonschema>=4.0
+Requires-Dist: duckdb>=1.2.2
+Requires-Dist: fastdfs>=1.1 ; extra == 'dfs'
+Requires-Dist: setuptools<82 ; extra == 'dfs'
+Requires-Python: >=3.11, <3.13
+Provides-Extra: dfs
+Description-Content-Type: text/markdown
+
+# RelArena Core
+
+Shared model contracts, temporal validation, caching and predictive queries for
+relational models. This distribution is developed in the RelArena monorepo.
+
+```bash
+pip install relarena-core
+```
+
+DFS preprocessing is available through `relarena-core[dfs]`. Model packages
+provide their own inference backends.

relarena_core-0.0.1/README.md

@@ -0,0 +1,11 @@
+# RelArena Core
+
+Shared model contracts, temporal validation, caching and predictive queries for
+relational models. This distribution is developed in the RelArena monorepo.
+
+```bash
+pip install relarena-core
+```
+
+DFS preprocessing is available through `relarena-core[dfs]`. Model packages
+provide their own inference backends.

relarena_core-0.0.1/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["uv_build>=0.11.15"]
+build-backend = "uv_build"
+
+[project]
+name = "relarena-core"
+version = "0.0.1"
+description = "Shared contracts, temporal validation and predictive queries for relational models."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = [
+    "LICENSE",
+    "NOTICE",
+]
+requires-python = ">=3.11,<3.13"
+dependencies = [
+    "relbench==2.1.2",
+    "numpy>=1.24",
+    "pandas>=2.3.3,<3.0",
+    "scikit-learn>=1.3",
+    "configspace>=1.0",
+    "pyyaml>=6.0",
+    "jsonschema>=4.0",
+    "duckdb>=1.2.2",
+]
+
+[[project.authors]]
+name = "Prior Labs"
+
+[project.optional-dependencies]
+dfs = [
+    "fastdfs>=1.1",
+    "setuptools<82",
+]

relarena_core-0.0.1/pyproject.toml.orig

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["uv_build>=0.11.15"]
+build-backend = "uv_build"
+
+[project]
+name = "relarena-core"
+version = "0.0.1"
+description = "Shared contracts, temporal validation and predictive queries for relational models."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+authors = [{ name = "Prior Labs" }]
+requires-python = ">=3.11,<3.13"
+dependencies = [
+    "relbench==2.1.2",
+    "numpy>=1.24",
+    "pandas>=2.3.3,<3.0",
+    "scikit-learn>=1.3",
+    "configspace>=1.0",
+    "pyyaml>=6.0",
+    "jsonschema>=4.0",
+    "duckdb>=1.2.2",
+]
+
+[project.optional-dependencies]
+dfs = ["fastdfs>=1.1", "setuptools<82"]

relarena_core-0.0.1/src/relarena_core/__init__.py

@@ -0,0 +1,41 @@
+"""Shared contracts and runtime for relational prediction."""
+
+from relarena_core.cache import CacheConfig, CacheMiss, cache_key, cached_artifact
+from relarena_core.dataset import InnerSplit, OuterSplit, Split, TaskSource
+from relarena_core.discovery import discover_models
+from relarena_core.identity import RunIdentity
+from relarena_core.model import RelArenaModel
+from relarena_core.registry import (
+    MethodRegistry,
+    ModelRegistry,
+    register_model,
+    register_system,
+    registry,
+)
+from relarena_core.results import SystemResult, TrialResult
+from relarena_core.system import RelArenaSystem
+from relarena_core.tuner import tune
+
+__version__ = "0.0.1"
+__all__ = [
+    "CacheConfig",
+    "CacheMiss",
+    "cache_key",
+    "cached_artifact",
+    "TaskSource",
+    "Split",
+    "InnerSplit",
+    "OuterSplit",
+    "discover_models",
+    "RunIdentity",
+    "RelArenaModel",
+    "RelArenaSystem",
+    "MethodRegistry",
+    "ModelRegistry",
+    "register_model",
+    "register_system",
+    "registry",
+    "TrialResult",
+    "SystemResult",
+    "tune",
+]

relarena_core-0.0.1/src/relarena_core/cache.py

@@ -0,0 +1,224 @@
+"""Optional, experimental helpers for caller-owned local cache artifacts.
+
+This module provides only cache configuration and safe filesystem mechanics. It
+does not know what an artifact represents, how its key is constructed, or how it
+is serialized. Each preprocessing module owns those decisions and supplies
+`load`, `build`, and optional `validate` callbacks to `cached_artifact`.
+
+Using this API is not required: a model may implement caching independently or
+avoid persistent caching altogether. Cache warming remains separate from a timed
+RelArena experiment. Regardless of implementation, benchmark caches should have
+public, reproducible, and leakage-safe generation code; see
+`docs/adding-a-model.md` for the contributor policy and reference implementations.
+
+A `CacheConfig` contains one resolved local cache root and a miss policy:
+
+* `raise`: load an existing artifact; raise `CacheMiss` when absent.
+* `fill`: load an existing artifact, or build and atomically publish it.
+* `compute`: build privately without reading or writing the persistent store.
+
+When no cache directory is configured, artifacts are also built in private
+temporary scratch, regardless of the miss policy. Thus `raise` only guards
+misses in a configured store.
+
+Artifact keys are opaque, safe relative POSIX paths beneath the cache root.
+Artifacts may be files or directories. On a fill miss, construction happens at
+a unique staging path; the completed and validated artifact is then published
+atomically. Concurrent builders cannot expose partial artifacts. Cache hits are
+read-only and create no locks, metadata, or temporary files.
+
+Callers are responsible for:
+
+* constructing keys from the artifact's actual dependencies;
+* versioning preprocessing algorithms;
+* serialization, loading, building, and semantic validation;
+* returning fully materialized values that do not depend on temporary paths.
+
+Environment variables are resolved once by `resolve_cache_config` at an
+entrypoint. Models and preprocessing code should receive the resulting immutable
+`CacheConfig` explicitly rather than consulting the environment themselves.
+"""
+
+from __future__ import annotations
+
+import errno
+import os
+import re
+import shutil
+import tempfile
+import uuid
+import warnings
+from collections.abc import Callable
+from dataclasses import dataclass
+from pathlib import Path, PurePosixPath
+from typing import Literal, TypeVar
+
+CACHE_DIR_ENV = "RELARENA_CACHE_DIR"
+DISABLE_CACHE_ENV = "RELARENA_DISABLE_CACHE"
+LEGACY_DISABLE_CACHE_ENV = "RELARENA_DISABLE_FEATURE_CACHE"
+
+OnMiss = Literal["raise", "fill", "compute"]
+Storage = Literal["file", "directory"]
+T = TypeVar("T")
+
+
+class CacheMiss(RuntimeError):
+    """A required artifact is absent from a configured cache."""
+
+
+@dataclass(frozen=True)
+class CacheConfig:
+    """Resolved cache directory and behavior for an absent artifact."""
+
+    directory: Path | None
+    on_miss: OnMiss
+
+    def __post_init__(self) -> None:
+        """Reject policies outside the intentionally small public set."""
+        if self.on_miss not in ("raise", "fill", "compute"):
+            raise ValueError(f"invalid cache miss policy: {self.on_miss!r}")
+
+
+def parse_local_cache_dir(value: str | Path) -> Path:
+    """Expand a local cache path and reject URI-like locations."""
+    raw = str(value)
+    if not raw:
+        raise ValueError("cache directory cannot be empty")
+    scheme = re.match(r"^([A-Za-z][A-Za-z0-9+.-]*):(?:/{1,2})", raw)
+    if scheme is not None and len(scheme.group(1)) > 1:
+        raise ValueError(f"cache directory must be a local path, not {raw!r}")
+    return Path(raw).expanduser()
+
+
+def resolve_cache_config(
+    cache_dir: str | Path | None, *, on_miss: OnMiss
+) -> CacheConfig:
+    """Resolve explicit path, environment fallback, and the disable switch once."""
+    value = cache_dir
+    if value is None:
+        value = os.environ.get(CACHE_DIR_ENV) or None
+    directory = None if value is None else parse_local_cache_dir(value)
+    if os.environ.get(LEGACY_DISABLE_CACHE_ENV):
+        warnings.warn(
+            f"{LEGACY_DISABLE_CACHE_ENV} is deprecated; use {DISABLE_CACHE_ENV}",
+            FutureWarning,
+            stacklevel=2,
+        )
+        directory = None
+    if os.environ.get(DISABLE_CACHE_ENV):
+        directory = None
+    return CacheConfig(directory=directory, on_miss=on_miss)
+
+
+def cache_key(*segments: str) -> PurePosixPath:
+    """Join validated path segments into a canonical relative cache key."""
+    if not segments:
+        raise ValueError("cache key needs at least one segment")
+    for segment in segments:
+        if not segment or segment in (".", ".."):
+            raise ValueError(f"invalid cache-key segment: {segment!r}")
+        if "/" in segment or "\\" in segment:
+            raise ValueError(f"cache-key segment contains a separator: {segment!r}")
+    return PurePosixPath(*segments)
+
+
+def _key_parts(key: str | PurePosixPath) -> tuple[str, ...]:
+    raw = str(key)
+    if not raw or raw.startswith("/") or "\\" in raw:
+        raise ValueError(f"cache key must be a safe relative POSIX path: {raw!r}")
+    parts = tuple(raw.split("/"))
+    if any(not part or part in (".", "..") for part in parts):
+        raise ValueError(f"cache key must be a safe relative POSIX path: {raw!r}")
+    return parts
+
+
+def _destination(root: Path, parts: tuple[str, ...]) -> Path:
+    resolved_root = root.resolve()
+    destination = root.joinpath(*parts)
+    if not destination.resolve().is_relative_to(resolved_root):
+        raise ValueError("cache key escapes the configured cache directory")
+    return destination
+
+
+def _qualifies(path: Path, storage: Storage) -> bool:
+    return path.is_file() if storage == "file" else path.is_dir()
+
+
+def _require_shape(path: Path, storage: Storage) -> None:
+    if not _qualifies(path, storage):
+        raise RuntimeError(f"cache builder did not create {storage} artifact at {path}")
+
+
+def _discard(path: Path) -> None:
+    if path.is_dir() and not path.is_symlink():
+        shutil.rmtree(path, ignore_errors=True)
+    else:
+        path.unlink(missing_ok=True)
+
+
+def _build_in_scratch(
+    parts: tuple[str, ...],
+    storage: Storage,
+    build: Callable[[Path], T],
+    validate: Callable[[T], None] | None,
+) -> T:
+    with tempfile.TemporaryDirectory(prefix="relarena-cache-") as scratch:
+        path = Path(scratch).joinpath(*parts)
+        path.parent.mkdir(parents=True, exist_ok=True)
+        value = build(path)
+        _require_shape(path, storage)
+        if validate is not None:
+            validate(value)
+        return value
+
+
+def cached_artifact(
+    cache: CacheConfig,
+    key: str | PurePosixPath,
+    *,
+    storage: Storage,
+    load: Callable[[Path], T],
+    build: Callable[[Path], T],
+    validate: Callable[[T], None] | None = None,
+    warm_hint: str | None = None,
+) -> T:
+    """Load, build, or reject one opaque file or directory artifact."""
+    if storage not in ("file", "directory"):
+        raise ValueError(f"invalid cache storage shape: {storage!r}")
+    parts = _key_parts(key)
+    if cache.directory is None or cache.on_miss == "compute":
+        return _build_in_scratch(parts, storage, build, validate)
+
+    destination = _destination(cache.directory, parts)
+    if _qualifies(destination, storage):
+        value = load(destination)
+        if validate is not None:
+            validate(value)
+        return value
+
+    if cache.on_miss == "raise":
+        hint = "" if warm_hint is None else f" {warm_hint}"
+        raise CacheMiss(
+            f"cache miss for {str(key)!r} in {cache.directory}.{hint}".rstrip()
+        )
+
+    destination.parent.mkdir(parents=True, exist_ok=True)
+    staging = destination.with_name(f".{destination.name}.tmp-{uuid.uuid4().hex}")
+    try:
+        value = build(staging)
+        _require_shape(staging, storage)
+        if validate is not None:
+            validate(value)
+        if storage == "file":
+            os.replace(staging, destination)
+        else:
+            try:
+                staging.rename(destination)
+            except OSError as exc:
+                if exc.errno not in (errno.EEXIST, errno.ENOTEMPTY) or not _qualifies(
+                    destination, storage
+                ):
+                    raise
+        return value
+    finally:
+        _discard(staging)