Update README.md

README.md

@@ -1,3 +1,67 @@
----
-license: mit
----
+---
+language: 
+- "en"
+pretty_name: "MetaCoq Dataset"
+tags: 
+- "theorem-proving"
+- "formal-methods"
+- "metacoq"
+- "meta-programming"
+- "coq"
+license: "mit"
+task_categories:
+- "text-generation"
+- "feature-extraction"
+- "other"
+---
+
+# MetaCoq Dataset
+
+## Dataset Description
+The MetaCoq Dataset is derived from the MetaCoq repository, focusing on the formalization of Coq's meta-theory in the Coq proof assistant. This dataset processes .v files from the core theory directories to extract mathematical content in a structured format. This work builds upon the format established by Andreas Florath (@florath) in his Coq Facts, Propositions and Proofs dataset, providing a specialized view of the MetaCoq library with particular focus on meta-programming constructs.
+
+### Dataset Structure
+The dataset includes the following fields:
+- fact: The mathematical statement body without type prefixes
+- type: The statement type (Definition/Lemma/Theorem/etc., including MetaCoq-specific types like Quote Definition)
+- library: The originating library (common/template-coq/pcuic/etc.)
+- imports: The Require Import statements from the source file
+- filename: The source file path within MetaCoq
+- symbolic_name: The identifier of the mathematical object
+- index_level: Sequential index for the dataset
+
+### Example Row
+fact: "forall {elt elt' : term}, red1 elt elt' -> red elt elt'"
+type: "Lemma"
+library: "pcuic"
+imports: "From MetaCoq.PCUIC Require Import PCUICAst PCUICAstUtils PCUICInduction PCUICLiftSubst PCUICUnivSubst PCUICTyping PCUICReduction."
+filename: "pcuic/theories/PCUICRedTypeIrrelevance.v"
+symbolic_name: "red1_red"
+index_level: 42
+
+### Source Code
+The dataset was generated using a custom Python script that processes core MetaCoq libraries. The extraction focuses on mathematical content while preserving the structure and relationships between definitions, lemmas, and their source files. Special handling is implemented for MetaCoq-specific constructs like Quote Definition and MetaCoq Run, as well as proper preservation of full proofs and statements.
+
+### Coverage
+The dataset includes content from the following MetaCoq directories:
+- common/theories (Common utilities and definitions)
+- template-coq/theories (Template-Coq implementation)
+- pcuic/theories (Predicative Calculus of Inductive Constructions)
+- safechecker/theories (Safe type-checker implementation)
+- erasure/theories (Erasure translation)
+
+### Usage
+This dataset is designed for:
+- Meta-theoretical Research: Analyzing formal proofs and definitions in Coq's meta-theory
+- Machine Learning Applications: Training models for proof automation and tactic prediction
+- Meta-programming Studies: Understanding patterns in quote/unquote operations and template programming
+- Certified Programming: Studying certified meta-programming and proof checking
+- Educational Purposes: Providing structured examples of meta-theoretical formalizations
+
+### License
+This dataset is distributed under the MIT license, aligning with the license of the original MetaCoq repository.
+
+### Acknowledgments
+- Original repository: MetaCoq (https://github.com/MetaCoq/metacoq)
+- Inspiration: Hugging Face user Andreas Florath (@florath) and his comprehensive Coq dataset
+- Related datasets: UniMath Dataset and Coq-HoTT Dataset