phanerozoic commited on
Commit
7b8c391
1 Parent(s): 0f0d8c4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +20 -31
README.md CHANGED
@@ -16,35 +16,35 @@ task_categories:
16
 
17
  # Coq-HoTT Dataset
18
 
19
- ## Dataset Description:
20
 
21
- The Coq-HoTT Dataset is derived from the Coq-HoTT repository, a formalization of Homotopy Type Theory in the Coq proof assistant. This dataset processes `.v` (Coq source files) and `.md` (Markdown documentation) files to extract structured information, including definitions, theorems, proofs, comments, and dependencies.
22
 
23
- This work was inspired in part by Hugging Face user Andreas Florath (@florath) and his dataset contributions for Coq-based facts, properties, and proofs.
24
 
25
- ### Dataset Structure:
26
 
27
  The dataset includes the following fields:
28
- - `filename`: The relative path of the file within the Coq-HoTT repository.
29
- - `title`: Extracted title or main comment from the file.
30
- - `imports`: List of Coq modules imported in the file.
31
- - `type`: The type of extracted content (e.g., `Definition`, `Lemma`, `Theorem`).
32
- - `name`: Identifier for the extracted entity.
33
- - `statement`: The formal statement or body of the definition/theorem.
34
- - `proof`: The associated proof script, if available.
35
- - `local_comments`: Comments related to the specific section or entity.
36
 
37
- ### Example rows:
38
 
39
- filename: "theories/Categories/Comma/InducedFunctors.v"
40
- type: "Definition"
41
- name: "comma_category_induced_functor"
42
- statement: "A function inducing a functor on comma categories"
43
- proof: "Proof omitted"
 
 
44
 
45
- ### Source Code:
46
 
47
- The dataset was generated using a custom Python script that traverses the Coq-HoTT repository to extract structured data. It leverages text parsing and regular expressions to clean and organize content. `.v` files were processed for mathematical content, while `.md` files were included to retain important documentation and context.
 
48
 
49
  ### Usage:
50
 
@@ -57,17 +57,6 @@ This dataset is designed for:
57
 
58
  This dataset is distributed under the BSD 2-clause licence, aligning with the license of the original Coq-HoTT repository.
59
 
60
- ### Citation:
61
-
62
- If you use this dataset in your research or application, please cite it as follows:
63
-
64
- @dataset{coq_hott_dataset,
65
- title = {Coq-HoTT Dataset},
66
- author = {Your Name},
67
- year = {2024},
68
- url = {https://huggingface.co/datasets/your_username/coq_hott_dataset},
69
- }
70
-
71
  ### Acknowledgments:
72
 
73
  - Original repository: Coq-HoTT (https://github.com/HoTT/Coq-HoTT)
 
16
 
17
  # Coq-HoTT Dataset
18
 
19
+ ## Dataset Description
20
 
21
+ The Coq-HoTT Dataset is derived from the Coq-HoTT repository, focusing on the formalization of Homotopy Type Theory in the Coq proof assistant. This dataset processes `.v` files from the theories directory to extract mathematical content in a structured format.
22
 
23
+ This work builds upon the format established by Andreas Florath (@florath) in his Coq Facts, Propositions and Proofs dataset.
24
 
25
+ ### Dataset Structure
26
 
27
  The dataset includes the following fields:
28
+ - `fact`: The complete mathematical statement, including type (Definition/Lemma/Theorem), name, and body
29
+ - `imports`: The Require Import statements from the source file
30
+ - `filename`: The source file name within the theories directory
31
+ - `symbolic_name`: The identifier of the mathematical object
32
+ - `__index_level_0__`: Sequential index for the dataset
 
 
 
33
 
34
+ ### Example Row
35
 
36
+ ```
37
+ fact: "Definition minimal(n : nat) : Type := forall m : nat, P m -> n <= m."
38
+ imports: "Require Import HoTT.Basics HoTT.Types. Require Import HoTT.Truncations.Core. Require Import HoTT.Spaces.Nat.Core."
39
+ filename: "BoundedSearch.v"
40
+ symbolic_name: "minimal"
41
+ __index_level_0__: 0
42
+ ```
43
 
44
+ ### Source Code
45
 
46
+ The dataset was generated using a custom Python script that processes the Coq-HoTT repository's theories directory, extracting mathematical content while preserving the structure and relationships between definitions, imports, and their source files.
47
+ ``` to clean and organize content. `.v` files were processed for mathematical content, while `.md` files were included to retain important documentation and context.
48
 
49
  ### Usage:
50
 
 
57
 
58
  This dataset is distributed under the BSD 2-clause licence, aligning with the license of the original Coq-HoTT repository.
59
 
 
 
 
 
 
 
 
 
 
 
 
60
  ### Acknowledgments:
61
 
62
  - Original repository: Coq-HoTT (https://github.com/HoTT/Coq-HoTT)