diff --git a/README.md b/README.md index 271e59f..a29f05c 100644 --- a/README.md +++ b/README.md @@ -3,23 +3,19 @@ This is the official implementation of the paper "Revisiting Deep Learning Models for Tabular Data". - - **Links** -:scroll: [arXiv](https://arxiv.org/abs/2106.11959) -:package: [**Python package**](./package/README.md#python-package) -:books: [RTDL (other projects on tabular deep learning)](https://github.com/yandex-research/rtdl) +:scroll: [arXiv](https://arxiv.org/abs/2106.11959) +
:package: **[Python package](./package/README.md#python-package) +(the recommended implementation)** +
:books: [RTDL (other projects on tabular deep learning)](https://github.com/yandex-research/rtdl) **This document** -[TL;DR](#tldr) -[Metrics & Hyperparameters](#how-to-explore-metrics-and-hyperparameters) -[How to reproduce the reported results](#how-to-reproduce-the-results) -[How to cite](#how-to-cite) +[TL;DR](#tldr) +
[Metrics & Hyperparameters](#how-to-explore-metrics-and-hyperparameters) +
[How to reproduce the reported results](#how-to-reproduce-the-results) +
[How to cite](#how-to-cite) # TL;DR diff --git a/package/README.md b/package/README.md index 75109c3..74eb613 100644 --- a/package/README.md +++ b/package/README.md @@ -1,11 +1,11 @@ # Python package > [!NOTE] -> See also: [RTDL](https://github.com/yandex-research/rtdl) -> (other projects on tabular deep learning). +> See also [RTDL](https://github.com/yandex-research/rtdl) +> -- other projects on tabular deep learning. -This package provides the officially recommended easy-to-use -implementation of the main things from the paper. +This package provides the officially recommended implementation +of the [paper](../README.md).
This package VS The original implementation diff --git a/package/example.ipynb b/package/example.ipynb index 6ba91c8..c3944c6 100644 --- a/package/example.ipynb +++ b/package/example.ipynb @@ -8,9 +8,17 @@ " \"Open\n", "\n", "\n", - "## Notes\n", + "---\n", "\n", - "**Hyperparameters are not tuned and may be suboptimal.**" + "**See also** [RTDL](https://github.com/yandex-research/rtdl)\n", + "-- **other projects on tabular deep learning**.\n", + "\n", + "---\n", + "\n", + "- This notebook provides a usage example of the\n", + " [rtdl_revisiting_models](https://github.com/yandex-research/rtdl-revisiting-models)\n", + " package.\n", + "- Hyperparameters are not tuned and may be suboptimal." ] }, {