tabred 0.1.0__py3-none-any.whl

tabred/__init__.py

@@ -0,0 +1,10 @@
+from tabred.kaggle_utils import download_kaggle_data, download_preprocessed_data, require_competition_access
+from tabred.registry import get_preprocessed_files, get_raw_files
+
+__all__ = [
+    'download_kaggle_data',
+    'download_preprocessed_data',
+    'get_preprocessed_files',
+    'get_raw_files',
+    'require_competition_access',
+]

tabred/cli.py

@@ -0,0 +1,28 @@
+from pathlib import Path
+
+import cyclopts
+
+import tabred
+
+app = cyclopts.App(name='tabred')
+
+
+@app.command
+def download(
+    names: list[str] = ['all'],
+    *,
+    output_path: Path = Path('data'),
+    force: bool = False,
+    max_workers: int = 4,
+) -> None:
+    tabred.require_competition_access(names)
+    tabred.download_preprocessed_data(
+        names,
+        output_path,
+        force=force,
+        max_workers=max_workers,
+    )
+
+
+def main() -> None:
+    app()

tabred/kaggle_utils.py

@@ -0,0 +1,369 @@
+import hashlib
+import random
+import shutil
+import tarfile
+import tempfile
+from collections.abc import Iterable
+from concurrent.futures import FIRST_EXCEPTION, ThreadPoolExecutor, wait
+from pathlib import Path
+from threading import Event
+
+import kagglesdk
+import requests
+from kagglesdk.competitions.types.competition_api_service import (
+    ApiDownloadDataFilesRequest,
+    ApiListCompetitionsRequest,
+)
+from kagglesdk.competitions.types.competition_enums import CompetitionListTab
+from kagglesdk.datasets.types.dataset_api_service import ApiDownloadDatasetRequest
+from requests import exceptions as requests_exceptions
+from rich.console import Console
+from rich.panel import Panel
+from rich.progress import (
+    BarColumn,
+    DownloadColumn,
+    Progress,
+    TextColumn,
+    TransferSpeedColumn,
+)
+from rich.theme import Theme
+from urllib3 import exceptions as urllib3_exceptions
+
+from tabred.registry import KaggleRef, competition_slugs, dataset_names, get_preprocessed_files
+
+_CHUNK_SIZE = 1024 * 1024
+_DOWNLOAD_RETRIES = 5
+_DOWNLOAD_TIMEOUT = (5, 5)
+
+
+class DownloadFailed(Exception):
+    pass
+
+
+_DOWNLOAD_ERRORS = (
+    requests_exceptions.RequestException,
+    urllib3_exceptions.HTTPError,
+)
+
+console = Console(
+    highlight=False,
+    theme=Theme(
+        {
+            'bar.complete': 'dim green',
+            'bar.pulse': 'dim green',
+            'bar.back': 'white',
+        }
+    ),
+)
+
+
+def download_preprocessed_data(
+    names: Iterable[str],
+    dst: Path,
+    *,
+    force: bool = False,
+    max_workers: int = 4,
+) -> dict[str, Path]:
+    names = dataset_names(names)
+    dst.mkdir(parents=True, exist_ok=True)
+
+    todo = []
+    for name in names:
+        dataset_dir = dst / name
+        if dataset_dir.exists():
+            if force:
+                shutil.rmtree(dataset_dir)
+            else:
+                console.print(f'[bold]{name}[/] [yellow]already exists[/]')
+                continue
+        todo.append(name)
+
+    if not todo:
+        return {name: dst / name for name in names}
+
+    with tempfile.TemporaryDirectory(dir=dst) as tmp_dir_str:
+        tmp_dir = Path(tmp_dir_str)
+        archives = download_kaggle_data(
+            get_preprocessed_files(todo),
+            tmp_dir,
+            force=True,
+            max_workers=max_workers,
+        )
+        for name, archive in archives.items():
+            with tarfile.open(archive, 'r:gz') as tar:
+                tar.extractall(dst, filter='data')
+            if not (dst / name).is_dir():
+                raise DownloadFailed(f'{archive.name} did not extract to expected directory {name}')
+
+    console.print(f'[bold green]✓[/] unpacked requested data into `{dst.as_posix()}`')
+    return {name: dst / name for name in names}
+
+
+# This could have been a for loop with kaggle cli download,
+# but I wanted the download to be faster and have a nice ui, so...
+
+
+def download_kaggle_data(
+    data: dict[str, KaggleRef],
+    dst: Path,
+    *,
+    force: bool = False,
+    max_workers: int = 4,
+) -> dict[str, Path]:
+    if not data:
+        return {}
+
+    stop = Event()
+    workers = max(1, min(max_workers, len(data)))
+
+    with Progress(
+        TextColumn('{task.description}', style='dim'),
+        BarColumn(bar_width=30),
+        DownloadColumn(),
+        TransferSpeedColumn(),
+        console=console,
+        transient=True,
+        refresh_per_second=10,
+        expand=False,
+    ) as progress:
+        task_ids = {name: progress.add_task(ref.name, total=None) for name, ref in data.items()}
+
+        def run(name: str) -> Path:
+            return _download(data[name], dst / name, force, progress, task_ids[name], stop)
+
+        with ThreadPoolExecutor(max_workers=workers) as pool:
+            futures = {pool.submit(run, name): name for name in data}
+
+            try:
+                done, _pending = wait(futures, return_when=FIRST_EXCEPTION)
+            except KeyboardInterrupt:
+                # fast Ctrl-C cancelation niceties
+                stop.set()
+                console.print('[bold yellow]⊘[/] download interrupted')
+                raise SystemExit(130)
+
+            failed = next((f for f in done if f.exception() is not None), None)
+
+            if failed is not None:
+                # cancel other ongoing downloads and reraise the error
+                stop.set()
+                name = futures[failed]
+                progress.update(task_ids[name], description=f'{name} failed')
+                raise failed.exception()  # ty: ignore
+
+            return {futures[f]: f.result() for f in done}
+
+
+def require_competition_access(names: Iterable[str]) -> None:
+    slugs = competition_slugs(names)
+    if not slugs:
+        return
+
+    with console.status('Checking Kaggle competition access'):
+        with ThreadPoolExecutor(max_workers=min(8, len(slugs))) as pool:
+            access = dict(zip(slugs, pool.map(_entered_competition, slugs), strict=True))
+
+    missing = [slug for slug, ok in access.items() if not ok]
+    if not missing:
+        console.print('[bold green]✓[/] competition access verified')
+        return
+
+    links = '\n'.join(f'  • [steel_blue3]https://www.kaggle.com/competitions/{slug}[/]' for slug in missing)
+    console.print(
+        Panel(
+            '\nPlease accept the rules for the following Kaggle competitions '
+            'and then rerun the command\n'
+            '[dim]  Use the account corresponding to the ~/.kaggle/kaggle.json API key[/]'
+            '\n\n'
+            f'{links}',
+            title='[bold]Kaggle competition access required[/]',
+            border_style='black',
+        )
+    )
+    raise SystemExit(0)
+
+
+def _entered_competition(slug: str) -> bool:
+    request = ApiListCompetitionsRequest()
+    request.group = CompetitionListTab.COMPETITION_LIST_TAB_ENTERED
+    request.search = slug
+    request.page = 1
+    request.page_size = 5
+
+    with kagglesdk.KaggleClient() as client:
+        response = client.competitions.competition_api_client.list_competitions(request)
+
+    for competition in response.competitions or []:
+        for value in (competition.ref, competition.url):
+            if value and value.rstrip('/').split('/')[-1] == slug:
+                return True
+    return False
+
+
+# This is a "vendored" KaggleApi.download_file
+# it supports restarts, but also does write intermediate files into .part (no correptud)
+# plus it is integrated nicer with the Rich progress bar
+# original: https://github.com/Kaggle/kaggle-cli/blob/c97b6268ff1c6008207049144037cd556f957db3/src/kaggle/api/kaggle_api_extended.py#L4231
+
+
+def _download(
+    file: KaggleRef,
+    dst: Path,
+    force: bool,
+    progress: Progress,
+    task_id,
+    stop: Event,
+) -> Path:
+    dst.mkdir(parents=True, exist_ok=True)
+
+    out = dst / (file.local_name or Path(file.name).name)
+    part = out.with_name(out.name + '.part')
+
+    if force:
+        out.unlink(missing_ok=True)
+        part.unlink(missing_ok=True)
+
+    if out.exists():
+        _check_existing_file(out, file)
+        size = out.stat().st_size
+        progress.update(task_id, total=size, completed=size)
+        progress.remove_task(task_id)
+        return out
+
+    with kagglesdk.KaggleClient() as client:
+        if file.kind == 'dataset':
+            owner, slug = file.ref.split('/', 1)
+            request = ApiDownloadDatasetRequest()
+            request.owner_slug = owner
+            request.dataset_slug = slug
+            request.file_name = file.name
+            response = client.datasets.dataset_api_client.download_dataset(request)
+        elif file.kind == 'competition':
+            request = ApiDownloadDataFilesRequest()
+            request.competition_name = file.ref
+            response = client.competitions.competition_api_client.download_data_files(request)
+        else:
+            raise DownloadFailed(f'Unknown Kaggle file kind: {file.kind}')
+
+        _stream_download(
+            response,
+            out=out,
+            part=part,
+            file=file,
+            progress=progress,
+            task_id=task_id,
+            stop=stop,
+        )
+
+    progress.remove_task(task_id)
+    return out
+
+
+def _stream_download(
+    response,
+    *,
+    out: Path,
+    part: Path,
+    file: KaggleRef,
+    stop: Event,
+    progress: Progress,
+    task_id,
+) -> None:
+    content_length = response.headers.get('Content-Length')
+    total = int(content_length) if content_length else None
+    resumable = response.headers.get('Accept-Ranges') == 'bytes'
+
+    url = response.url
+    request = response.request
+    method = request.method if request is not None else 'GET'
+    headers = dict(request.headers) if request is not None else {}
+
+    response.close()
+
+    for attempt in range(1, _DOWNLOAD_RETRIES + 2):
+        if stop.is_set():
+            raise DownloadFailed('Interrupted')
+        start = part.stat().st_size if resumable and part.exists() else 0
+
+        if total is not None and start >= total:
+            break
+
+        request_headers = headers.copy()
+
+        if start:
+            request_headers['Range'] = f'bytes={start}-'
+
+        try:
+            with requests.request(
+                method,
+                url,
+                headers=request_headers,
+                stream=True,
+                timeout=_DOWNLOAD_TIMEOUT,
+            ) as response:
+                response.raise_for_status()
+                progress.update(task_id, total=total, completed=start)
+
+                mode = 'ab' if start else 'wb'
+                with part.open(mode) as f:
+                    for chunk in response.iter_content(_CHUNK_SIZE):
+                        if stop.is_set():
+                            raise DownloadFailed('Interrupted')
+
+                        if not chunk:
+                            continue
+
+                        f.write(chunk)
+                        progress.update(task_id, advance=len(chunk))
+            break
+
+        except _DOWNLOAD_ERRORS as error:
+            if attempt > _DOWNLOAD_RETRIES:
+                raise DownloadFailed(f'Could not download {out.name}. Try running the command again.') from error
+
+            if not resumable:
+                part.unlink(missing_ok=True)
+
+            if stop.wait(min(2**attempt + random.random(), 60)):
+                raise DownloadFailed('Download cancelled') from error
+
+    if total is not None and part.stat().st_size != total:
+        part.unlink(missing_ok=True)
+        raise DownloadFailed(
+            f'Downloaded size for {out.name} does not match Kaggle metadata. Try running the command again.'
+        )
+
+    if file.sha256 is not None:
+        actual = _sha256(part)
+        expected = file.sha256.lower()
+
+        if actual != expected:
+            part.unlink(missing_ok=True)
+            raise DownloadFailed(f'Checksum mismatch for {out.name}. Try running the command again.')
+
+    part.replace(out)
+    size = out.stat().st_size
+    progress.update(task_id, total=size, completed=size)
+
+
+def _check_existing_file(path: Path, file: KaggleRef) -> None:
+    if file.sha256 is None:
+        return
+
+    actual = _sha256(path)
+    expected = file.sha256.lower()
+
+    if actual != expected:
+        raise DownloadFailed(
+            f'{path.name} already exists, but its checksum does not match. Run again with --force to replace it.'
+        )
+
+
+def _sha256(path: Path) -> str:
+    sha = hashlib.sha256()
+
+    with path.open('rb') as f:
+        for chunk in iter(lambda: f.read(_CHUNK_SIZE), b''):
+            sha.update(chunk)
+
+    return sha.hexdigest().lower()

tabred/registry.py

@@ -0,0 +1,118 @@
+from collections.abc import Iterable
+from dataclasses import dataclass
+from typing import Literal
+
+_TABRED_KAGGLE_DATASET = 'irubachev/tabred'
+
+KaggleKind = Literal['dataset', 'competition']
+
+
+@dataclass(frozen=True)
+class KaggleRef:
+    kind: KaggleKind
+    ref: str
+    name: str
+    sha256: str | None
+    local_name: str | None = None
+
+    @property
+    def slug(self):
+        return self.ref if self.kind == 'competition' else None
+
+
+@dataclass(frozen=True)
+class Dataset:
+    name: str
+
+    raw: KaggleRef
+    preprocessed: KaggleRef
+
+
+def dataset_names(names: Iterable[str]) -> list[str]:
+    names = list(names)
+    result = list(DATASETS) if names == ['all'] else names
+    unknown = sorted(set(result) - set(DATASETS))
+    if unknown:
+        raise SystemExit('Unknown dataset(s): ' + ', '.join(unknown) + '. Available datasets: ' + ', '.join(DATASETS))
+    return result
+
+
+def competition_slugs(names: Iterable[str]) -> list[str]:
+    return [ds.raw.slug for name in dataset_names(names) if (ds := DATASETS[name]).raw.kind == 'competition']
+
+
+def get_raw_files(names: Iterable[str]) -> dict[str, KaggleRef]:
+    return {name: DATASETS[name].raw for name in dataset_names(names)}
+
+
+def get_preprocessed_files(names: Iterable[str]) -> dict[str, KaggleRef]:
+    return {name: DATASETS[name].preprocessed for name in dataset_names(names)}
+
+
+def _preprocessed_ref(name: str) -> KaggleRef:
+    return KaggleRef(
+        'dataset',
+        _TABRED_KAGGLE_DATASET,
+        f'preprocessed/{name}.tabred',
+        _PREPROCESSED_SHA256[name],
+    )
+
+
+def _competition_dataset(name, slug):
+    return Dataset(
+        name=name,
+        raw=KaggleRef('competition', slug, f'{slug}.zip', None),
+        preprocessed=_preprocessed_ref(name),
+    )
+
+
+def _yandex_dataset(name, filename):
+    return Dataset(
+        name=name,
+        raw=KaggleRef(
+            'dataset',
+            _TABRED_KAGGLE_DATASET,
+            f'raw/{name}/{filename}',
+            _RAW_SHA256[name],
+            local_name=filename,
+        ),
+        preprocessed=_preprocessed_ref(name),
+    )
+
+
+_PREPROCESSED_SHA256 = {
+    'cooking-time': 'ff7fb7f5be7101019164ec190831766997c28b00aefb4b902050099948435d95',
+    'delivery-eta': '097b1272e45de3a723f66d7b0d5c0a397b53a773cd5a781b8f094bfb753d5362',
+    'ecom-offers': 'de7f96400b9006eab4bfa4318993506aa667c0508da32a5e00b912b2bc702bc9',
+    'homecredit-default': 'fdcdcfe9b67e9ac8fae0291ee0aa8b492e41c123f99c9d3cecae2b78602c7f30',
+    'homesite-insurance': '9c94a9ba8a2dc68221c97d45273076714ad308b5e556ac59fd52117e1ea17d75',
+    'maps-routing': 'bdf503d49f10af2594594feb8c2ad8f4d90725bf21f1fe3de238acf0cb9f2abf',
+    'sberbank-housing': 'a6a11bc09204a5d6d0015dfae504cd630186c813a87e384eaf8caf5b960eb334',
+    'weather': 'b5dfc96c4e33d3567b748f0cc2b12baa5ea28fac400147953a3cd1cb735697e5',
+}
+
+_RAW_SHA256 = {
+    'cooking-time': '330b0b811195e7a6b75a43a7bd0ab65b52c83967c8f24d4765ccd2584c3228b9',
+    'delivery-eta': '37dc8c9479821da3539d1c42f6d97afbc4bf8b1466604839edac834ceb9e1ef5',
+    'maps-routing': '225712c539cf18503347c2d88bf4e4e9f624f180e7156a0fc4fedb19c43775b2',
+    'weather': '1984681822f14d24fbb491a8935446f9a263f48a469564c038a856b8194195e8',
+}
+
+
+DATASETS = {
+    name: _yandex_dataset(name, filename)
+    for name, filename in [
+        ('cooking-time', 'cooking_time.parquet'),
+        ('delivery-eta', 'delivery_eta.parquet'),
+        ('maps-routing', 'maps_routing.parquet'),
+        ('weather', 'weather.parquet'),
+    ]
+} | {
+    name: _competition_dataset(name, slug)
+    for name, slug in [
+        ('sberbank-housing', 'sberbank-russian-housing-market'),
+        ('ecom-offers', 'acquire-valued-shoppers-challenge'),
+        ('homesite-insurance', 'homesite-quote-conversion'),
+        ('homecredit-default', 'home-credit-credit-risk-model-stability'),
+    ]
+}

tabred-0.1.0.dist-info/METADATA

@@ -0,0 +1,311 @@
+Metadata-Version: 2.3
+Name: tabred
+Version: 0.1.0
+Summary: TabReD: Benchmark of industry-grade tabular datasets
+Author: Ivan Rubachev
+License:                                  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 [yyyy] [name of copyright owner]
+         
+            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
+            limitations under the License.
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Dist: cyclopts>=4.18.0,<5
+Requires-Dist: kaggle>=2.2,<3
+Requires-Dist: kagglesdk>=0.1.30,<0.2
+Requires-Dist: requests>=2.34.2,<3
+Requires-Dist: rich>=15.0.0,<16
+Requires-Python: >=3.12, <4
+Project-URL: Code, https://github.com/yandex-research/tabred
+Project-URL: Documentation, https://github.com/yandex-research/tabred/tree/main/README.md
+Description-Content-Type: text/markdown
+
+# TabReD: Analyzing Pitfalls and Filling the Gaps in Tabular Deep Learning Benchmarks
+
+:scroll: [arXiv](https://arxiv.org/abs/2406.19380)
+&nbsp; :books: [Other tabular DL projects](https://github.com/yandex-research/rtdl)
+
+> [!NOTE]
+> **Download preprocessed TabReD datasets with one command**
+>
+> ```bash
+> uvx tabred download all
+> # or individual datasets with
+> uvx tabred download cooking-time weather
+> ```
+>
+> *You need a Kaggle account and an API token at `~/.kaggle/kaggle.json` for this to work.*
+
+TabReD is a collection of eight industry-grade tabular datasets designed to evaluate machine learning methods under more realistic conditions: temporal distribution shift, rich feature sets from feature engineering pipelines, closer aligned with some real world applications of tabular machine learning.
+
+<p align="center">
+  <img src="assets/about_tabred.png" alt="TabReD overview" width="75%">
+</p>
+
+## Datasets
+
+| Dataset            | Features | Task           | Instances Used | Instances Available | Source                                                                                     |
+| ------------------ | -------- | -------------- | -------------- | ------------------- | ------------------------------------------------------------------------------------------ |
+| Homesite Insurance | 299      | Classification | 260,753        | -                   | [Competition](https://www.kaggle.com/competitions/homesite-quote-conversion)               |
+| Ecom Offers        | 119      | Classification | 160,057        | -                   | [Competition](https://www.kaggle.com/c/acquire-valued-shoppers-challenge)                  |
+| Homecredit Default | 696      | Classification | 381,664        | 1,526,659           | [Competition](https://www.kaggle.com/competitions/home-credit-credit-risk-model-stability) |
+| Sberbank Housing   | 392      | Regression     | 28,321         | -                   | [Competition](https://www.kaggle.com/competitions/sberbank-russian-housing-market)         |
+| Cooking Time       | 192      | Regression     | 319,986        | 12,799,642          | [Dataset](https://www.kaggle.com/datasets/irubachev/tabred)                                |
+| Delivery ETA       | 223      | Regression     | 416,451        | 17,044,043          | [Dataset](https://www.kaggle.com/datasets/irubachev/tabred)                                |
+| Maps Routing       | 986      | Regression     | 340,981        | 13,639,272          | [Dataset](https://www.kaggle.com/datasets/irubachev/tabred)                                |
+| Weather            | 103      | Regression     | 423,795        | 16,951,828          | [Dataset](https://www.kaggle.com/datasets/irubachev/tabred)                                |
+## Preprocessed data format
+
+The downloader unpacks each dataset into its own directory:
+
+```
+data/<dataset>/
+├── info.json
+├── x_num.npy
+├── x_cat.npy          # when present
+├── x_bin.npy          # when present
+├── x_meta.npy
+├── y.npy
+└── splits/
+    ├── default/
+    │   ├── train.npy
+    │   ├── val.npy
+    │   └── test.npy
+    ├── random-{0,1,2}/
+    │   ├── train.npy
+    │   ├── val.npy
+    │   └── test.npy
+    └── sliding-window-{0,1,2}/
+        ├── train.npy
+        ├── val.npy
+        └── test.npy
+```
+
+The `x_*.npy` files contain feature matrices, `y.npy` contains targets, and
+`info.json` contains task metadata. Split files contain row indices into these
+arrays. The `default` split is the main split from the TabReD paper; the random
+and sliding-window splits are provided for split-strategy studies.
+
+## Repository structure
+
+- `src/tabred`: downloader package and CLI.
+- `paper`: code for reproducing the paper
+
+## Rebuilding datasets from raw sources
+
+Most users should use the preprocessed downloader above. The preprocessing pipeline is kept in this repository for reproducibility and maintenance, but it is not the recommended way to obtain the benchmark data.
+
+> The cleaned-up dataset preparation scripts will be published in a few days (@puhsu 10.07.26). For now consult the previous commits and the preprocessing folder there.
+
+## Citation
+
+If you use TabReD, please cite:
+
+```bibtex
+@inproceedings{
+ rubachev2025tabred,
+ title={TabReD: Analyzing Pitfalls and Filling the Gaps in Tabular Deep Learning Benchmarks},
+ author={Ivan Rubachev and Nikolay Kartashev and Yury Gorishniy and Artem Babenko},
+ booktitle={The Thirteenth International Conference on Learning Representations},
+ year={2025},
+ url={https://openreview.net/forum?id=L14sqcrUC3}
+}
+```

tabred-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+tabred/__init__.py,sha256=uiqOx0t61xYN-bftWVdrIEksKzfdOGSnPrMwdoLGEbg,337
+tabred/cli.py,sha256=9towaUPQitI_jbYZXSiwKmXywkGIXy8juQ9rDSTUHnI,472
+tabred/kaggle_utils.py,sha256=ojELISvbeTbm1USOm4L_VW_tYux7XUMi8RhC-IyBgpY,11452
+tabred/registry.py,sha256=S8WIl9MCTOoOTmN7qxo22ulgWNJvOJyTZpoOVbmbI7k,3805
+tabred-0.1.0.dist-info/WHEEL,sha256=CoDSoyhtC_eO_tlxRYzsTraPv1fPJRXFx91k6ISeAvA,81
+tabred-0.1.0.dist-info/entry_points.txt,sha256=RIdrG5fdLLh_H_JDLmjY1P7nJ-OD8Mr2TyzZDwIwieI,44
+tabred-0.1.0.dist-info/METADATA,sha256=y5jXCLMIm2FYfkJ6rEjR4_MfKSlGvTjeLcmKsGpt9-E,18581
+tabred-0.1.0.dist-info/RECORD,,

tabred-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.11.28
+Root-Is-Purelib: true
+Tag: py3-none-any

tabred-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+tabred = tabred.cli:main
+