Skip to content

Commit a6a984b

Browse files
authored
Merge pull request #1 from Microsoft/readme-edits
Update README.md
2 parents ec2e4e9 + 9f0b732 commit a6a984b

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ modeling of programs, composed of three major components:
77
[Learning to Represent Programs with Graphs](https://openreview.net/forum?id=BJOFETxR-).
88
More precisely, it implements that paper apart from the speculative
99
dataflow component ("draw dataflow edges as if a variable would be used
10-
in this place") and an alias analysis to filter equivalent variables.
10+
in this place") and the alias analysis to filter equivalent variables.
1111
* A TensorFlow model for program graphs, following ICLR'18 paper
1212
[Learning to Represent Programs with Graphs](https://openreview.net/forum?id=BJOFETxR-).
1313
This is a refactoring/partial rewrite of the original model, incorporating
@@ -52,15 +52,15 @@ paper), please use this bibtex entry:
5252
The released code provides two components:
5353
* Data Extraction: A C# project extracting graphs and expressions from a corpus
5454
of C# projects. The sources for this are in `DataExtraction/`.
55-
* Modelling: A python project learning model of expressions, conditionally on
55+
* Modelling: A Python project learning model of expressions, conditionally on
5656
the program context. The sources for this are in `Models/`.
5757

5858
Note that the code is a research prototype; the documentation is generally
5959
incomplete and code quality is varying.
6060

6161
## Data Extraction
6262
### Building the data extractor
63-
To build the data extraction, you need a .Net development environment (i.e.,
63+
To build the data extraction, you need a .NET development environment (i.e.,
6464
a working `dotnet` executable). Once this is set up, you can build the
6565
extractor as follows:
6666
```
@@ -93,7 +93,8 @@ consisting of a context graph and a target expression in tree form.
9393
`ExpressionDataExtractor.exe --help` provides some information on
9494
additional options.
9595

96-
*Note*: Building C# projects is often non-trivial (requiring libraries in the
96+
*Note*: Building C# projects is often non-trivial (requiring [NuGet](https://www.nuget.org/)
97+
and other libraries in the
9798
path, preparing the build by running helper scripts, etc.). Roughly, data
9899
extraction from a solution `Project.sln` will only succeed if running
99100
`MSBuild Project.sln` succeeds as well.
@@ -120,9 +121,9 @@ Data extraction is split into two projects:
120121

121122
## Models
122123
First, run `pip install -r requirements.txt` to download the needed
123-
dependencies.
124+
dependencies. Note that all code is written in Python 3.
124125

125-
As the preprocessing of graphs into tensorised form is relatively expensive,
126+
As the preprocessing of graphs into tensorised form is relatively computationally expensive,
126127
we use a preprocessing step to do this. This computes vocabularies, the
127128
grammar required to produce the observed expressions and so on, and then
128129
transforms node labels from string form into tensorised form, etc.:
@@ -304,4 +305,4 @@ provided by the bot. You will only need to do this once across all repos using o
304305

305306
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
306307
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
307-
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
308+
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

0 commit comments

Comments
 (0)