Skip to content

Commit

Permalink
package | minor
Browse files Browse the repository at this point in the history
  • Loading branch information
Yura52 committed Dec 6, 2023
1 parent 0eef851 commit eea670a
Showing 1 changed file with 15 additions and 18 deletions.
33 changes: 15 additions & 18 deletions package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,21 @@ This package provides the officially recommended easy-to-use
implementation of the main things from the paper.

> [!NOTE]
>
> <details>
> <summary>This package VS The original implementation VS <code>rtdl</code></summary>
>
> First of all: **it is totally fine if you used prior official implementations**.
> However, in future, it is recommended to use this package.
>
> - The differences between this package and the original implementation
> (the code in `bin/` and `lib/`
> used to obtain numbers reported in the paper)
> are rare, minor and marked with the `# NOTE[DIFF]` comments
> in the source code of this package.
> - Any divergence from the original implementation without the `# NOTE[DIFF]` comment
> is considered to be a bug.
> - The [RTDL](https://github.com/yandex-research/rtdl) *package*
> (but not the *repository*!) is now deprecated.
>
> </details>
> See also: [RTDL](https://github.com/yandex-research/rtdl)
> (other projects on tabular deep learning).
<details>
<summary><i>This package VS The original implementation</i></summary>

- The differences between this package and the original implementation
(the code in `bin/` and `lib/`
used to obtain numbers reported in the paper)
are rare, minor and marked with the `# NOTE[DIFF]` comments
in the source code of this package.
- Any divergence from the original implementation without the `# NOTE[DIFF]` comment
is considered to be a bug.

</details>

---

Expand Down

0 comments on commit eea670a

Please sign in to comment.