Skip to content

Commit

Permalink
minor presentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
Yura52 committed Dec 7, 2023
1 parent 1d2d0bf commit de4e514
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 18 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,19 @@
This is the official implementation of the paper
"Revisiting Deep Learning Models for Tabular Data".

<!--
NOTE: some of the following lines has two spaces in the end
which translates to line breaks in Markdown.
-->

**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)
<br> :package: **[Python package](./package/README.md#python-package)
(the recommended implementation)**
<br> :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)
<br> [Metrics & Hyperparameters](#how-to-explore-metrics-and-hyperparameters)
<br> [How to reproduce the reported results](#how-to-reproduce-the-results)
<br> [How to cite](#how-to-cite)

# TL;DR

Expand Down
8 changes: 4 additions & 4 deletions package/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Python package <!-- omit in toc -->

> [!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).

<details>
<summary><i>This package VS The original implementation</i></summary>
Expand Down
12 changes: 10 additions & 2 deletions package/example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,17 @@
" <img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/>\n",
"</a>\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."
]
},
{
Expand Down

0 comments on commit de4e514

Please sign in to comment.