Skip to content

Commit 1f30e3e

Browse files
committed
use table for describing corpus structure in README.md
1 parent 3d25da4 commit 1f30e3e

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,17 +53,15 @@ on how well projects conform to the [MathComp conventions][math-comp-contrib].
5353
| [infotheo][infotheo] | 6c17242 | 81 | 42295 | LO | [GPL-3.0-only][gpl3] |
5454

5555
The structure of the corpus is as follows:
56-
```
57-
projects-standalone-8.10.yml
58-
The list of projects, alone with their URL, SHA, build command,
59-
installation command, etc.
60-
raw-files The source files and their machine-readable representations.
61-
lemmas The lemmas extracted from the corpus.
62-
lemmas-filtered The subset of lemmas with restriction on the maximum sizes of
63-
their elaborated terms, suitable for machine learning applications.
64-
definitions The definitions extracted from the corpus.
65-
data-indexes The data splitting used in the research paper.
66-
```
56+
57+
| File/directory | Contents |
58+
|:-------------------------------|:---------------------------------------------------------------------------------------|
59+
| `projects-standalone-8.10.yml` | List of projects, along with their URL, SHA, build command, installation command, etc. |
60+
| `raw-files` | Project source files and their machine-readable representations. |
61+
| `lemmas` | Lemmas extracted from the corpus. |
62+
| `lemmas-filtered` | Subset of lemmas obeying restrictions on the maximum sizes of their elaborated terms. |
63+
| `definitions` | Definitions extracted from the corpus. |
64+
| `data-indexes` | Data splitting used in the research paper. |
6765

6866
[finmap]: https://github.com/math-comp/finmap
6967
[fourcolor]: https://github.com/math-comp/fourcolor

0 commit comments

Comments
 (0)