Skip to content

Move the package into a workspace #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adrian-prior wants to merge 1 commit into from
Open

Move the package into a workspace #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,21 @@ jobs:
with:
enable-cache: true
- name: Install test dependencies
run: uv sync --locked --group dev --group cpu --extra leaderboard --extra plots --extra rt
run: uv sync --all-packages --locked --group dev --group cpu --extra leaderboard --extra plots --extra rt
- name: Verify test interpreter
env:
EXPECTED_PYTHON: ${{ matrix.python-version }}
run: |
uv run python -c 'import os, sys; actual = f"{sys.version_info.major}.{sys.version_info.minor}"; expected = os.environ["EXPECTED_PYTHON"]; assert actual == expected, f"Expected Python {expected}, got {actual}"'
uv run --no-sync python -c 'import os, sys; actual = f"{sys.version_info.major}.{sys.version_info.minor}"; expected = os.environ["EXPECTED_PYTHON"]; assert actual == expected, f"Expected Python {expected}, got {actual}"'
- name: Check formatting and lint
run: |
uv run ruff format --check .
uv run ruff check .
uv run --no-sync ruff format --check .
uv run --no-sync ruff check .
- name: Run tests
env:
OMP_NUM_THREADS: "1"
run: uv run pytest
run: uv run --no-sync pytest
- name: Build distributions
run: uv build
run: uv build --all-packages
- name: Verify required package data
run: python workflows/verify_distributions.py
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ macOS-only AutoGluon/LightGBM issue
locally on macOS, prefix with the env var:

```bash
OMP_NUM_THREADS=1 uv run pytest # otherwise: "Fatal Python error: Segmentation fault" in lightgbm
OMP_NUM_THREADS=1 uv run --all-packages pytest # otherwise: "Fatal Python error: Segmentation fault" in lightgbm
```

(There's no clean *permanent* local fix under `uv`: symlinking one `libomp` — e.g.
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ improvements, new model integrations, and reproducibility fixes are welcome.
RelArena requires Python 3.11 and uses [uv](https://docs.astral.sh/uv/):

```bash
uv sync --group dev --group cpu --extra leaderboard --extra plots
uv run pre-commit install
uv sync --all-packages --group dev --group cpu --extra leaderboard --extra plots
uv run --all-packages pre-commit install
```

On macOS, prefix test and CLI commands with `OMP_NUM_THREADS=1` to avoid the
Expand All @@ -18,10 +18,10 @@ known conflict between the OpenMP runtimes bundled by PyTorch and LightGBM.
Before opening a pull request, run:

```bash
uv run ruff format --check .
uv run ruff check .
OMP_NUM_THREADS=1 uv run pytest
uv build
uv run --all-packages ruff format --check .
uv run --all-packages ruff check .
OMP_NUM_THREADS=1 uv run --all-packages pytest
uv build --all-packages
```

For model integrations, follow [docs/adding-a-model.md](docs/adding-a-model.md).
Expand Down
32 changes: 16 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ preprocessing cost.
<summary><b>🧩 Add your own model</b> — the <code>fit</code> / <code>predict</code> contract plus a search space</summary>

We want the set of included baselines to be as representative as possible, so adding a method is
meant to be cheap. A model is a folder under `src/relarena/models/` implementing the
meant to be cheap. A model is a folder under `packages/relarena/src/relarena/models/` implementing the
`RelArenaModel` contract (`fit` and `predict`) with a `SearchSpace` registered via
`@register_model(search_space=...)`; an end-to-end procedure implements
`RelArenaSystem.run` and uses `@register_system`. The registry discovers the folder automatically.
Expand Down Expand Up @@ -220,7 +220,7 @@ predictions = PredictiveQuery(spec).fit("tabpfn-rel-client").predict()
Any registered RelArena-α method runs this way, hyperparameter tuning included. See
[docs/predictive-task.md](docs/predictive-task.md) for the task definition, SQL rules, split
semantics, and worked examples;
[`src/relarena/userdb/relbench_v1/`](src/relarena/userdb/relbench_v1) for example specifications
[`packages/relarena/src/relarena/userdb/relbench_v1/`](packages/relarena/src/relarena/userdb/relbench_v1) for example specifications
covering all 21 entity-level RelBench v1 tasks; and
[`examples/olist_seller_churn.py`](examples/olist_seller_churn.py) for the full path on a real
7-table Kaggle database. That example predicts seller churn, where held-out ROC AUC is 0.50 for
Expand All @@ -246,7 +246,7 @@ preprocessing and GPU-bound training have different hardware requirements. RelAr
permits methods to compute preprocessing artifacts once and cache them on disk before a run.

Caching is not required. RelArena provides an **optional, experimental** helper API in
[`relarena.cache`](src/relarena/cache.py) for local paths, miss policies, private scratch
[`relarena.cache`](packages/relarena/src/relarena/cache.py) for local paths, miss policies, private scratch
computation, and atomic publication. A method may ignore this API and implement caching
independently. The helper does not bring cache warming into a timed RelArena experiment;
preprocessing scripts still run separately, so their runtime is not currently included in the
Expand Down Expand Up @@ -289,7 +289,7 @@ those nodes. The workflow warms every RelBench v1 task:

```bash
RELARENA_CACHE_DIR=~/relarena-cache \
uv run --extra rdblearn python workflows/warm_feature_cache.py
uv run --all-packages --extra rdblearn python workflows/warm_feature_cache.py
```

It invokes `relarena.featurization.warm_cache` for both protocol splits and warms both
Expand Down Expand Up @@ -390,8 +390,8 @@ checkout for those.
```bash
git clone https://github.com/PriorLabs/relarena.git
cd relarena
uv sync # the dev group (pytest, ruff, ...) installs by default
OMP_NUM_THREADS=1 uv run pytest # the prefix is required on macOS; harmless elsewhere
uv sync --all-packages # the dev group (pytest, ruff, ...) installs by default
OMP_NUM_THREADS=1 uv run --all-packages pytest # the prefix is required on macOS; harmless elsewhere
```

Add `--group cpu` for the CPU-only torch build instead of the CUDA one, and
Expand All @@ -404,17 +404,17 @@ pinned by `uv.lock`).
<summary><b>🛠️ Developer setup</b> — everything, plus pre-commit</summary>

```bash
uv sync --group dev --group cpu --extra leaderboard --extra plots
uv run pre-commit install
uv sync --all-packages --group dev --group cpu --extra leaderboard --extra plots
uv run --all-packages pre-commit install
```

Before opening a pull request:

```bash
uv run ruff format --check .
uv run ruff check .
OMP_NUM_THREADS=1 uv run pytest
uv build
uv run --all-packages ruff format --check .
uv run --all-packages ruff check .
OMP_NUM_THREADS=1 uv run --all-packages pytest
uv build --all-packages
```

See [CONTRIBUTING.md](CONTRIBUTING.md) and, for agent-facing notes, [AGENTS.md](AGENTS.md).
Expand Down Expand Up @@ -453,7 +453,7 @@ currently supported by RelArena's RT integration, and a GPU is strongly recommen
fine-tuning runtimes.

```bash
uv sync --extra rt # from a source checkout
uv sync --all-packages --extra rt # from a source checkout
pip install "relarena[rt]" # from a release
```

Expand Down Expand Up @@ -563,8 +563,8 @@ pretrained on PluRel-generated synthetic data and fine-tuned on the given task w
sequential tuning regime. KurveRSC jointly selects a GraphReduce feature program and downstream
learner on the inner split, then freezes and replays that exact operation plan in its reporting
arm. Their protocols and configured values are documented in
[`models/rt/model.py`](src/relarena/models/rt/model.py) and
[`models/kurversc/model.py`](src/relarena/models/kurversc/model.py). Each produces one system row
[`models/rt/model.py`](packages/relarena/src/relarena/models/rt/model.py) and
[`models/kurversc/model.py`](packages/relarena/src/relarena/models/kurversc/model.py). Each produces one system row
with real test metrics and complete runtime, without a harness config or validation score.

Everything else per method lives at its source: install caveats in
Expand Down Expand Up @@ -606,7 +606,7 @@ from RDBLearn and improves on it in four ways:

```
relarena/
├── src/relarena/ # the package
├── packages/relarena/src/relarena/ # the package
│ ├── model.py # RelArenaModel, the contract every model implements
│ ├── search_space.py # SearchSpace, declarative HPO space (ConfigSpace or grid)
│ ├── registry.py # string-keyed model registry, binds model to search space
Expand Down
200 changes: 200 additions & 0 deletions packages/relarena/LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Loading