saikatc commited on
Commit
99bb81c
1 Parent(s): 85a2a30

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -9
README.md CHANGED
@@ -20,7 +20,7 @@ This dataset is the Version 2.0 of [`microsoft/FStarDataSet`](https://huggingfac
20
 
21
 
22
  ## Primary-Objective
23
- This dataset's primary objective is to train and evaluate Proof-oriented Programming with AI (PoPAI, in short). Given a specification of a program and proof is F*,
24
  the objective of a AI model is to synthesize the implemantation (see [below](#usage) for details about the usage of this dataset, including the input and output).
25
 
26
  ## Data Format
@@ -32,28 +32,29 @@ Each of the examples in this dataset are organized as dictionaries with the foll
32
  "original_source_type": <str: actual source type, to be used for type checking>,
33
  "source_type": <str: modified source type, to be used to formulate prompt>,
34
  "source_definition": <str: target definition>,
35
- "source": <dict: contains metadata acout the source of this example, including project_name, git url, git sha, etc.>,
36
  "source_range": <dict: metadata containing start and end lines and columns of this definition in the source file>,
37
  "file_context": <str: extracted file context upto the point of current definition>,
38
  "dependencies": <dict: build dependencies for this file>,
39
- "opens_and_abbrevs": <list[dict]: List of opened modules and abbreviated modules in the file, necessry for evaluating.>,
40
- "vconfig": <dict: variour buils configuration for this definition>,
41
- "interleaved": <bool: whether this definition is interleaved with another>,
42
  "verbose_type": <str: the verbose type of this definition as resolved by the type checker>,
43
  "effect": <str: effect>,
44
  "effect_flags": <list[str]: any effect flags>,
45
- "mutual_with": <list: if this definition is mutually recursive with other, list of those names>,
46
  "ideal_premises": <list[str]: Other definitions that are used in the ground truth definition>,
47
  "proof_features": <list[str]>,
48
  "is_simple_lemma": <bool/null>,
49
- "is_div": <bool: if this definition is divergent>,
50
  "is_proof": <bool>,
51
  "is_simply_typed": <bool>,
52
  "is_type": <bool/null>,
53
  "partial_definition": <str>,
54
  "completed_definiton": <str>,
55
- "isa_cross_project_example": <bool: if this example belongs to cross-project evaluation set>
56
  }
 
57
  ```
58
 
59
  # Usage
@@ -90,7 +91,7 @@ Download the source code and the `helpers.zip` file from the release.
90
  The attached binaries in the evaluator (i.e., `fstar.exe` and `z3`) are built on
91
  **`Ubuntu 20.04.6 LTS (GNU/Linux 5.4.0-189-generic x86_64)`**, **`gcc (Ubuntu 9.4.0-1ubuntu1~20.04.2)`**, **`OCaml 4.12.0`**.
92
  If any of the binaries do not work properly, build F* from [this commit (10183ea187da8e8c426b799df6c825e24c0767d3)](https://github.com/FStarLang/FStar/commit/10183ea187da8e8c426b799df6c825e24c0767d3)
93
- from the [F* repository](https://github.com/FStarLang/FStar), using their [installation guide](https://github.com/FStarLang/FStar/blob/master/INSTALL.md).
94
 
95
  # Data Source
96
  In addition to the eight projects in `microsoft/FStarDataSet`, data from four more projects are included in this version.
 
20
 
21
 
22
  ## Primary-Objective
23
+ This dataset's primary objective is to train and evaluate Proof-oriented Programming with AI (PoPAI, in short). Given a specification of a program and proof in F*,
24
  the objective of a AI model is to synthesize the implemantation (see [below](#usage) for details about the usage of this dataset, including the input and output).
25
 
26
  ## Data Format
 
32
  "original_source_type": <str: actual source type, to be used for type checking>,
33
  "source_type": <str: modified source type, to be used to formulate prompt>,
34
  "source_definition": <str: target definition>,
35
+ "source": <dict: contains metadata about the source of this example, including project_name, git url, git sha, etc.>,
36
  "source_range": <dict: metadata containing start and end lines and columns of this definition in the source file>,
37
  "file_context": <str: extracted file context upto the point of current definition>,
38
  "dependencies": <dict: build dependencies for this file>,
39
+ "opens_and_abbrevs": <list[dict]: List of opened modules and abbreviated modules in the file, necessary for evaluation.>,
40
+ "vconfig": <dict: SMT solver flags for this definition>,
41
+ "interleaved": <bool: whether this definition is interleaved from the interface file>,
42
  "verbose_type": <str: the verbose type of this definition as resolved by the type checker>,
43
  "effect": <str: effect>,
44
  "effect_flags": <list[str]: any effect flags>,
45
+ "mutual_with": <list: if this definition is mutually recursive with another, list of those names>,
46
  "ideal_premises": <list[str]: Other definitions that are used in the ground truth definition>,
47
  "proof_features": <list[str]>,
48
  "is_simple_lemma": <bool/null>,
49
+ "is_div": <bool: if this definition has the divergent effect>,
50
  "is_proof": <bool>,
51
  "is_simply_typed": <bool>,
52
  "is_type": <bool/null>,
53
  "partial_definition": <str>,
54
  "completed_definiton": <str>,
55
+ "isa_cross_project_example": <bool: if this example belongs to the cross-project evaluation set>
56
  }
57
+
58
  ```
59
 
60
  # Usage
 
91
  The attached binaries in the evaluator (i.e., `fstar.exe` and `z3`) are built on
92
  **`Ubuntu 20.04.6 LTS (GNU/Linux 5.4.0-189-generic x86_64)`**, **`gcc (Ubuntu 9.4.0-1ubuntu1~20.04.2)`**, **`OCaml 4.12.0`**.
93
  If any of the binaries do not work properly, build F* from [this commit (10183ea187da8e8c426b799df6c825e24c0767d3)](https://github.com/FStarLang/FStar/commit/10183ea187da8e8c426b799df6c825e24c0767d3)
94
+ from the [F* repository](https://github.com/FStarLang/FStar), using the [installation guide](https://github.com/FStarLang/FStar/blob/master/INSTALL.md).
95
 
96
  # Data Source
97
  In addition to the eight projects in `microsoft/FStarDataSet`, data from four more projects are included in this version.