rehaidib commited on
Commit
003c85f
·
verified ·
1 Parent(s): 4cf661f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -6
README.md CHANGED
@@ -26,7 +26,7 @@ It merges three data sources:
26
 
27
  1. **Lizard Cyclomatic Analysis**: provides complexity, NLOC, and basic function metadata.
28
  2. **AST Extracted Features**: includes detailed abstract syntax tree information such as token counts, parameters, variable extraction, and function bodies.
29
- 3. **Lexical Features**: captures lexical and structural features of each function (e.g., class structure, modifiers, incoming/outgoing calls, and statement types).
30
 
31
  The resulting **Dataset** represents each Python function as a unified row combining complexity metrics, lexical information, and AST structure — enabling advanced research in:
32
  - Code comprehension
@@ -79,6 +79,7 @@ Each row corresponds to **one Python function** identified across open-source re
79
  | `function_num_lines` | Number of lines of function (lexical) |
80
  | `outgoing_function_count` / `outgoing_function_names` | Number and names of functions called inside this function |
81
  | `incoming_function_count` / `incoming_function_names` | Number and names of functions calling this function |
 
82
 
83
  ---
84
 
@@ -86,9 +87,9 @@ Each row corresponds to **one Python function** identified across open-source re
86
 
87
  - Static analysis performed on public Python repositories cloned from [GitHub](https://github.com) that apply the following characteristics (python language projects, commits > 500, and contributors > 10).
88
  - Function-level analysis uses:
89
- - [`lizard`](https://github.com/terryyin/lizard) for cyclomatic complexity.
90
- - Python AST parsing for structural features.
91
- - Custom lexical parser for lexical metadata and call graphs.
92
 
93
  ---
94
 
@@ -97,8 +98,9 @@ Each row corresponds to **one Python function** identified across open-source re
97
  ### Collection
98
  1. Clone open-source Python repositories.
99
  2. Run Lizard static analysis to generate base metrics.
100
- 3. Parse source files to extract AST and lexical features.
101
- 4. Merge the three sources
 
102
 
103
  ---
104
 
 
26
 
27
  1. **Lizard Cyclomatic Analysis**: provides complexity, NLOC, and basic function metadata.
28
  2. **AST Extracted Features**: includes detailed abstract syntax tree information such as token counts, parameters, variable extraction, and function bodies.
29
+ 3. **Lexical Features**: captures lexical and structural features of each function (e.g., class structure, modifiers, incoming/outgoing calls, and statement types) and presents it in natural language.
30
 
31
  The resulting **Dataset** represents each Python function as a unified row combining complexity metrics, lexical information, and AST structure — enabling advanced research in:
32
  - Code comprehension
 
79
  | `function_num_lines` | Number of lines of function (lexical) |
80
  | `outgoing_function_count` / `outgoing_function_names` | Number and names of functions called inside this function |
81
  | `incoming_function_count` / `incoming_function_names` | Number and names of functions calling this function |
82
+ | `lexical_representation` | Present the code features as natural language. |
83
 
84
  ---
85
 
 
87
 
88
  - Static analysis performed on public Python repositories cloned from [GitHub](https://github.com) that apply the following characteristics (python language projects, commits > 500, and contributors > 10).
89
  - Function-level analysis uses:
90
+ - [`lizard`](https://pypi.org/project/lizard/) for cyclomatic complexity.
91
+ - Python AST (https://docs.python.org/3/library/ast.html) parsing for structural features.
92
+ - Lexical presentation driven by structural and 15 extract code features.
93
 
94
  ---
95
 
 
98
  ### Collection
99
  1. Clone open-source Python repositories.
100
  2. Run Lizard static analysis to generate base metrics.
101
+ 3. Parse source files to extract AST and 15 code features.
102
+ 4. Convert code features to natural language using rule-based code.
103
+ 5. Merge the three sources
104
 
105
  ---
106